X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fpazpar2_protocol.xml;h=e90b5c4835ae19ba9a0970e4b90417c3086099e0;hb=b0abe14e6d319696504767900bc8783dd4d13131;hp=0a40fcdd549d05251407ea6b45bc12ad67f5aa30;hpb=e107b0011a295ccc61502d6e5ea79d9125a3fbb4;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 0a40fcd..e90b5c4 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -1,6 +1,6 @@
-
%local;
@@ -13,10 +13,12 @@
Pazpar2
&version;
+ Index Data
Pazpar2 protocol
7
+ Conventions and miscellaneous
@@ -32,7 +34,7 @@
request is forwarded to the HTTP server specified in the configuration
using the proxy setting.
This way, a regular webserver can host the user interface (itself dynamic
- or static HTML), and AJAX-style calls can be used from JS (or any other client-based
+ or static HTML), and Ajax-style calls can be used from JS (or any other client-based
scripting environment) to interact with the search logic in Pazpar2.
@@ -41,7 +43,9 @@
init
Initializes a session.
- Returns session ID to be used in subsequent requests.
+ Returns session ID to be used in subsequent requests. If
+ a server ID is given in the Pazpar2 server section, then a
+ period (.) and the server ID is appended to the session ID.
Example:
@@ -73,6 +77,17 @@
+
+
+ service
+
+
+ If this is defined it specifies a service ID. Makes the session use
+ the service with this ID. If this is setting is omitted, the
+ session will use the unnamed service in the Pazpar2 configuration.
+
+
+
@@ -166,7 +181,36 @@
filter
- Filtering.
+ Limits the search to a given set of targets specified by the
+ filter. The filter consists a comma separated list of
+ setting+operator+args pairs. The setting is a Pazpar2 setting
+ (such as pz:id).
+ The operator is either = (string match)
+ or ~ (substring match). The args is a list of values separated
+ by | (or , one of the values). The idea is that only targets
+ with a setting matching one of the values given will be included
+ in the search.
+
+
+
+
+ startrecs
+
+
+ Specifies the first record to retrieve from each target.
+ The first record in a result set for a target is numbered 0, next
+ record is numbered 2. By default maxrecs is 0.
+
+
+
+
+ maxrecs
+
+
+ Specifies the maximum number of records to retrieve from each
+ target. The default value is 100. This setting has same meaning
+ as per-target setting pz:maxrecs . If pz:maxrecs is set, it takes
+ precedence over argument maxrecs.
@@ -280,7 +324,8 @@ search.pz2?session=2044502273&command=stat
field first. A sort field may be followed by a colon followed by
the number '0' or '1', indicating whether results should be sorted in
increasing or decreasing order according to that field. 0==Decreasing is
- the default.
+ the default. Sort field names can be any field name designated as a sort field
+ in the pazpar2.cfg file, or the special name 'relevance'.
@@ -445,6 +490,14 @@ search.pz2?session=605047297&command=record&id=3
+
+ num
+
+
+ maximum number of entries to return - default is 15.
+
+
+