X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=a6fcf26dfead9e95444753f8ce3b32892b0e58a0;hb=f9e9bf847cf81d621e4b9a7106f0dc74a1063785;hp=f266fd7944bd7f8f9e7dcd1944840766d947479c;hpb=dec24591aae7f790e456b70e3c367918843505b3;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index f266fd7..a6fcf26 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -37,7 +37,7 @@
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 scripting environment) to interact with the search logic
- in Pazpar2.
+ in Pazpar2.
Each command is described in sub sections to follow.
@@ -48,7 +48,20 @@
Initializes a session.
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.
+ that is included in the session ID as suffix after a period (.).
+
+
+ If the init command is performed as a HTTP GET request, service
+ and settings from local files are used. The service parameter
+ may chose a particular local service.
+
+
+ If the init command is performed as a HTTP POST request and
+ the content-type is text/xml, then the content is XML parsed
+ and treated as service for the session. The root element should be
+ service. Refer to descripton of the
+ service format.
+ The posting of a service appeared in Pazpar2 version 1.2.1.
Example:
@@ -124,8 +137,10 @@
The settings command applies session-specific settings to one or more
databases. A typical function of this is to enable access to
restricted resources for registered users, or to set a user- or
- library-specific username/password to use against a target. Each
- setting parameter has the form name[target]=value, where name is the
+ library-specific username/password to use against a target.
+
+
+ Each setting parameter has the form name[target]=value, where name is the
name of the setting (e.g. pz:authentication), target is a target ID,
or possibly a wildcard, and value is the desired value for the
setting.
@@ -145,7 +160,15 @@
the init command.
-
+
+
+ If the settings command is performed as HTTP POST and the content-type
+ is text/xml, then the content is XML parsed and treated as settings -
+ with a format identical to local
+ settings files.
+ The posting of settings appeared in Pazpar version 1.2.1.
+
+
Example:
+
+
+ mergekey
+
+
+ Sets mergekey for this search and rest of session, or until
+ another mergekey is given for show/search. The mergekey value is a
+ comma separated list with one or more names as they appear
+ in the service description equivalent to
+ mergekey="optional" inside a metadata element.
+ If the empty string is given for mergekey it is disabled
+ and rest of session will use the default mergekey from service
+ or stylesheet.
+
+
+ This facility, "dynamic mergekey", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
+
+ rank
+
+
+ Sets rank method this search and rest of session, or until
+ another rank is given for show/search. The rank value is a
+ comma separated list of pairs field=value pairs. The
+ format is the same as
+ rank for a metadata element.
+ If the empty string is given for rank it is disabled
+ and rest of session will use the default rank from metadata or
+ stylesheet.
+
+
+ This facility, "dynamic ranking", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
@@ -389,13 +453,53 @@ search.pz2?session=2044502273&command=stat
- For targets where If pz:sortmap
+ For targets where If pz:sortmap
is defined, a sort operation will be executed (possibly including
extending the search).
-
+
+
+ mergekey
+
+
+ Sets mergekey for this show and rest of session, or until
+ another mergekey is given for show/search. The mergekey value is a
+ comma separated list with one or more names as they appear
+ in the service description equivalent to
+ mergekey="optional" inside a metadata element.
+ If the empty string is given for mergekey it is disabled
+ and rest of session will use the default mergekey from service
+ or stylesheet.
+
+
+ This facility, "dynamic mergekey", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
+
+ rank
+
+
+ Sets rank method this show and rest of session, or until
+ another rank is given for show/search. The rank value is a
+ comma separated list of pairs field=value pairs. The
+ format is the same as
+ rank for a metadata element.
+ If the empty string is given for rank it is disabled
+ and rest of session will use the default rank from metadata or
+ stylesheet.
+
+
+ This facility, "dynamic ranking", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+