X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=fd10f677a20351bde429eb2884f159092f91477a;hb=22ae3398d1153b29cdba238f1a5f21e7b3cf35e3;hp=924c6e7e5bacaa86e93342fd6d375fc0b6dc703d;hpb=6951bed95e519efe86d2b9bca10a0ac2d1ec1189;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index 924c6e7..fd10f67 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -1,6 +1,6 @@ - %local; @@ -13,10 +13,12 @@ Pazpar2 &version; + Index Data Pazpar2 protocol 7 + Conventions and miscellaneous @@ -24,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 @@ -32,16 +35,20 @@ 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. + Returns session ID to be used in subsequent requests. If + a server ID is given in the Pazpar2 server section, then a + period (.) and the server ID is appended to the session ID. Example: @@ -59,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 @@ -88,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 @@ -141,7 +149,7 @@ Example: Response: OK ]]> - - + + - search + + search Launches a search, parameters: - + session @@ -177,7 +186,49 @@ filter - Filtering. + Limits the search to a given set of targets specified by the + filter. The filter consists a comma separated list of + setting+operator+args pairs. The setting is a Pazpar2 setting + (such as pz:id). + The operator is either = (string match) + or ~ (substring match). The args is a list of values separated + by | (or , one of the values). The idea is that only targets + with a setting matching one of the values given will be included + in the search. + + + + + limit + + + 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. + + + + + startrecs + + + Specifies the first record to retrieve from each target. + The first record in a result set for a target is numbered 0, next + record is numbered 2. By default maxrecs is 0. + + + + + maxrecs + + + Specifies the maximum number of records to retrieve from each + target. The default value is 100. This setting has same meaning + as per-target setting pz:maxrecs . If pz:maxrecs is set, it takes + precedence over argument maxrecs. @@ -251,7 +302,7 @@ search.pz2?session=2044502273&command=stat Session ID - + @@ -275,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. @@ -291,8 +342,10 @@ 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 - in the pazpar2.cfg file, or the special name 'relevance'. + the default. + Sort field names can be any field name designated as a sort field + in the pazpar2.cfg file, or the special names 'relevance' and + 'position'. @@ -336,7 +389,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 @@ -457,6 +510,14 @@ search.pz2?session=605047297&command=record&id=3 + + num + + + maximum number of entries to return - default is 15. + + + @@ -464,7 +525,7 @@ search.pz2?session=605047297&command=record&id=3 -Output: + Output: 3 @@ -486,8 +547,8 @@ Output: ]]> - - + + For the special termlist name "xtargets", results are returned about the targets which have returned the most hits. @@ -506,9 +567,9 @@ Output: 0 -- Z39.50 diagnostic codes ]]> - + - + bytarget @@ -531,7 +592,7 @@ Output: - + Example output: - SEE ALSO + + SEE ALSO Pazpar2: @@ -576,15 +638,7 @@ search.pz2?session=605047297&command=bytarget&id=3