Imported changes from us4. Should not negatively impact other sites.

[pazpar2-moved-to-github.git] / doc / pazpar2_protocol.xml

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 7befc40..0a40fcd 100644 (file)
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -1,3 +1,4 @@
+<?xml version="1.0" standalone="no"?>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
 [
@@ -8,7 +9,6 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: pazpar2_protocol.xml,v 1.10 2007-06-28 09:36:11 adam Exp $ -->
 <refentry id="pazpar2_protocol">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -162,6 +162,14 @@
        </para>
       </listitem>
      </varlistentry>
+     <varlistentry>
+      <term>filter</term>
+      <listitem>
+       <para>
+       Filtering.
+       </para>
+      </listitem>
+     </varlistentry>
     </variablelist>
 
    </para>
@@ -313,7 +321,9 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
   <refsect2 id="command-record">
    <title>record</title>
    <para>
-    Retrieves a detailed record. Parameters:
+    Retrieves a detailed record. Unlike the 
+    <link linkend="command-show">show</link> command, this command 
+    returns metadata records before merging takes place. Parameters:
 
     <variablelist>
      <varlistentry>
@@ -334,6 +344,62 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
        </para>
       </listitem>
      </varlistentry>
+
+     <varlistentry>
+      <term>offset</term>
+      <listitem>
+       <para>
+       This optional parameter is an integer which, when given, makes
+       Pazpar2 return the raw record for a target. The raw record
+       from first target is numbered 0, second numbered 1, etc.
+       When a raw record is returned Pazpar2 will XSLT transform the
+       record but an XML version is returned. All ISO2709 records are
+       returned as MARCXML. OPAC records are returned as YAZ'
+       OPAC with an MARCXML sibling.
+       </para>
+       <para>
+       When offset is not given the Pazpar2 metadata for the record
+       is returned and with metadata for each targets' data specified
+       in a 'location' list.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>syntax</term>
+      <listitem>
+       <para>
+       This optional parameter is the record syntax used for raw 
+       transfer (i.e. when offset is specified). If syntax is not given,
+       but offset is used, the value of pz:requestsyntax is used.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>esn</term>
+      <listitem>
+       <para>
+       This optional parameter is the element set name used to retrieval
+       of a raw record (i.e. when offset is specified).
+       If esn is not given, but offset is used, the value of pz:elements
+       is used.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>binary</term>
+      <listitem>
+       <para>
+       This optional parameter enables "binary" response for retrieval
+       of a raw record (i.e. when offset is specified). For binary
+       responses the record is <emphasis>not</emphasis> converted to
+       XML and the HTTP content type is application/octet-stream.
+       </para>
+      </listitem>
+     </varlistentry>
+
     </variablelist>
    </para>
    <para> 
@@ -353,7 +419,6 @@ search.pz2?session=605047297&command=record&id=3
   <md-author>Mairs, John W.</md-author>
   <md-subject>Cartography</md-subject>
 </record>
-    <screen><![CDATA[
 ]]></screen>
    </para>
   </refsect2>
@@ -362,10 +427,25 @@ search.pz2?session=605047297&command=record&id=3
    <title>termlist</title>
    <para>
     Retrieves term list(s). Parameters:
-
-session
-name       -- comma-separated list of termlist names (default "subject")
-
+    
+    <variablelist>
+     <varlistentry>
+      <term>session</term>
+      <listitem>
+       <para>
+       Session Id.
+       </para>
+      </listitem>
+     </varlistentry>
+     <varlistentry>
+      <term>name</term>
+      <listitem>
+       <para>
+       comma-separated list of termlist names (default "subject")
+       </para>
+      </listitem>
+     </varlistentry>
+    </variablelist>
    </para>
    <para>
     Example:
@@ -437,7 +517,7 @@ Output:
    <para> 
     Example:
     <screen><![CDATA[
-search.pz2?session=605047297&command=record&id=3
+search.pz2?session=605047297&command=bytarget&id=3
 ]]></screen>
 
     Example output:
@@ -459,11 +539,27 @@ search.pz2?session=605047297&command=record&id=3
     The following client states are defined: Client_Connecting,
     Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
     Client_Searching, Client_Presenting, Client_Error, Client_Failed,
-    Client_Disconnected, Client_Stopped.
+    Client_Disconnected, Client_Stopped, Client_Continue.
    </para>
   </refsect2>
 
  </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   Pazpar2:
+   <citerefentry>
+    <refentrytitle>pazpar2</refentrytitle>
+    <manvolnum>8</manvolnum>
+   </citerefentry>
+  </para>
+  <para>
+   Pazpar2 Configuration:
+   <citerefentry>
+    <refentrytitle>pazpar2_conf</refentrytitle>
+    <manvolnum>5</manvolnum>
+   </citerefentry>
+  </para>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file