X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=a8dd4f5e99beb2099921b7c733a01648a8222685;hb=9fcc9c9710afecdf31ca058f4c80f1711891c39e;hp=d332a6248516a7bf9ec600adbd288255cbc39a36;hpb=022710cf16caff9ab16cf3375e222f335b4e4327;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index d332a62..a8dd4f5 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -188,13 +188,16 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1 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 +205,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:fazetmap 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. @@ -344,7 +352,13 @@ search.pz2?session=2044502273&command=stat 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'. + 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). @@ -414,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/checksum is not given, the Pazpar2 metadata for the record is returned and with metadata for each targets' data specified in a 'location' list. @@ -430,6 +445,40 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 + 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/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 @@ -457,9 +506,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. @@ -505,7 +554,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.