X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=e90b5c4835ae19ba9a0970e4b90417c3086099e0;hb=bf81b551fa94e438b97bc4c7d1613ec2923a6b48;hp=23ddc280a0ff6004fdc39e1997808e6b2f5b0f80;hpb=98e1ff5ebcca708e56e87ed5ff3596cdf9b2ae1a;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index 23ddc28..e90b5c4 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -1,5 +1,6 @@ - + %local; @@ -8,15 +9,16 @@ %idcommon; ]> - Pazpar2 &version; + Index Data Pazpar2 protocol 7 + Conventions and miscellaneous @@ -32,7 +34,7 @@ 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 + 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. @@ -41,7 +43,9 @@ 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: @@ -61,7 +65,30 @@ 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. + applied to the new session. Other parameters for init are: + + + clear + + + If this is defined and the value is non-zero, the session will + not use the predefined databases in the configuration; only those + specified in the settings parameters (per session databases). + + + + + + service + + + If this is defined it specifies a service ID. Makes the session use + the service with this ID. If this is setting is omitted, the + session will use the unnamed service in the Pazpar2 configuration. + + + + @@ -150,6 +177,43 @@ + + filter + + + 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. + + + + + 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. + + + @@ -260,7 +324,8 @@ 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. + 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'. @@ -301,7 +366,9 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 record - Retrieves a detailed record. Parameters: + Retrieves a detailed record. Unlike the + show command, this command + returns metadata records before merging takes place. Parameters: @@ -322,6 +389,62 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1 + + + offset + + + 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. + + + 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. + + + + + + syntax + + + This optional parameter is the record syntax used for raw + transfer (i.e. when offset is specified). If syntax is not given, + but offset is used, the value of pz:requestsyntax is used. + + + + + + esn + + + This optional parameter is the element set name used to retrieval + of a raw record (i.e. when offset is specified). + If esn is not given, but offset is used, the value of pz:elements + is used. + + + + + + binary + + + 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. + + + + @@ -341,7 +464,6 @@ search.pz2?session=605047297&command=record&id=3 Mairs, John W. Cartography - @@ -350,10 +472,33 @@ search.pz2?session=605047297&command=record&id=3 termlist Retrieves term list(s). Parameters: - -session -name -- comma-separated list of termlist names (default "subject") - + + + + session + + + Session Id. + + + + + name + + + comma-separated list of termlist names (default "subject") + + + + + num + + + maximum number of entries to return - default is 15. + + + + Example: @@ -425,7 +570,7 @@ Output: Example: Example output: @@ -447,11 +592,27 @@ search.pz2?session=605047297&command=record&id=3 The following client states are defined: Client_Connecting, Client_Connected, Client_Idle, Client_Initializing, Client_Searching, Client_Searching, Client_Presenting, Client_Error, Client_Failed, - Client_Disconnected, Client_Stopped. + Client_Disconnected, Client_Stopped, Client_Continue. + SEE ALSO + + Pazpar2: + + pazpar2 + 8 + + + + Pazpar2 Configuration: + + pazpar2_conf + 5 + + +