X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=e8985667782a1e2ba06d3ff86b9847207f17eebd;hb=048b9c3af2eb45da8355515f41ad0b40ebfe94ae;hp=e90b5c4835ae19ba9a0970e4b90417c3086099e0;hpb=9882f8aaef147d5cc2e898203aa72bb144616dfc;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index e90b5c4..e898566 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -26,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 @@ -34,13 +35,15 @@ 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. If @@ -63,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 @@ -92,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 @@ -145,7 +149,7 @@ Example: Response: OK ]]> - - + + - search + + search Launches a search, parameters: - + session @@ -183,13 +188,34 @@ 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 + 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. + 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 (typically facets). + The limit is sequence of one or more + name=args pairs separated + by comma. The args is a list of values + separated by vertical bar (|). + The meaning of | is alternative, ie OR . + A value that contains a comma (,), + a vertical bar (|) or + backslash itself must be preceded by backslash (\). + The pz:limitmap configuration + item defines how the searches are mapped to a database. @@ -284,7 +310,7 @@ search.pz2?session=2044502273&command=stat Session ID - + @@ -308,8 +334,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. @@ -324,8 +350,15 @@ 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'. + + + For targets where If pz:sortmap + is defined, a sort operation will be executed (possibly including + extending the search). @@ -369,7 +402,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 @@ -395,15 +428,16 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 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. + Pazpar2 return the original record for a specific target. + The record set from first target is numbered 0, + second record set is numbered 1, etc. + The nativesyntax setting, as usual, is used to determine how to + create XML from the original record - unless parameter + binary is given in which the record is + fetched as "raw" from ZOOM C (raw, original record). - When offset is not given the Pazpar2 metadata for the record + 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. @@ -411,6 +445,17 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 + nativesyntax + + + This optional parameter can be used to override pz:nativesyntax + as given for the target. This allow an alternative nativesyntax + to be used for original records (see parameteroffset above). + + + + + syntax @@ -438,9 +483,9 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 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. + of a original record (i.e. when offset is specified). For binary + response the record by default is fetched from ZOOM C using + the "raw" option or by parameter nativesyntax if given. @@ -486,7 +531,8 @@ search.pz2?session=605047297&command=record&id=3 name - comma-separated list of termlist names (default "subject") + comma-separated list of termlist names. If omitted, + all termlists are returned. @@ -505,7 +551,7 @@ search.pz2?session=605047297&command=record&id=3 -Output: + Output: 3 @@ -527,8 +573,8 @@ Output: ]]> - - + + For the special termlist name "xtargets", results are returned about the targets which have returned the most hits. @@ -547,9 +593,9 @@ Output: 0 -- Z39.50 diagnostic codes ]]> - + - + bytarget @@ -572,7 +618,7 @@ Output: - + Example output: - SEE ALSO + + SEE ALSO Pazpar2: @@ -617,15 +664,7 @@ search.pz2?session=605047297&command=bytarget&id=3