X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=0a40fcdd549d05251407ea6b45bc12ad67f5aa30;hb=035fffc6a58e65cdb99ee41cdd843345c7700f67;hp=2d75c17df235b06fce8dba4fe82def23868d4f2a;hpb=907e8fda0e0052bd08b333f104344c1a26f2f409;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index 2d75c17..0a40fcd 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -1,3 +1,4 @@ + %entities; - - %common; + + %idcommon; ]> - Pazpar2 @@ -27,9 +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 option -p. + 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. @@ -54,6 +58,23 @@ 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. Other parameters for init are: + + + clear + + + If this is defined and the value is non-zero, the session will + not use the predefined databases in the configuration; only those + specified in the settings parameters (per session databases). + + + + + ping @@ -78,10 +99,52 @@ ]]> + + 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. + + + + + As a shortcut, it is also possible to override settings directly in + the init command. + + + + + Example: + + Response: + + OK + +]]> + + + search Launches a search, parameters: - + session @@ -99,13 +162,21 @@ + + filter + + + Filtering. + + + Example: Response: @@ -120,7 +191,7 @@ search.pz2?session=2044502273&command=search&query=computer stat - Provides status of ongoing search. Parameters: + Provides status information about an ongoing search. Parameters: @@ -144,7 +215,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 @@ -193,33 +264,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 @@ -236,10 +321,21 @@ search.pz2?session=2044502273&command=show&start=0&num=2 record - Retrieves a detailed record. Parameters: + Retrieves a detailed record. Unlike the + show command, this command + returns metadata records before merging takes place. Parameters: + session + + + Session ID + + + + + id @@ -248,6 +344,62 @@ search.pz2?session=2044502273&command=show&start=0&num=2 + + + offset + + + This optional parameter is an integer which, when given, makes + Pazpar2 return the raw record for a target. The raw record + from first target is numbered 0, second numbered 1, etc. + When a raw record is returned Pazpar2 will XSLT transform the + record but an XML version is returned. All ISO2709 records are + returned as MARCXML. OPAC records are returned as YAZ' + OPAC with an MARCXML sibling. + + + When offset is not given the Pazpar2 metadata for the record + is returned and with metadata for each targets' data specified + in a 'location' list. + + + + + + syntax + + + This optional parameter is the record syntax used for raw + transfer (i.e. when offset is specified). If syntax is not given, + but offset is used, the value of pz:requestsyntax is used. + + + + + + esn + + + This optional parameter is the element set name used to retrieval + of a raw record (i.e. when offset is specified). + If esn is not given, but offset is used, the value of pz:elements + is used. + + + + + + binary + + + This optional parameter enables "binary" response for retrieval + of a raw record (i.e. when offset is specified). For binary + responses the record is not converted to + XML and the HTTP content type is application/octet-stream. + + + + @@ -267,7 +419,6 @@ search.pz2?session=605047297&command=record&id=3 Mairs, John W. Cartography - @@ -276,10 +427,25 @@ search.pz2?session=605047297&command=record&id=3 termlist Retrieves term list(s). Parameters: - -session -name -- comma-separated list of termlist names (default "subject") - + + + + session + + + Session Id. + + + + + name + + + comma-separated list of termlist names (default "subject") + + + + Example: @@ -323,14 +489,76 @@ 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, Client_Continue. + + + + + SEE ALSO + + Pazpar2: + + pazpar2 + 8 + + + + Pazpar2 Configuration: + + pazpar2_conf + 5 + +