<?php echo "<"."?xml version='1.0' encoding='ISO-8859-1'?".">\n";
define('idDiGIR_help','$Id: DiGIR_help.php,v 1.2 2003/05/06 20:33:23 vieglais Exp $');
if (defined('idDIGIR_VERSION_REQUEST'))
    return;
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<title>DiGIR phpProvider Help</title>
</head>
<body>
<h1>DiGIR phpProvider Help</h1>
<p>$Id: DiGIR_help.php,v 1.2 2003/05/06 20:33:23 vieglais Exp $</p>
<p>Exposes a DiGIR (<a href="http://digir.sourceforge.net">Distributed Generic
Information Retrieval</a>) interface which allows programmatic access to underlying
information resources.</p>

<h3>General Information</h3>
<table border="1">
<tr><td>PHPversion</td><td><?php echo phpversion();?></td></tr>
<tr><td>HTTP service</td><td><?php echo $_SERVER['SERVER_SOFTWARE'];?></td></tr>
<tr><td>OS</td><td><?php echo PHP_OS;?></td></tr>
<tr><td>DiGIR version</td><td><?php echo DiGIRVERSION;?></td></tr>
<tr><td>DiGIR build#</td><td><?php echo DiGIRBuild;?></td></tr>
</table>

<h3>Parameters</h3>
<p>Operation parameters may be specified using HTTP POST or GET.  Where a parameter value is
specified in both GET and POST, the GET value takes precedence.</p>
<table border="1">
<tr><td>operation</td>
<td>("search" | "getContent") = search and return records<br />
    ("scan") = scan a column (enumerate unique values<br />
    ("getCapabilities" | "metadata") = return metadata <br />
    "help" return this information.</td></tr>
<tr><td>filter</td><td>PQN or <a href="http://digir.sourceforge.net">DiGIR filter structure</a></td></tr>
<tr><td>resource</td><td>Name of the resource being queried</td></tr>
<tr><td>startRec</td><td>Zero based index of the first record to retrieve from the result set</td></tr>
<tr><td>maxRecs</td><td>Maximum number of records to retrieve</td></tr>
<tr><td>clientKey</td><td>Optional value that will be attached to each record element as an attribute called clientKey</td></tr>
<tr><td>recordStruct</td><td>XMLSchema or schema fragment defining the output record structure</td></tr>
<tr><td>sortStruct</td><td>TBD</td></tr>
<tr><td>countRecs</td><td>set to true or 1 to return the match count as a diagnostic in the response</td></tr>
<tr><td>debug</td><td>set to 1 to output a bunch of debug information</td></tr>
<tr><td>cache</td><td>set to 0 or 1 to turn off or on the caching mechanism (default is on)</td></tr>
</table>

<h3>Resources</h3>
<p>View the metadata of this provider <a href="DiGIR.php">here</a>.</p>
<p>Get a list of DiGIR providers from the UDDI registry <a href='DiGIR_uddiSearch.php'>here</a>.</p>
</body>
</html>
