X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fpazpar2_protocol.xml;h=eeb0d7de714646d6c5fedadaa256009fd9da6d3f;hb=469a1a01080d2e361fb26f63c4b3961ec96d628f;hp=7b30ca88e5c4c7714862c334348ba8c2e74b96f7;hpb=253ad845a02effdfaa46aae7c7e39741ec5c1b9c;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 7b30ca8..eeb0d7d 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -32,7 +32,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 +41,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 +75,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 +179,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.