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' or '1', indicating whether results should be sorted in
352 increasing or decreasing order according to that field. 0==Decreasing is
354 Sort field names can be any field name designated as a sort field
355 in the pazpar2.cfg file, or the special names 'relevance' and
359 For targets where If <link linkend="pz:sortmap">pz:sortmap</link>
360 is defined, a sort operation will be executed (possibly including
361 extending the search).
371 search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
377 <activeclients>3</activeclients> -- How many clients are still working
378 <merged>6</merged> -- Number of merged records
379 <total>7</total> -- Total of all hitcounts
380 <start>0</start> -- The start number you requested
381 <num>2</num> -- Number of records retrieved
383 <md-title>How to program a computer, by Jack Collins</md-title>
384 <count>2</count> -- Number of merged records
385 <recid>6</recid> -- Record ID for this record
389 Computer processing of dynamic images from an Anger scintillation camera :
390 the proceedings of a workshop /
399 <refsect2 id="command-record">
400 <title>record</title>
402 Retrieves a detailed record. Unlike the
403 <link linkend="command-show">show</link> command, this command
404 returns metadata records before merging takes place. Parameters:
420 record ID as provided by the
421 <link linkend="command-show">show</link> command.
430 This optional parameter is an integer which, when given, makes
431 Pazpar2 return the original record for a specific target.
432 The record set from first target is numbered 0,
433 second record set is numbered 1, etc.
434 The nativesyntax setting, as usual, is used to determine how to
435 create XML from the original record - unless parameter
436 <literal>binary</literal> is given in which the record is
437 fetched as "raw" from ZOOM C (raw, original record).
440 When offset/checksum is not given, the Pazpar2 metadata for the record
441 is returned and with metadata for each targets' data specified
442 in a 'location' list.
448 <term>checksum</term>
451 This optional parameter is a string which, when given, makes
452 Pazpar2 return the original record for a specific target. The
453 checksum is returned as attribtue 'checksum' in element
454 'location' for show command and record command (when checksum
455 and offset is NOT given).
456 The nativesyntax setting, as usual, is used to determine how to
457 create XML from the original record - unless parameter
458 <literal>binary</literal> is given in which the record is
459 fetched as "raw" from ZOOM C (raw, original record).
462 When offset/checksum is not given, the Pazpar2 metadata for the record
463 is returned and with metadata for each targets' data specified
464 in a 'location' list.
471 <term>nativesyntax</term>
474 This optional parameter can be used to override pz:nativesyntax
475 as given for the target. This allow an alternative nativesyntax
476 to be used for original records (see parameteroffset above).
485 This optional parameter is the record syntax used for raw
486 transfer (i.e. when offset is specified). If syntax is not given,
487 but offset is used, the value of pz:requestsyntax is used.
496 This optional parameter is the element set name used to retrieval
497 of a raw record (i.e. when offset is specified).
498 If esn is not given, but offset is used, the value of pz:elements
508 This optional parameter enables "binary" response for retrieval
509 of a original record (i.e. when offset is specified). For binary
510 response the record by default is fetched from ZOOM C using
511 the "raw" option or by parameter nativesyntax if given.
521 search.pz2?session=605047297&command=record&id=3
529 The Puget Sound Region : a portfolio of thematic computer maps /
531 <md-date>1974</md-date>
532 <md-author>Mairs, John W.</md-author>
533 <md-subject>Cartography</md-subject>
539 <refsect2 id="command-termlist">
540 <title>termlist</title>
542 Retrieves term list(s). Parameters:
557 comma-separated list of termlist names. If omitted,
558 all termlists are returned.
566 maximum number of entries to return - default is 15.
575 search.pz2?session=2044502273&command=termlist&name=author,subject
580 <activeclients>3</activeclients>
583 <name>Donald Knuth</name>
584 <frequency>10</frequency>
587 <name>Robert Pirsig</name>
588 <frequency>2</frequency>
591 <list name="subject">
593 <name>Computer programming</name>
594 <frequency>10</frequency>
602 For the special termlist name "xtargets", results
603 are returned about the targets which have returned the most hits.
604 The 'term' subtree has additional elements,
605 specifically a state and diagnostic field (in the example below, a
606 target ID is returned in place of 'name'.
607 This may or may not change later.
613 <name>library2.mcmaster.ca</name>
614 <frequency>11734</frequency> -- Number of hits
615 <state>Client_Idle</state> -- See the description of 'bytarget' below
616 <diagnostic>0</diagnostic> -- Z39.50 diagnostic codes
623 <refsect2 id="command-bytarget">
624 <title>bytarget</title>
626 Returns information about the status of each active client. Parameters:
642 search.pz2?session=605047297&command=bytarget&id=3
651 <id>z3950.loc.gov/voyager/</id>
653 <diagnostic>0</diagnostic>
654 <records>65</records>
655 <state>Client_Presenting</state>
657 <!-- ... more target nodes below as necessary -->
661 The following client states are defined: Client_Connecting,
662 Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
663 Client_Searching, Client_Presenting, Client_Error, Client_Failed,
664 Client_Disconnected, Client_Stopped, Client_Continue.
670 <title>SEE ALSO</title>
674 <refentrytitle>pazpar2</refentrytitle>
675 <manvolnum>8</manvolnum>
679 Pazpar2 Configuration:
681 <refentrytitle>pazpar2_conf</refentrytitle>
682 <manvolnum>5</manvolnum>
688 <!-- Keep this comment at the end of the file