From: <vie...@us...> - 2003-05-20 21:12:32
|
Update of /cvsroot/digir/DiGIRprov/doc In directory sc8-pr-cvs1:/tmp/cvs-serv16676/doc Modified Files: prov_manual.html prov_manual.txt Log Message: Updated request examples section Index: prov_manual.html =================================================================== RCS file: /cvsroot/digir/DiGIRprov/doc/prov_manual.html,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** prov_manual.html 7 May 2003 16:11:52 -0000 1.8 --- prov_manual.html 20 May 2003 21:09:16 -0000 1.9 *************** *** 7,11 **** <title>DiGIR Provider Manual</title> <meta name="author" content="Dave Vieglais" /> ! <meta name="date" content="2003-05-01" /> <link rel="stylesheet" href="default.css" type="text/css" /> </head> --- 7,11 ---- <title>DiGIR Provider Manual</title> <meta name="author" content="Dave Vieglais" /> ! <meta name="date" content="2003-05-07" /> <link rel="stylesheet" href="default.css" type="text/css" /> </head> *************** *** 20,26 **** <td>Dave Vieglais</td></tr> <tr><th class="docinfo-name">Revision:</th> ! <td>1.7</td></tr> <tr><th class="docinfo-name">Date:</th> ! <td>2003-05-01</td></tr> </tbody> </table> --- 20,26 ---- <td>Dave Vieglais</td></tr> <tr><th class="docinfo-name">Revision:</th> ! <td>1.9</td></tr> <tr><th class="docinfo-name">Date:</th> ! <td>2003-05-07</td></tr> </tbody> </table> *************** *** 1164,1167 **** --- 1164,1182 ---- <dd>Indicates the type of operation being invoked. This can be one of <tt class="literal"><span class="pre">metadata</span></tt>, <tt class="literal"><span class="pre">search</span></tt>, or <tt class="literal"><span class="pre">inventory</span></tt>.</dd> </dl> + <p>Example of a formal Metadata Request document:</p> + <pre class="literal-block"> + <request + xmlns='http://digir.net/schema/protocol/2003/1.0' + xmlns:xsd='http://www.w3.org/2001/XMLSchema' + xmlns:digir='http://digir.net/schema/protocol/2003/1.0'> + <header> + <version>1.0.0</version> + <sendTime>20030421T170441.431Z</sendTime> + <source>127.0.0.1</source> + <destination resource='test'>http://localhost/digir/DiGIR.php</destination> + <type>metadata</type> + </header> + </request> + </pre> </div> </div> *************** *** 1170,1179 **** <p>How to retrieve an inventory for a concept within a resource.</p> <p>The static html file <tt class="literal"><span class="pre">eg_inventory.htm</span></tt> located in the <tt class="literal"><span class="pre">DIGIR_ROOT/www</span></tt> folder provides an example of an inventory request on the concept <tt class="literal"><span class="pre">dwc:Species</span></tt> for the resource named <tt class="literal"><span class="pre">test</span></tt>.</p> ! <p>TO BE COMPLETED</p> </div> <div class="section" id="retrieving-records-from-resource"> <h2><a class="toc-backref" href="#id76" name="retrieving-records-from-resource">Retrieving Records from Resource</a></h2> ! <p>How to retrieve records from a resource.</p> ! <p>TO BE COMPLETED</p> </div> <div class="section" id="registering-a-provider-in-uddi"> --- 1185,1266 ---- <p>How to retrieve an inventory for a concept within a resource.</p> <p>The static html file <tt class="literal"><span class="pre">eg_inventory.htm</span></tt> located in the <tt class="literal"><span class="pre">DIGIR_ROOT/www</span></tt> folder provides an example of an inventory request on the concept <tt class="literal"><span class="pre">dwc:Species</span></tt> for the resource named <tt class="literal"><span class="pre">test</span></tt>.</p> ! <dl> ! <dt>Resource name</dt> ! <dd><tt class="literal"><span class="pre">test</span></tt></dd> ! <dt>Schema name space</dt> ! <dd><a class="reference" href="http://digir.net/schema/conceptual/darwin/2003/1.0">http://digir.net/schema/conceptual/darwin/2003/1.0</a></dd> ! <dt>Inventory concept</dt> ! <dd><tt class="literal"><span class="pre">dwc:Species</span></tt></dd> ! <dt>Return record count</dt> ! <dd>Yes</dd> ! </dl> ! <pre class="literal-block"> ! <request ! xmlns='http://digir.net/schema/protocol/2003/1.0' ! xmlns:xsd='http://www.w3.org/2001/XMLSchema' ! xmlns:digir='http://digir.net/schema/protocol/2003/1.0'> ! <header> ! <version>1.0.0</version> ! <sendTime>20030421T170441.431Z</sendTime> ! <source>127.0.0.1</source> ! <destination resource='test'>http://localhost/digir/DiGIR.php</destination> ! <type>inventory</type> ! </header> ! <inventory xmlns:dwc='http://digir.net/schema/conceptual/darwin/2003/1.0'> ! <dwc:Species /> ! <count>true</count> ! </inventory> ! </request> ! </pre> </div> <div class="section" id="retrieving-records-from-resource"> <h2><a class="toc-backref" href="#id76" name="retrieving-records-from-resource">Retrieving Records from Resource</a></h2> ! <p>An example of a search request document is shown below. This search returns records based on the criteria:</p> ! <dl> ! <dt>Resource Name</dt> ! <dd><tt class="literal"><span class="pre">test</span></tt></dd> ! <dt>Schema namespace</dt> ! <dd><a class="reference" href="http://digir.net/schema/conceptual/darwin/2003/1.0">http://digir.net/schema/conceptual/darwin/2003/1.0</a></dd> ! <dt>Filter</dt> ! <dd><tt class="literal"><span class="pre">ScientificName</span> <span class="pre">LIKE</span> <span class="pre">'f%'</span></tt></dd> ! <dt>Rrecord structure</dt> ! <dd>Schema located at: <a class="reference" href="http://digir.sourceforge.net/schema/conceptual/darwin/brief/2003/1.0/darwin2brief.xsd">http://digir.sourceforge.net/schema/conceptual/darwin/brief/2003/1.0/darwin2brief.xsd</a></dd> ! <dt>Start record index</dt> ! <dd>0</dd> ! <dt>Maximum number of records</dt> ! <dd>10</dd> ! <dt>Return count of records?</dt> ! <dd>Yes</dd> ! </dl> ! <pre class="literal-block"> ! <request ! xmlns="http://digir.net/schema/protocol/2003/1.0" ! xmlns:xsd="http://www.w3.org/2001/XMLSchema" ! xmlns:darwin="http://digir.net/schema/conceptual/darwin/2003/1.0" ! xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ! xsi:schemaLocation="http://digir.net/schema/protocol/2003/1.0 ! http://digir.sourceforge.net/schema/protocol/2003/1.0/digir.xsd ! http://digir.net/schema/conceptual/darwin/2003/1.0 ! http://digir.sourceforge.net/schema/conceptual/darwin/2003/1.0/darwin2.xsd"> ! <header> ! <version>1.0</version> ! <sendTime>2003-03-09T19:14:58-05:00</sendTime> ! <source>216.91.87.102</source> ! <destination resource="test">http://localhost/DiGIR/DiGIR.php</destination> ! <type>search</type> ! </header> ! <search> ! <filter> ! <like> ! <darwin:ScientificName>f%</darwin:ScientificName> ! </like> ! </filter> ! <records limit="10" start="0"> ! <structure schemaLocation="http://digir.sourceforge.net/schema/conceptual/darwin/brief/2003/1.0/darwin2brief.xsd"/> ! </records> ! <count>true</count> ! </search> ! </request> ! </pre> </div> <div class="section" id="registering-a-provider-in-uddi"> Index: prov_manual.txt =================================================================== RCS file: /cvsroot/digir/DiGIRprov/doc/prov_manual.txt,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -d -r1.9 -r1.10 *** prov_manual.txt 7 May 2003 16:11:53 -0000 1.9 --- prov_manual.txt 20 May 2003 21:09:17 -0000 1.10 *************** *** 864,867 **** --- 864,881 ---- Indicates the type of operation being invoked. This can be one of ``metadata``, ``search``, or ``inventory``. + Example of a formal Metadata Request document:: + + <request + xmlns='http://digir.net/schema/protocol/2003/1.0' + xmlns:xsd='http://www.w3.org/2001/XMLSchema' + xmlns:digir='http://digir.net/schema/protocol/2003/1.0'> + <header> + <version>1.0.0</version> + <sendTime>20030421T170441.431Z</sendTime> + <source>127.0.0.1</source> + <destination resource='test'>http://localhost/digir/DiGIR.php</destination> + <type>metadata</type> + </header> + </request> Inventory of Resource *************** *** 872,883 **** The static html file ``eg_inventory.htm`` located in the ``DIGIR_ROOT/www`` folder provides an example of an inventory request on the concept ``dwc:Species`` for the resource named ``test``. ! TO BE COMPLETED Retrieving Records from Resource ================================ ! How to retrieve records from a resource. - TO BE COMPLETED Registering a Provider in UDDI --- 886,969 ---- The static html file ``eg_inventory.htm`` located in the ``DIGIR_ROOT/www`` folder provides an example of an inventory request on the concept ``dwc:Species`` for the resource named ``test``. ! Resource name ! ``test`` ! Schema name space ! http://digir.net/schema/conceptual/darwin/2003/1.0 ! Inventory concept ! ``dwc:Species`` ! Return record count ! Yes ! ! :: ! ! <request ! xmlns='http://digir.net/schema/protocol/2003/1.0' ! xmlns:xsd='http://www.w3.org/2001/XMLSchema' ! xmlns:digir='http://digir.net/schema/protocol/2003/1.0'> ! <header> ! <version>1.0.0</version> ! <sendTime>20030421T170441.431Z</sendTime> ! <source>127.0.0.1</source> ! <destination resource='test'>http://localhost/digir/DiGIR.php</destination> ! <type>inventory</type> ! </header> ! <inventory xmlns:dwc='http://digir.net/schema/conceptual/darwin/2003/1.0'> ! <dwc:Species /> ! <count>true</count> ! </inventory> ! </request> ! Retrieving Records from Resource ================================ ! An example of a search request document is shown below. This search returns records based on the criteria: ! ! Resource Name ! ``test`` ! Schema namespace ! http://digir.net/schema/conceptual/darwin/2003/1.0 ! Filter ! ``ScientificName LIKE 'f%'`` ! Record structure ! Schema located at: http://digir.sourceforge.net/schema/conceptual/darwin/brief/2003/1.0/darwin2brief.xsd ! Start record index ! 0 ! Maximum number of records ! 10 ! Return count of records? ! Yes ! ! :: ! ! <request ! xmlns="http://digir.net/schema/protocol/2003/1.0" ! xmlns:xsd="http://www.w3.org/2001/XMLSchema" ! xmlns:darwin="http://digir.net/schema/conceptual/darwin/2003/1.0" ! xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ! xsi:schemaLocation="http://digir.net/schema/protocol/2003/1.0 ! http://digir.sourceforge.net/schema/protocol/2003/1.0/digir.xsd ! http://digir.net/schema/conceptual/darwin/2003/1.0 ! http://digir.sourceforge.net/schema/conceptual/darwin/2003/1.0/darwin2.xsd"> ! <header> ! <version>1.0</version> ! <sendTime>2003-03-09T19:14:58-05:00</sendTime> ! <source>216.91.87.102</source> ! <destination resource="test">http://localhost/DiGIR/DiGIR.php</destination> ! <type>search</type> ! </header> ! <search> ! <filter> ! <like> ! <darwin:ScientificName>f%</darwin:ScientificName> ! </like> ! </filter> ! <records limit="10" start="0"> ! <structure schemaLocation="http://digir.sourceforge.net/schema/conceptual/darwin/brief/2003/1.0/darwin2brief.xsd"/> ! </records> ! <count>true</count> ! </search> ! </request> Registering a Provider in UDDI |