X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=d332a6248516a7bf9ec600adbd288255cbc39a36;hb=4f6b54c65f9ac5b0760bc11eb51747857c1d5589;hp=b74e42b2f18e5e7a00fd6afa9d0218acd96b24a4;hpb=669d1bc07e61c81e0d931409c4160404628fb236;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index b74e42b..d332a62 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -26,7 +26,8 @@
The webservice protocol of Pazpar2
- DESCRIPTION
+
+ DESCRIPTION
Webservice requests are any that refer to filename "search.pz2". Arguments
are GET-style parameters. Argument 'command' is always required and specifies
@@ -34,13 +35,15 @@
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
- scripting environment) to interact with the search logic in Pazpar2.
+ 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.
Each command is described in sub sections to follow.
- init
+
+ init
Initializes a session.
Returns session ID to be used in subsequent requests. If
@@ -63,9 +66,9 @@
]]>
- The init command may take a number of setting parameters, similar to
- the 'settings' command described below. These settings are immediately
- applied to the new session. Other parameters for init are:
+ The init command may take a number of setting parameters, similar to
+ the 'settings' command described below. These settings are immediately
+ applied to the new session. Other parameters for init are:
clear
@@ -92,7 +95,8 @@
- ping
+
+ ping
Keeps a session alive. An idle session will time out after one minute.
The ping command can be used to keep the session alive absent other
@@ -145,7 +149,7 @@
Example:
Response:
OK
]]>
-
-
+
+
- search
+
+ search
Launches a search, parameters:
-
+
session
@@ -197,9 +202,12 @@
limit
- Narrows the search by one or more facet fields. The limit is
- sequence of one or more field=value pairs separate by comma.
+ Narrows the search by one or more fields (typicall facets).
+ The limit is sequence of one or more field=value pairs separate
+ by comma.
A value that contains a comma should be escaped by backslash (\).
+ The pz:fazetmap configuration item defines how the searches are
+ mapped to a database.
@@ -294,7 +302,7 @@ search.pz2?session=2044502273&command=stat
Session ID
-
+
@@ -318,8 +326,8 @@ search.pz2?session=2044502273&command=stat
block
- If block is set to 1, the command will hang until there are records ready
- to display. Use this to show first records rapidly without
+ If block is set to 1, the command will hang until there are records
+ ready to display. Use this to show first records rapidly without
requiring rapid polling.
@@ -334,7 +342,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. Sort field names can be any field name designated as a sort field
+ 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'.
@@ -379,7 +388,7 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
Retrieves a detailed record. Unlike the
show command, this command
returns metadata records before merging takes place. Parameters:
-
+
session
@@ -515,7 +524,7 @@ search.pz2?session=605047297&command=record&id=3
-Output:
+ Output:
3
@@ -537,8 +546,8 @@ Output:
]]>
-
-
+
+
For the special termlist name "xtargets", results
are returned about the targets which have returned the most hits.
@@ -557,9 +566,9 @@ Output:
0 -- Z39.50 diagnostic codes
]]>
-
+
-
+
bytarget
@@ -582,7 +591,7 @@ Output:
-
+
Example output:
- SEE ALSO
+
+ SEE ALSO
Pazpar2:
@@ -627,15 +637,7 @@ search.pz2?session=605047297&command=bytarget&id=3