X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=7b30ca88e5c4c7714862c334348ba8c2e74b96f7;hb=5b4ea0cf66dd82c871ed7d69a5801d78789087b2;hp=155722ae67dadf54eca893318d850a3ab0f34cf6;hpb=b79fcd31650cec9ae118adaefbaa2dd6cbcc5d66;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index 155722a..7b30ca8 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -1,3 +1,4 @@ + %entities; - - %common; + + %idcommon; ]> - Pazpar2 @@ -33,7 +33,7 @@ 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. + scripting environment) to interact with the search logic in Pazpar2. Each command is described in sub sections to follow. @@ -58,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 @@ -82,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 @@ -103,6 +162,14 @@ + + filter + + + Filtering. + + + @@ -205,19 +272,20 @@ search.pz2?session=2044502273&command=stat - 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. - - - - + 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. Sort field names can be any field name designated as a sort field + in the pazpar2.cfg file, or the special name 'relevance'. + + + + @@ -254,7 +322,9 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 record - Retrieves a detailed record. Parameters: + Retrieves a detailed record. Unlike the + show command, this command + returns metadata records before merging takes place. Parameters: @@ -262,7 +332,7 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 Session ID - + @@ -275,6 +345,62 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 + + + 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. + + + + @@ -294,7 +420,6 @@ search.pz2?session=605047297&command=record&id=3 Mairs, John W. Cartography - @@ -303,10 +428,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: @@ -369,7 +509,7 @@ Output: session - Session Id. + Session Id. @@ -378,7 +518,7 @@ Output: Example: Example output: @@ -396,15 +536,31 @@ search.pz2?session=605047297&command=record&id=3 ]]> - - 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. + + 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 + + +