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 period (.) and the server ID is appended to the session ID.
56 search.pz2?command=init
65 <session>2044502273</session>
69 The init command may take a number of setting parameters, similar to
70 the 'settings' command described below. These settings are immediately
71 applied to the new session. Other parameters for init are:
77 If this is defined and the value is non-zero, the session will
78 not use the predefined databases in the configuration; only those
79 specified in the settings parameters (per session databases).
88 If this is defined it specifies a service ID. Makes the session use
89 the service with this ID. If this is setting is omitted, the
90 session will use the unnamed service in the Pazpar2 configuration.
98 <refsect2 id="command-ping">
101 Keeps a session alive. An idle session will time out after one minute.
102 The ping command can be used to keep the session alive absent other
104 It is suggested that any browser client have a simple alarm handler which
105 sends a ping every 50 seconds or so once a session has been initialized.
110 search.pz?command=ping&session=2044502273
121 <refsect2 id="command-settings">
122 <title>settings</title>
124 The settings command applies session-specific settings to one or more
125 databases. A typical function of this is to enable access to
126 restricted resources for registered users, or to set a user- or
127 library-specific username/password to use against a target. Each
128 setting parameter has the form name[target]=value, where name is the
129 name of the setting (e.g. pz:authentication), target is a target ID,
130 or possibly a wildcard, and value is the desired value for the
135 Because the settings command manipulates potentially sensitive
136 information, it is possible to configure Pazpar2 to only allow access
137 to this command from a trusted site -- usually from server-side
138 scripting, which in turn is responsible for authenticating the user,
139 and possibly determining which resources he has access to, etc.
144 As a shortcut, it is also possible to override settings directly in
152 search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
163 <refsect2 id="command-search">
164 <title>search</title>
166 Launches a search, parameters:
189 Limits the search to a given set of targets specified by the
190 filter. The filter consists a comma separated list of
191 <emphasis>setting</emphasis>+<emphasis>operator</emphasis>+<emphasis>args</emphasis>
192 pairs. The <emphasis>setting</emphasis> is a Pazpar2 setting
193 (such as <literal>pz:id</literal>).
194 The <emphasis>operator</emphasis> is either
195 <literal>=</literal> (string match)
196 or <literal>~</literal> (substring match).
197 The <emphasis>args</emphasis> is a list of values separated
198 by <literal>|</literal> (or , one of the values).
199 The idea is that only targets with a setting matching one of
200 the values given will be included in the search.
208 Narrows the search by one or more fields (typically facets).
209 The limit is sequence of one or more
210 <emphasis>name</emphasis>=<emphasis>args</emphasis> pairs separated
211 by comma. The <emphasis>args</emphasis> is a list of values
212 separated by vertical bar (<literal>|</literal>).
213 The meaning of <literal>|</literal> is alternative, ie OR .
214 A value that contains a comma (<literal>,</literal>),
215 a vertical bar (<literal>|</literal>) or
216 backslash itself must be preceded by backslash (<literal>\</literal>).
217 The <link linkend="limitmap">pz:limitmap</link> configuration
218 item defines how the searches are mapped to a database.
223 <term>startrecs</term>
226 Specifies the first record to retrieve from each target.
227 The first record in a result set for a target is numbered 0, next
228 record is numbered 2. By default maxrecs is 0.
236 Specifies the maximum number of records to retrieve from each
237 target. The default value is 100. This setting has same meaning
238 as per-target setting pz:maxrecs . If pz:maxrecs is set, it takes
239 precedence over argument maxrecs.
249 search.pz2?session=2044502273&command=search&query=computer+science
261 <refsect2 id="command-stat">
264 Provides status information about an ongoing search. Parameters:
281 search.pz2?session=2044502273&command=stat
286 <activeclients>3</activeclients>
287 <hits>7</hits> -- Total hitcount
288 <records>7</records> -- Total number of records fetched in last query
289 <clients>1</clients> -- Total number of associated clients
290 <unconnected>0</unconnected> -- Number of disconnected clients
291 <connecting>0</connecting> -- Number of clients in connecting state
292 <initializing>0</initializing> -- Number of clients initializing
293 <searching>0</searching> -- ... searching
294 <presenting>0</presenting> -- ... presenting
295 <idle>1</idle> -- ... idle (not doing anything)
296 <failed>0</failed> -- ... Connection failed
297 <error>0</error> -- ... Error was produced somewhere
303 <refsect2 id="command-show">
306 Shows records retrieved. Parameters:
320 <para>First record to show - 0-indexed.</para>
328 Number of records to show If omitted, 20 is used.
337 If block is set to 1, the command will hang until there are records
338 ready to display. Use this to show first records rapidly without
339 requiring rapid polling.
348 Specifies sort criteria. The argument is a comma-separated list
349 (no whitespace allowed) of sort fields, with the highest-priority
350 field first. A sort field may be followed by a colon followed by
351 the number '0' (decreasing) or '1' (increasing). Default
352 sort order is decreasing.
353 Sort field names can be any field name designated as a sort field
354 in the pazpar2.cfg file, or the special names 'relevance' and
358 For targets where If <link linkend="pz:sortmap">pz:sortmap</link>
359 is defined, a sort operation will be executed (possibly including
360 extending the search).
370 search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
376 <activeclients>3</activeclients> -- How many clients are still working
377 <merged>6</merged> -- Number of merged records
378 <total>7</total> -- Total of all hitcounts
379 <start>0</start> -- The start number you requested
380 <num>2</num> -- Number of records retrieved
382 <md-title>How to program a computer, by Jack Collins</md-title>
383 <count>2</count> -- Number of merged records
384 <recid>6</recid> -- Record ID for this record
388 Computer processing of dynamic images from an Anger scintillation camera :
389 the proceedings of a workshop /
398 <refsect2 id="command-record">
399 <title>record</title>
401 Retrieves a detailed record. Unlike the
402 <link linkend="command-show">show</link> command, this command
403 returns metadata records before merging takes place. Parameters:
419 record ID as provided by the
420 <link linkend="command-show">show</link> command.
429 This optional parameter is an integer which, when given, makes
430 Pazpar2 return the original record for a specific target.
431 The record set from first target is numbered 0,
432 second record set is numbered 1, etc.
433 The nativesyntax setting, as usual, is used to determine how to
434 create XML from the original record - unless parameter
435 <literal>binary</literal> is given in which the record is
436 fetched as "raw" from ZOOM C (raw, original record).
439 When offset/checksum is not given, the Pazpar2 metadata for the record
440 is returned and with metadata for each targets' data specified
441 in a 'location' list.
447 <term>checksum</term>
450 This optional parameter is a string which, when given, makes
451 Pazpar2 return the original record for a specific target. The
452 checksum is returned as attribtue 'checksum' in element
453 'location' for show command and record command (when checksum
454 and offset is NOT given).
455 The nativesyntax setting, as usual, is used to determine how to
456 create XML from the original record - unless parameter
457 <literal>binary</literal> is given in which the record is
458 fetched as "raw" from ZOOM C (raw, original record).
461 When offset/checksum is not given, the Pazpar2 metadata for the record
462 is returned and with metadata for each targets' data specified
463 in a 'location' list.
470 <term>nativesyntax</term>
473 This optional parameter can be used to override pz:nativesyntax
474 as given for the target. This allow an alternative nativesyntax
475 to be used for original records (see parameteroffset above).
484 This optional parameter is the record syntax used for raw
485 transfer (i.e. when offset is specified). If syntax is not given,
486 but offset is used, the value of pz:requestsyntax is used.
495 This optional parameter is the element set name used to retrieval
496 of a raw record (i.e. when offset is specified).
497 If esn is not given, but offset is used, the value of pz:elements
507 This optional parameter enables "binary" response for retrieval
508 of a original record (i.e. when offset is specified). For binary
509 response the record by default is fetched from ZOOM C using
510 the "raw" option or by parameter nativesyntax if given.
520 search.pz2?session=605047297&command=record&id=3
528 The Puget Sound Region : a portfolio of thematic computer maps /
530 <md-date>1974</md-date>
531 <md-author>Mairs, John W.</md-author>
532 <md-subject>Cartography</md-subject>
538 <refsect2 id="command-termlist">
539 <title>termlist</title>
541 Retrieves term list(s). Parameters:
556 comma-separated list of termlist names. If omitted,
557 all termlists are returned.
565 maximum number of entries to return - default is 15.
574 search.pz2?session=2044502273&command=termlist&name=author,subject
579 <activeclients>3</activeclients>
582 <name>Donald Knuth</name>
583 <frequency>10</frequency>
586 <name>Robert Pirsig</name>
587 <frequency>2</frequency>
590 <list name="subject">
592 <name>Computer programming</name>
593 <frequency>10</frequency>
601 For the special termlist name "xtargets", results
602 are returned about the targets which have returned the most hits.
603 The 'term' subtree has additional elements,
604 specifically a state and diagnostic field (in the example below, a
605 target ID is returned in place of 'name'.
606 This may or may not change later.
612 <name>library2.mcmaster.ca</name>
613 <frequency>11734</frequency> -- Number of hits
614 <state>Client_Idle</state> -- See the description of 'bytarget' below
615 <diagnostic>0</diagnostic> -- Z39.50 diagnostic codes
622 <refsect2 id="command-bytarget">
623 <title>bytarget</title>
625 Returns information about the status of each active client. Parameters:
641 search.pz2?session=605047297&command=bytarget&id=3
650 <id>z3950.loc.gov/voyager/</id>
652 <diagnostic>0</diagnostic>
653 <records>65</records>
654 <state>Client_Presenting</state>
656 <!-- ... more target nodes below as necessary -->
660 The following client states are defined: Client_Connecting,
661 Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
662 Client_Searching, Client_Presenting, Client_Error, Client_Failed,
663 Client_Disconnected, Client_Stopped, Client_Continue.
669 <title>SEE ALSO</title>
673 <refentrytitle>pazpar2</refentrytitle>
674 <manvolnum>8</manvolnum>
678 Pazpar2 Configuration:
680 <refentrytitle>pazpar2_conf</refentrytitle>
681 <manvolnum>5</manvolnum>
687 <!-- Keep this comment at the end of the file