X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fpazpar2_protocol.xml;h=db67d94da1bd91bf9dd7bddcd1857377cf9b65d0;hb=717729f05a91d07c5ef29fcc4b8b945e9df19d55;hp=537d98d918d9c197c7266e37d5c8b5dd6bb724c6;hpb=1a4126ae585a777756654d64d6439f663cce128a;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index 537d98d..db67d94 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -5,10 +5,10 @@ %local; %entities; - - %common; + + %idcommon; ]> - + Pazpar2 @@ -27,12 +27,13 @@ DESCRIPTION Webservice requests are any that refer to filename "search.pz2". Arguments - are GET-style parameters. Argument 'command' is required and specifies - command. Any request not recognized as a webservice request as described, - are forwarded to the HTTP server specified in configuration. - This way, the webserver can host the user interface (itself dynamic - or static HTML), and AJAX-style calls can be used from JS to interact - with the search logic. + are GET-style parameters. Argument 'command' is always required and specifies + the operation to perform. Any request not recognized as a webservice + 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. Each command is described in sub sections to follow. @@ -57,6 +58,11 @@ 2044502273 ]]> + + 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. + ping @@ -81,6 +87,46 @@ ]]> + + settings + + 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 + 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. + + + + Because the settings command manipulates potentially sensitive + information, it is possible to configure pazpar2 to only allow access + to this command from a trusted site -- usually from server-side + scripting, which in turn is responsible for authenticating the user, + and possibly determining which resources he has access to, etc. + + + + Note: As a shortcut, it is also possible to override settings directly in + the init command. + + + + Example: + + Response: + + OK + +]]> + + + search Launches a search, parameters: @@ -108,7 +154,7 @@ Example: Response: @@ -123,7 +169,7 @@ search.pz2?session=2044502273&command=search&query=computer stat - Provides status of ongoing search. Parameters: + Provides status information about an ongoing search. Parameters: @@ -147,7 +193,7 @@ search.pz2?session=2044502273&command=stat 3 7 -- Total hitcount - 7 -- Total number of records fetched + 7 -- Total number of records fetched in last query 1 -- Total number of associated clients 0 -- Number of disconnected clients 0 -- Number of clients in connecting state @@ -196,33 +242,47 @@ search.pz2?session=2044502273&command=stat block - If block is set, the command will hang until there are records ready + 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. + + sort + + + Specifies sort criteria. The argument is a comma-separated list + (no whitespace allowed) of sort fields, with the highest-priority + 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. + + + + Example: Output: OK - 3 - 6 - 7 - 0 - 2 + 3 -- How many clients are still working + 6 -- Number of merged records + 7 -- Total of all hitcounts + 0 -- The start number you requested + 2 -- Number of records retrieved How to program a computer, by Jack Collins - 2 - 6 + 2 -- Number of merged records + 6 -- Record ID for this record @@ -243,6 +303,15 @@ search.pz2?session=2044502273&command=show&start=0&num=2 + session + + + Session ID + + + + + id @@ -326,14 +395,60 @@ Output: library2.mcmaster.ca - 11734 - Client_Idle - 0 + 11734 -- Number of hits + Client_Idle -- See the description of 'bytarget' below + 0 -- Z39.50 diagnostic codes ]]> + + + bytarget + + Returns information about the status of each active client. Parameters: + + + + session + + + Session Id. + + + + + + + Example: + + + Example output: + + + OK + + z3950.loc.gov/voyager/ + 10000 + 0 + 65 + Client_Presenting + + + +]]> + + The following client states are defined: Client_Connecting, + Client_Connected, Client_Idle, Client_Initializing, Client_Searching, + Client_Searching, Client_Presenting, Client_Error, Client_Failed, + Client_Disconnected, Client_Stopped. + + +