X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=PROTOCOL;h=4ddfd039879b08c9ad28b7bf0ab518052f00282b;hb=015261c103f2b4f8e4d06220605a2053e52a1249;hp=2f9c22f9558d2c66fb91d4b88640ff7d9a691311;hpb=5ca759f28d681f9c8cf954655571cc9963c27b04;p=pazpar2-moved-to-github.git
diff --git a/PROTOCOL b/PROTOCOL
index 2f9c22f..4ddfd03 100644
--- a/PROTOCOL
+++ b/PROTOCOL
@@ -1,7 +1,8 @@
Webservice requests are any that refer to filename "search.pz2". Arguments
are GET-style parameters. Argument 'command' is required and specifies
-command.
+command. Any request not recognized as a webservice request as described,
+are forwarded to the HTTP server specified in option -p.
Commands:
@@ -18,6 +19,23 @@ Response example:
2044502273
+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 activity. It
+is suggested that any browser client have a simple alarm handler which
+sends a ping every 50 seconds or so once a session has been initialized.
+
+Example:
+
+search.pz?command=ping&session=2044502273
+
+Response example:
+
+
+ OK
+
+
search
Launches a search, parameters:
@@ -48,6 +66,7 @@ search.pz2?session=2044502273&command=stat
Output:
+ 3
7 -- Total hitcount
7 -- Total number of records fetched
1 -- Total number of associated clients
@@ -70,6 +89,11 @@ parameters:
session
start -- 0-indexed!!
num -- default=20
+block -- 0 or 1
+
+If block is set, the command will hang until there are records ready
+to display. Use this to show first records rapidly without requiring rapid
+polling.
Example:
@@ -79,6 +103,7 @@ Output:
OK
+ 3
6
7
0
@@ -94,3 +119,50 @@ Output:
+
+termlist
+
+Retrieves term list(s)
+
+parameters:
+
+session
+name -- comma-separated list of termlist names (default "subject")
+
+Example:
+
+search.pz2?session=2044502273&command=termlist&name=author,subject
+
+Output:
+
+
+ 3
+
+
+ Donald Knuth
+ 10
+
+
+ Robert Pirsig
+ 2
+
+
+
+
+ Computer programming
+ 10
+
+
+
+
+For the special termlist name "xtargets", results are returned about the targets
+which have returned the most hits. The 'term' subtree has additional elements,
+specifically a state and diagnostic field (in the example below, a target ID is
+returned in place of 'name'. This may or may not change later.
+
+
+ library2.mcmaster.ca
+ 11734
+ Client_Idle
+ 0
+