1 <?xml version="1.0" standalone="no"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
5 <!ENTITY % local SYSTEM "local.ent">
7 <!ENTITY % entities SYSTEM "entities.ent">
9 <!ENTITY % idcommon SYSTEM "common/common.ent">
12 <refentry id="pazpar2_protocol">
14 <productname>Pazpar2</productname>
15 <productnumber>&version;</productnumber>
16 <info><orgname>Index Data</orgname></info>
19 <refentrytitle>Pazpar2 protocol</refentrytitle>
20 <manvolnum>7</manvolnum>
21 <refmiscinfo class="manual">Conventions and miscellaneous</refmiscinfo>
25 <refname>pazpar2_protocol</refname>
26 <refpurpose>The webservice protocol of Pazpar2</refpurpose>
30 <title>DESCRIPTION</title>
32 Webservice requests are any that refer to filename "search.pz2". Arguments
33 are GET-style parameters. Argument 'command' is always required and specifies
34 the operation to perform. Any request not recognized as a webservice
35 request is forwarded to the HTTP server specified in the configuration
36 using the proxy setting.
37 This way, a regular webserver can host the user interface (itself dynamic
38 or static HTML), and Ajax-style calls can be used from JS (or any other
39 client-based scripting environment) to interact with the search logic
43 Each command is described in sub sections to follow.
45 <refsect2 id="command-init">
48 Initializes a session.
49 Returns session ID to be used in subsequent requests. If
50 a server ID is given in the Pazpar2 server section, then a
51 that is included in the session ID as suffix after a period (.).
54 If the init command is performed as a HTTP GET request, service
55 and settings from local files are used. The service parameter
56 may chose a particular local service.
59 If the init command is performed as a HTTP POST request and
60 the content-type is text/xml, then the content is XML parsed
61 and treated as service for the session. The root element should be
62 service. Refer to descripton of the
63 <link linkend="service_conf">service</link> format.
64 The posting of a service appeared in Pazpar2 version 1.2.1.
69 search.pz2?command=init
78 <session>2044502273</session>
82 The init command may take a number of setting parameters, similar to
83 the 'settings' command described below. These settings are immediately
84 applied to the new session. Other parameters for init are:
90 If this is defined and the value is non-zero, the session will
91 not use the predefined databases in the configuration; only those
92 specified in the settings parameters (per session databases).
101 If this is defined it specifies a service ID. Makes the session use
102 the service with this ID. If this is setting is omitted, the
103 session will use the unnamed service in the Pazpar2 configuration.
111 <refsect2 id="command-ping">
114 Keeps a session alive. An idle session will time out after one minute.
115 The ping command can be used to keep the session alive absent other
117 It is suggested that any browser client have a simple alarm handler which
118 sends a ping every 50 seconds or so once a session has been initialized.
123 search.pz?command=ping&session=2044502273
134 <refsect2 id="command-settings">
135 <title>settings</title>
137 The settings command applies session-specific settings to one or more
138 databases. A typical function of this is to enable access to
139 restricted resources for registered users, or to set a user- or
140 library-specific username/password to use against a target.
143 Each setting parameter has the form name[target]=value, where name is the
144 name of the setting (e.g. pz:authentication), target is a target ID,
145 or possibly a wildcard, and value is the desired value for the
150 Because the settings command manipulates potentially sensitive
151 information, it is possible to configure Pazpar2 to only allow access
152 to this command from a trusted site -- usually from server-side
153 scripting, which in turn is responsible for authenticating the user,
154 and possibly determining which resources he has access to, etc.
159 As a shortcut, it is also possible to override settings directly in
165 If the settings command is performed as HTTP POST and the content-type
166 is text/xml, then the content is XML parsed and treated as settings -
167 with a format identical to local
168 <link linkend="target_settings">settings files</link>.
169 The posting of settings appeared in Pazpar version 1.2.1.
175 search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
186 <refsect2 id="command-search">
187 <title>search</title>
189 Launches a search, parameters:
212 Limits the search to a given set of targets specified by the
213 filter. The filter consists a comma separated list of
214 <emphasis>setting</emphasis>+<emphasis>operator</emphasis>+<emphasis>args</emphasis>
215 pairs. The <emphasis>setting</emphasis> is a Pazpar2 setting
216 (such as <literal>pz:id</literal>).
217 The <emphasis>operator</emphasis> is either
218 <literal>=</literal> (string match)
219 or <literal>~</literal> (substring match).
220 The <emphasis>args</emphasis> is a list of values separated
221 by <literal>|</literal> (or , one of the values).
222 The idea is that only targets with a setting matching one of
223 the values given will be included in the search.
231 Narrows the search by one or more fields (typically facets).
232 The limit is sequence of one or more
233 <emphasis>name</emphasis>=<emphasis>args</emphasis> pairs separated
234 by comma. The <emphasis>args</emphasis> is a list of values
235 separated by vertical bar (<literal>|</literal>).
236 The meaning of <literal>|</literal> is alternative, ie OR .
237 A value that contains a comma (<literal>,</literal>),
238 a vertical bar (<literal>|</literal>) or
239 backslash itself must be preceded by backslash (<literal>\</literal>).
240 The <link linkend="limitmap">pz:limitmap</link> configuration
241 item defines how the searches are mapped to a database.
246 <term>startrecs</term>
249 Specifies the first record to retrieve from each target.
250 The first record in a result set for a target is numbered 0, next
251 record is numbered 2. By default maxrecs is 0.
259 Specifies the maximum number of records to retrieve from each
260 target. The default value is 100. This setting has same meaning
261 as per-target setting pz:maxrecs . If pz:maxrecs is set, it takes
262 precedence over argument maxrecs.
270 Specifies sort criteria. The argument is a comma-separated list
271 (no whitespace allowed) of sort fields, with the highest-priority
272 field first. A sort field may be followed by a colon followed by
273 the number '0' (decreasing) or '1' (increasing). Default
274 sort order is decreasing.
275 Sort field names can be any field name designated as a sort field
276 in the pazpar2.cfg file, or the special names 'relevance' and
280 If not specified here or as <link linkend="sort-default">sort-default"</link>
281 in pazpar2.cfg, Pazpar2 will default to the built-in 'relevance' ranking.
284 Having sort criteria at search is important for targets that
285 supports native sorting in order to get best results. Pazpar2
286 will trigger a new search if search criteria changes from Pazpar2
287 to target-based sorting or visa-versa.
297 search.pz2?session=2044502273&command=search&query=computer+science
309 <refsect2 id="command-stat">
312 Provides status information about an ongoing search. Parameters:
329 search.pz2?session=2044502273&command=stat
334 <activeclients>3</activeclients>
335 <hits>7</hits> -- Total hitcount
336 <records>7</records> -- Total number of records fetched in last query
337 <clients>1</clients> -- Total number of associated clients
338 <unconnected>0</unconnected> -- Number of disconnected clients
339 <connecting>0</connecting> -- Number of clients in connecting state
340 <initializing>0</initializing> -- Number of clients initializing
341 <searching>0</searching> -- ... searching
342 <presenting>0</presenting> -- ... presenting
343 <idle>1</idle> -- ... idle (not doing anything)
344 <failed>0</failed> -- ... Connection failed
345 <error>0</error> -- ... Error was produced somewhere
351 <refsect2 id="command-show">
354 Shows records retrieved. Parameters:
368 <para>First record to show - 0-indexed.</para>
376 Number of records to show If omitted, 20 is used.
385 If block is set to 1, the command will hang until there are records
386 ready to display. Use this to show first records rapidly without
387 requiring rapid polling.
396 Specifies sort criteria. The argument is a comma-separated list
397 (no whitespace allowed) of sort fields, with the highest-priority
398 field first. A sort field may be followed by a colon followed by
399 the number '0' (decreasing) or '1' (increasing). Default
400 sort order is decreasing.
401 Sort field names can be any field name designated as a sort field
402 in the pazpar2.cfg file, or the special names 'relevance' and
405 If not specified here or as <link linkend="sort-default">sort-default"</link>
406 in pazpar2.cfg, pazpar2 will default to the built-in 'relevance' ranking.
408 Having sort criteria at search is important for targets that
409 supports native sorting in order to get best results. pazpar2
410 will trigger a new search if search criteria changes from pazpar2
411 to target-based sorting.
415 For targets where If <link linkend="pzsortmap">pz:sortmap</link>
416 is defined, a sort operation will be executed (possibly including
417 extending the search).
423 <term>mergekey</term>
426 Sets mergekey for this show and rest of session, or until
427 another mergekey is given for show. The mergekey value is a
428 comma separated list with one or more names as they appear
429 in the service description equivalent to
430 <literal>mergekey="optional"</literal> inside a metadata element.
431 If the empty string is given for mergekey it is disabled
432 and rest of session will use the default mergekey from service
436 This facility, "dynamic mergekey", appeared in Pazpar2 version
447 search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
453 <activeclients>3</activeclients> -- How many clients are still working
454 <merged>6</merged> -- Number of merged records
455 <total>7</total> -- Total of all hitcounts
456 <start>0</start> -- The start number you requested
457 <num>2</num> -- Number of records retrieved
459 <md-title>How to program a computer, by Jack Collins</md-title>
460 <count>2</count> -- Number of merged records
461 <recid>6</recid> -- Record ID for this record
465 Computer processing of dynamic images from an Anger scintillation camera :
466 the proceedings of a workshop /
475 <refsect2 id="command-record">
476 <title>record</title>
478 Retrieves a detailed record. Unlike the
479 <link linkend="command-show">show</link> command, this command
480 returns metadata records before merging takes place. Parameters:
496 record ID as provided by the
497 <link linkend="command-show">show</link> command.
506 This optional parameter is an integer which, when given, makes
507 Pazpar2 return the original record for a specific target.
508 The record set from first target is numbered 0,
509 second record set is numbered 1, etc.
510 The nativesyntax setting, as usual, is used to determine how to
511 create XML from the original record - unless parameter
512 <literal>binary</literal> is given in which the record is
513 fetched as "raw" from ZOOM C (raw, original record).
516 When offset/checksum is not given, the Pazpar2 metadata for the record
517 is returned and with metadata for each targets' data specified
518 in a 'location' list.
524 <term>checksum</term>
527 This optional parameter is a string which, when given, makes
528 Pazpar2 return the original record for a specific target. The
529 checksum is returned as attribtue 'checksum' in element
530 'location' for show command and record command (when checksum
531 and offset is NOT given).
532 The nativesyntax setting, as usual, is used to determine how to
533 create XML from the original record - unless parameter
534 <literal>binary</literal> is given in which the record is
535 fetched as "raw" from ZOOM C (raw, original record).
538 When offset/checksum is not given, the Pazpar2 metadata for the record
539 is returned and with metadata for each targets' data specified
540 in a 'location' list.
547 <term>nativesyntax</term>
550 This optional parameter can be used to override pz:nativesyntax
551 as given for the target. This allow an alternative nativesyntax
552 to be used for original records (see parameteroffset above).
561 This optional parameter is the record syntax used for raw
562 transfer (i.e. when offset is specified). If syntax is not given,
563 but offset is used, the value of pz:requestsyntax is used.
572 This optional parameter is the element set name used to retrieval
573 of a raw record (i.e. when offset is specified).
574 If esn is not given, but offset is used, the value of pz:elements
584 This optional parameter enables "binary" response for retrieval
585 of a original record (i.e. when offset is specified). For binary
586 response the record by default is fetched from ZOOM C using
587 the "raw" option or by parameter nativesyntax if given.
597 search.pz2?session=605047297&command=record&id=3
605 The Puget Sound Region : a portfolio of thematic computer maps /
607 <md-date>1974</md-date>
608 <md-author>Mairs, John W.</md-author>
609 <md-subject>Cartography</md-subject>
615 <refsect2 id="command-termlist">
616 <title>termlist</title>
618 Retrieves term list(s). Parameters:
633 comma-separated list of termlist names. If omitted,
634 all termlists are returned.
642 maximum number of entries to return - default is 15.
651 search.pz2?session=2044502273&command=termlist&name=author,subject
656 <activeclients>3</activeclients>
659 <name>Donald Knuth</name>
660 <frequency>10</frequency>
663 <name>Robert Pirsig</name>
664 <frequency>2</frequency>
667 <list name="subject">
669 <name>Computer programming</name>
670 <frequency>10</frequency>
678 For the special termlist name "xtargets", results
679 are returned about the targets which have returned the most hits.
680 The 'term' subtree has additional elements,
681 specifically a state and diagnostic field (in the example below, a
682 target ID is returned in place of 'name'.
683 This may or may not change later.
689 <name>library2.mcmaster.ca</name>
690 <frequency>11734</frequency> -- Number of hits
691 <state>Client_Idle</state> -- See the description of 'bytarget' below
692 <diagnostic>0</diagnostic> -- Z39.50 diagnostic codes
699 <refsect2 id="command-bytarget">
700 <title>bytarget</title>
702 Returns information about the status of each active client. Parameters:
718 search.pz2?session=605047297&command=bytarget&id=3
727 <id>z3950.loc.gov/voyager/</id>
729 <diagnostic>0</diagnostic>
730 <records>65</records>
731 <state>Client_Presenting</state>
733 <!-- ... more target nodes below as necessary -->
737 The following client states are defined: Client_Connecting,
738 Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
739 Client_Searching, Client_Presenting, Client_Error, Client_Failed,
740 Client_Disconnected, Client_Stopped, Client_Continue.
746 <title>SEE ALSO</title>
750 <refentrytitle>pazpar2</refentrytitle>
751 <manvolnum>8</manvolnum>
755 Pazpar2 Configuration:
757 <refentrytitle>pazpar2_conf</refentrytitle>
758 <manvolnum>5</manvolnum>
764 <!-- Keep this comment at the end of the file