doc/pazpar2_protocol.xml

   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"
   4 [
   5      <!ENTITY % local SYSTEM "local.ent">
   6      %local;
   7      <!ENTITY % entities SYSTEM "entities.ent">
   8      %entities;
   9      <!ENTITY % idcommon SYSTEM "common/common.ent">
  10      %idcommon;
  11 ]>
  12 <refentry id="pazpar2_protocol">
  13  <refentryinfo>
  14   <productname>Pazpar2</productname>
  15   <productnumber>&version;</productnumber>
  16   <info><orgname>Index Data</orgname></info>
  17  </refentryinfo>
  18  <refmeta>
  19   <refentrytitle>Pazpar2 protocol</refentrytitle>
  20   <manvolnum>7</manvolnum>
  21   <refmiscinfo class="manual">Conventions and miscellaneous</refmiscinfo>
  22  </refmeta>
  23
  24  <refnamediv>
  25   <refname>pazpar2_protocol</refname>
  26   <refpurpose>The webservice protocol of Pazpar2</refpurpose>
  27  </refnamediv>
  28
  29  <refsect1>
  30   <title>DESCRIPTION</title>
  31   <para>
  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
  40    in Pazpar2.
  41   </para>
  42   <para>
  43    Each command is described in sub sections to follow.
  44   </para>
  45   <refsect2 id="command-init">
  46    <title>init</title>
  47    <para>
  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 (.).
  52    </para>
  53    <para>
  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.
  57    </para>
  58    <para>
  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.
  65    </para>
  66    <para>
  67     Example:
  68     <screen>
  69      search.pz2?command=init
  70     </screen>
  71    </para>
  72    <para>
  73     Response:
  74    </para>
  75    <screen><![CDATA[
  76     <init>
  77      <status>OK</status>
  78      <session>2044502273</session>
  79     </init>
  80 ]]></screen>
  81    <para>
  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:
  85     <variablelist>
  86      <varlistentry>
  87       <term>clear</term>
  88       <listitem>
  89        <para>
  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).
  93         </para>
  94       </listitem>
  95      </varlistentry>
  96
  97      <varlistentry>
  98       <term>service</term>
  99       <listitem>
 100        <para>
 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.
 104         </para>
 105       </listitem>
 106      </varlistentry>
 107     </variablelist>
 108    </para>
 109   </refsect2>
 110
 111   <refsect2 id="command-ping">
 112    <title>ping</title>
 113    <para>
 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
 116     activity.
 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.
 119    </para>
 120    <para>
 121     Example:
 122     <screen><![CDATA[
 123      search.pz?command=ping&session=2044502273
 124 ]]>
 125     </screen>
 126     Response:
 127    <screen><![CDATA[
 128 <ping>
 129   <status>OK</status>
 130 </ping>
 131 ]]></screen>
 132    </para>
 133   </refsect2>
 134   <refsect2 id="command-settings">
 135    <title>settings</title>
 136    <para>
 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.
 141    </para>
 142    <para>
 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
 146     setting.
 147    </para>
 148
 149    <para>
 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.
 155    </para>
 156
 157    <note>
 158     <para>
 159      As a shortcut, it is also possible to override settings directly in
 160      the init command.
 161     </para>
 162    </note>
 163
 164    <para>
 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.
 170    </para>
 171
 172    <para>
 173     Example:
 174     <screen><![CDATA[
 175 search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
 176       ]]></screen>
 177     Response:
 178    <screen><![CDATA[
 179 <settings>
 180   <status>OK</status>
 181 </settings>
 182 ]]></screen>
 183    </para>
 184
 185   </refsect2>
 186   <refsect2 id="command-search">
 187    <title>search</title>
 188    <para>
 189     Launches a search, parameters:
 190
 191     <variablelist>
 192      <varlistentry>
 193       <term>session</term>
 194       <listitem>
 195        <para>
 196         Session ID
 197         </para>
 198       </listitem>
 199      </varlistentry>
 200      <varlistentry>
 201       <term>query</term>
 202       <listitem>
 203        <para>
 204         CCL query
 205         </para>
 206       </listitem>
 207      </varlistentry>
 208      <varlistentry>
 209       <term>filter</term>
 210       <listitem>
 211        <para>
 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.
 224        </para>
 225       </listitem>
 226      </varlistentry>
 227      <varlistentry>
 228       <term>limit</term>
 229       <listitem>
 230        <para>
 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.
 242        </para>
 243       </listitem>
 244      </varlistentry>
 245      <varlistentry>
 246       <term>startrecs</term>
 247       <listitem>
 248        <para>
 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.
 252         </para>
 253       </listitem>
 254      </varlistentry>
 255      <varlistentry>
 256       <term>maxrecs</term>
 257       <listitem>
 258        <para>
 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.
 263         </para>
 264       </listitem>
 265      </varlistentry>
 266      <varlistentry>
 267       <term>sort</term>
 268       <listitem>
 269        <para>
 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
 277         'position'.
 278        </para>
 279        <para>
 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.
 282        </para>
 283        <para>
 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.
 288         </para>
 289       </listitem>
 290      </varlistentry>
 291     </variablelist>
 292
 293    </para>
 294    <para>
 295     Example:
 296     <screen><![CDATA[
 297 search.pz2?session=2044502273&command=search&query=computer+science
 298 ]]>
 299      </screen>
 300     Response:
 301    <screen><![CDATA[
 302 <search>
 303   <status>OK</status>
 304 </search>
 305      ]]></screen>
 306    </para>
 307   </refsect2>
 308
 309   <refsect2 id="command-stat">
 310    <title>stat</title>
 311    <para>
 312     Provides status information about an ongoing search. Parameters:
 313
 314     <variablelist>
 315      <varlistentry>
 316       <term>session</term>
 317       <listitem>
 318        <para>
 319         Session ID
 320         </para>
 321       </listitem>
 322      </varlistentry>
 323     </variablelist>
 324
 325    </para>
 326    <para>
 327     Example:
 328    <screen><![CDATA[
 329 search.pz2?session=2044502273&command=stat
 330     ]]></screen>
 331     Output
 332     <screen><![CDATA[
 333 <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
 346 </stat>
 347      ]]></screen>
 348   </para>
 349   </refsect2>
 350
 351   <refsect2 id="command-show">
 352    <title>show</title>
 353    <para>
 354     Shows records retrieved. Parameters:
 355     <variablelist>
 356      <varlistentry>
 357       <term>session</term>
 358       <listitem>
 359        <para>
 360         Session ID
 361        </para>
 362       </listitem>
 363      </varlistentry>
 364
 365      <varlistentry>
 366       <term>start</term>
 367       <listitem>
 368        <para>First record to show - 0-indexed.</para>
 369       </listitem>
 370      </varlistentry>
 371
 372      <varlistentry>
 373       <term>num</term>
 374       <listitem>
 375        <para>
 376         Number of records to show If omitted, 20 is used.
 377        </para>
 378       </listitem>
 379      </varlistentry>
 380
 381      <varlistentry>
 382       <term>block</term>
 383       <listitem>
 384        <para>
 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.
 388        </para>
 389       </listitem>
 390      </varlistentry>
 391
 392      <varlistentry>
 393       <term>sort</term>
 394       <listitem>
 395        <para>
 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
 403         'position'.
 404
 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.
 407
 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.
 412
 413        </para>
 414        <para>
 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).
 418        </para>
 419       </listitem>
 420      </varlistentry>
 421
 422      <varlistentry>
 423       <term>mergekey</term>
 424       <listitem>
 425        <para>
 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
 433         or stylesheet.
 434        </para>
 435        <para>
 436         This facility, "dynamic mergekey", appeared in Pazpar2 version
 437         1.6.31.
 438        </para>
 439       </listitem>
 440      </varlistentry>
 441
 442     </variablelist>
 443    </para>
 444    <para>
 445     Example:
 446     <screen><![CDATA[
 447 search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
 448 ]]></screen>
 449     Output:
 450     <screen><![CDATA[
 451 <show>
 452   <status>OK</status>
 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
 458   <hit>
 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
 462   </hit>
 463   <hit>
 464     <md-title>
 465   Computer processing of dynamic images from an Anger scintillation camera :
 466   the proceedings of a workshop /
 467     </md-title>
 468     <recid>2</recid>
 469   </hit>
 470 </show>
 471      ]]></screen>
 472    </para>
 473   </refsect2>
 474
 475   <refsect2 id="command-record">
 476    <title>record</title>
 477    <para>
 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:
 481
 482     <variablelist>
 483      <varlistentry>
 484       <term>session</term>
 485       <listitem>
 486        <para>
 487         Session ID
 488        </para>
 489       </listitem>
 490      </varlistentry>
 491
 492      <varlistentry>
 493       <term>id</term>
 494       <listitem>
 495        <para>
 496         record ID as provided by the
 497         <link linkend="command-show">show</link> command.
 498         </para>
 499       </listitem>
 500      </varlistentry>
 501
 502      <varlistentry>
 503       <term>offset</term>
 504       <listitem>
 505        <para>
 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).
 514        </para>
 515        <para>
 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.
 519        </para>
 520       </listitem>
 521      </varlistentry>
 522
 523      <varlistentry>
 524       <term>checksum</term>
 525       <listitem>
 526        <para>
 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).
 536        </para>
 537        <para>
 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.
 541        </para>
 542       </listitem>
 543      </varlistentry>
 544
 545
 546      <varlistentry>
 547       <term>nativesyntax</term>
 548       <listitem>
 549        <para>
 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).
 553        </para>
 554       </listitem>
 555      </varlistentry>
 556
 557      <varlistentry>
 558       <term>syntax</term>
 559       <listitem>
 560        <para>
 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.
 564        </para>
 565       </listitem>
 566      </varlistentry>
 567
 568      <varlistentry>
 569       <term>esn</term>
 570       <listitem>
 571        <para>
 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
 575         is used.
 576        </para>
 577       </listitem>
 578      </varlistentry>
 579
 580      <varlistentry>
 581       <term>binary</term>
 582       <listitem>
 583        <para>
 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.
 588        </para>
 589       </listitem>
 590      </varlistentry>
 591
 592     </variablelist>
 593    </para>
 594    <para>
 595     Example:
 596     <screen><![CDATA[
 597 search.pz2?session=605047297&command=record&id=3
 598 ]]></screen>
 599
 600     Example output:
 601
 602     <screen><![CDATA[
 603 <record>
 604   <md-title>
 605         The Puget Sound Region : a portfolio of thematic computer maps /
 606   </md-title>
 607   <md-date>1974</md-date>
 608   <md-author>Mairs, John W.</md-author>
 609   <md-subject>Cartography</md-subject>
 610 </record>
 611 ]]></screen>
 612    </para>
 613   </refsect2>
 614
 615   <refsect2 id="command-termlist">
 616    <title>termlist</title>
 617    <para>
 618     Retrieves term list(s). Parameters:
 619
 620     <variablelist>
 621      <varlistentry>
 622       <term>session</term>
 623       <listitem>
 624        <para>
 625         Session Id.
 626        </para>
 627       </listitem>
 628      </varlistentry>
 629      <varlistentry>
 630       <term>name</term>
 631       <listitem>
 632        <para>
 633         comma-separated list of termlist names. If omitted,
 634         all termlists are returned.
 635        </para>
 636       </listitem>
 637      </varlistentry>
 638      <varlistentry>
 639       <term>num</term>
 640       <listitem>
 641        <para>
 642         maximum number of entries to return - default is 15.
 643        </para>
 644       </listitem>
 645      </varlistentry>
 646     </variablelist>
 647    </para>
 648    <para>
 649     Example:
 650     <screen><![CDATA[
 651 search.pz2?session=2044502273&command=termlist&name=author,subject
 652 ]]></screen>
 653     Output:
 654     <screen><![CDATA[
 655 <termlist>
 656   <activeclients>3</activeclients>
 657   <list name="author">
 658     <term>
 659       <name>Donald Knuth</name>
 660       <frequency>10</frequency>
 661     </term>
 662       <term>
 663       <name>Robert Pirsig</name>
 664       <frequency>2</frequency>
 665     </term>
 666   </list>
 667   <list name="subject">
 668     <term>
 669       <name>Computer programming</name>
 670       <frequency>10</frequency>
 671     </term>
 672   </list>
 673 </termlist>
 674 ]]></screen>
 675    </para>
 676
 677    <para>
 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.
 684    </para>
 685    <para>
 686     Example
 687     <screen><![CDATA[
 688 <term>
 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
 693 </term>
 694 ]]></screen>
 695    </para>
 696   </refsect2>
 697
 698
 699   <refsect2 id="command-bytarget">
 700    <title>bytarget</title>
 701    <para>
 702     Returns information about the status of each active client. Parameters:
 703
 704     <variablelist>
 705      <varlistentry>
 706       <term>session</term>
 707       <listitem>
 708        <para>
 709         Session Id.
 710         </para>
 711       </listitem>
 712      </varlistentry>
 713     </variablelist>
 714    </para>
 715    <para>
 716     Example:
 717     <screen><![CDATA[
 718 search.pz2?session=605047297&command=bytarget&id=3
 719 ]]></screen>
 720
 721     Example output:
 722
 723     <screen><![CDATA[
 724 <bytarget>
 725   <status>OK</status>
 726   <target>
 727     <id>z3950.loc.gov/voyager/</id>
 728     <hits>10000</hits>
 729     <diagnostic>0</diagnostic>
 730     <records>65</records>
 731     <state>Client_Presenting</state>
 732   </target>
 733   <!-- ... more target nodes below as necessary -->
 734 </bytarget>
 735 ]]></screen>
 736
 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.
 741    </para>
 742   </refsect2>
 743
 744  </refsect1>
 745  <refsect1>
 746   <title>SEE ALSO</title>
 747   <para>
 748    Pazpar2:
 749    <citerefentry>
 750     <refentrytitle>pazpar2</refentrytitle>
 751     <manvolnum>8</manvolnum>
 752    </citerefentry>
 753   </para>
 754   <para>
 755    Pazpar2 Configuration:
 756    <citerefentry>
 757     <refentrytitle>pazpar2_conf</refentrytitle>
 758     <manvolnum>5</manvolnum>
 759    </citerefentry>
 760   </para>
 761  </refsect1>
 762 </refentry>
 763
 764 <!-- Keep this comment at the end of the file
 765 Local variables:
 766 mode: nxml
 767 nxml-child-indent: 1
 768 End:
 769 -->