*** empty log message ***

[pazpar2-moved-to-github.git] / PROTOCOL

diff --git a/PROTOCOL b/PROTOCOL
index 0999252..6db19d7 100644 (file)
--- a/PROTOCOL
+++ b/PROTOCOL
@@ -2,7 +2,9 @@
 Webservice requests are any that refer to filename "search.pz2". Arguments
 are GET-style parameters. Argument 'command' is required and specifies
 command. Any request not recognized as a webservice request as described,
-are forwarded to the HTTP server specified in option -p.
+are forwarded to the HTTP server specified in configuration.  This way, the webserver
+can host the user interface (itself dynamic or static HTML), and AJAX-style
+calls can be used from JS to interact with the search logic.
 
 Commands:
 
@@ -111,15 +113,38 @@ Output:
   <hit>
     <md-title>How to program a computer, by Jack Collins</md-title>
     <count>2</count> <!-- Number of merged records -->
+    <recid>6</recid>
   </hit>
   <hit>
     <md-title>
   Computer processing of dynamic images from an Anger scintillation camera :
   the proceedings of a workshop /
     </md-title>
+    <recid>2</recid>
   </hit>
 </show>
 
+record
+
+Retrieves a detailed record.
+
+Parameters: id -- record ID as provided by the show command
+
+Example:
+
+search.pz2?session=605047297&command=record&id=3
+
+Example output:
+
+<record>
+  <md-title>
+       The Puget Sound Region : a portfolio of thematic computer maps /
+  </md-title>
+  <md-date>1974</md-date>
+  <md-author>Mairs, John W.</md-author>
+  <md-subject>Cartography</md-subject>
+</record>
+
 termlist
 
 Retrieves term list(s)
@@ -166,3 +191,4 @@ returned in place of 'name'. This may or may not change later.
   <state>Client_Idle</state>
   <diagnostic>0</diagnostic>
 </term>
+