X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=e227354dfbed8e047f876bae6ec5863cb8dbb4ef;hb=22a1cf361ec5c4850c74cd1652dd175d833afe0e;hp=b8031b5cc1a3591ab773e7cd72164b074a9ad221;hpb=2d6ca35bd10a7cd633ab471ebbb146d25d8c29b0;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index b8031b5..e227354 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -37,7 +37,7 @@ 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. + in Pazpar2. Each command is described in sub sections to follow. @@ -48,7 +48,20 @@ Initializes a session. 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. + that is included in the session ID as suffix after a period (.). + + + If the init command is performed as a HTTP GET request, service + and settings from local files are used. The service parameter + may chose a particular local service. + + + If the init command is performed as a HTTP POST request and + the content-type is text/xml, then the content is XML parsed + and treated as service for the session. The root element should be + service. Refer to descripton of the + service format. + The posting of a service appeared in Pazpar2 version 1.2.1. Example: @@ -124,8 +137,10 @@ 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 + 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. @@ -145,7 +160,15 @@ the init command. - + + + If the settings command is performed as HTTP POST and the content-type + is text/xml, then the content is XML parsed and treated as settings - + with a format identical to local + settings files. + The posting of settings appeared in Pazpar version 1.2.1. + + Example: 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. @@ -202,12 +228,17 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1 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:limitmap configuration item defines how the searches are - mapped to a database. + 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. @@ -232,6 +263,31 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1 + + 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' (decreasing) or '1' (increasing). Default + sort order is decreasing. + 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'. + + + If not specified here or as sort-default" + in pazpar2.cfg, Pazpar2 will default to the built-in 'relevance' ranking. + + + Having sort criteria at search is important for targets that + supports native sorting in order to get best results. Pazpar2 + will trigger a new search if search criteria changes from Pazpar2 + to target-based sorting or visa-versa. + + + @@ -334,22 +390,75 @@ search.pz2?session=2044502273&command=stat + mergekey + + + Sets mergekey for this search and rest of session, or until + another mergekey is given for show/search. The mergekey value is a + comma separated list with one or more names as they appear + in the service description equivalent to + mergekey="optional" inside a metadata element. + If the empty string is given for mergekey it is disabled + and rest of session will use the default mergekey from service + or stylesheet. + + + This facility, "dynamic mergekey", appeared in Pazpar2 version + 1.6.31. + + + + + 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. + the number '0' (decreasing) or '1' (increasing). Default + sort order is decreasing. 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'. + + If not specified here or as sort-default" + in pazpar2.cfg, pazpar2 will default to the built-in 'relevance' ranking. + + Having sort criteria at search is important for targets that + supports native sorting in order to get best results. pazpar2 + will trigger a new search if search criteria changes from pazpar2 + to target-based sorting. + + + + For targets where If pz:sortmap + is defined, a sort operation will be executed (possibly including + extending the search). - + + + mergekey + + + Sets mergekey for this show and rest of session, or until + another mergekey is given for show/search. The mergekey value is a + comma separated list with one or more names as they appear + in the service description equivalent to + mergekey="optional" inside a metadata element. + If the empty string is given for mergekey it is disabled + and rest of session will use the default mergekey from service + or stylesheet. + + + This facility, "dynamic mergekey", appeared in Pazpar2 version + 1.6.31. + + + + @@ -415,21 +524,56 @@ 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/checksum is not given, the Pazpar2 metadata for the record + is returned and with metadata for each targets' data specified + in a 'location' list. + + + + + + checksum + + + This optional parameter is a string which, when given, makes + Pazpar2 return the original record for a specific target. The + checksum is returned as attribtue 'checksum' in element + 'location' for show command and record command (when checksum + and offset is NOT given). + 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/checksum is not given, the Pazpar2 metadata for the record is returned and with metadata for each targets' data specified in a 'location' list. + + + 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 @@ -458,9 +602,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. @@ -506,7 +650,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.