From: Adam Dickmeiss <adam@indexdata.dk>
Date: Wed, 27 Jun 2012 08:11:08 +0000 (+0200)
Subject: Document checksum facility
X-Git-Tag: v1.6.15~5
X-Git-Url: http://sru.miketaylor.org.uk/?a=commitdiff_plain;h=9fcc9c9710afecdf31ca058f4c80f1711891c39e;p=pazpar2-moved-to-github.git

Document checksum facility
---

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index e898566..a8dd4f5 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -437,7 +437,7 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
 	fetched as "raw" from ZOOM C (raw, original record).
        </para>
        <para>
-	When offset is not given, the Pazpar2 metadata for the record
+	When offset/checksum is not given, the Pazpar2 metadata for the record
 	is returned and with metadata for each targets' data specified
 	in a 'location' list.
        </para>
@@ -445,6 +445,29 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
      </varlistentry>
 
      <varlistentry>
+      <term>checksum</term>
+      <listitem>
+       <para>
+	This optional parameter is a string which, when given, makes
+	Pazpar2 return the original record for a specific target. The
+	checksum is returned as attribtue 'checksum' in element
+	'location' for show command and record command (when checksum
+	and offset is NOT given).
+	The nativesyntax setting, as usual, is used to determine how to
+	create XML from the original record - unless parameter
+	<literal>binary</literal> is given in which the record is
+	fetched as "raw" from ZOOM C (raw, original record).
+       </para>
+       <para>
+	When offset/checksum 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>nativesyntax</term>
       <listitem>
        <para>