X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=f266fd7944bd7f8f9e7dcd1944840766d947479c;hb=20bc8b17d60373c2c93ab6bb777d19dd92ed2960;hp=a9e28b8cfadbe53416279ac3469d46b87b004db5;hpb=9e89d4e3c7bc9c9a9b0e7cedc54ca3f15b49de1f;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index a9e28b8..f266fd7 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -240,6 +240,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. + + + @@ -348,12 +373,25 @@ search.pz2?session=2044502273&command=stat 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). @@ -423,21 +461,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 @@ -466,9 +539,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.