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     </variablelist>
 423    </para>
 424    <para>
 425     Example:
 426     <screen><![CDATA[
 427 search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
 428 ]]></screen>
 429     Output:
 430     <screen><![CDATA[
 431 <show>
 432   <status>OK</status>
 433   <activeclients>3</activeclients>     -- How many clients are still working
 434   <merged>6</merged>                   -- Number of merged records
 435   <total>7</total>                     -- Total of all hitcounts
 436   <start>0</start>                     -- The start number you requested
 437   <num>2</num>                         -- Number of records retrieved
 438   <hit>
 439     <md-title>How to program a computer, by Jack Collins</md-title>
 440     <count>2</count>                   -- Number of merged records
 441     <recid>6</recid>                   -- Record ID for this record
 442   </hit>
 443   <hit>
 444     <md-title>
 445   Computer processing of dynamic images from an Anger scintillation camera :
 446   the proceedings of a workshop /
 447     </md-title>
 448     <recid>2</recid>
 449   </hit>
 450 </show>
 451      ]]></screen>
 452    </para>
 453   </refsect2>
 454
 455   <refsect2 id="command-record">
 456    <title>record</title>
 457    <para>
 458     Retrieves a detailed record. Unlike the
 459     <link linkend="command-show">show</link> command, this command
 460     returns metadata records before merging takes place. Parameters:
 461
 462     <variablelist>
 463      <varlistentry>
 464       <term>session</term>
 465       <listitem>
 466        <para>
 467         Session ID
 468        </para>
 469       </listitem>
 470      </varlistentry>
 471
 472      <varlistentry>
 473       <term>id</term>
 474       <listitem>
 475        <para>
 476         record ID as provided by the
 477         <link linkend="command-show">show</link> command.
 478         </para>
 479       </listitem>
 480      </varlistentry>
 481
 482      <varlistentry>
 483       <term>offset</term>
 484       <listitem>
 485        <para>
 486         This optional parameter is an integer which, when given, makes
 487         Pazpar2 return the original record for a specific target.
 488         The record set from first target is numbered 0,
 489         second record set is numbered 1, etc.
 490         The nativesyntax setting, as usual, is used to determine how to
 491         create XML from the original record - unless parameter
 492         <literal>binary</literal> is given in which the record is
 493         fetched as "raw" from ZOOM C (raw, original record).
 494        </para>
 495        <para>
 496         When offset/checksum is not given, the Pazpar2 metadata for the record
 497         is returned and with metadata for each targets' data specified
 498         in a 'location' list.
 499        </para>
 500       </listitem>
 501      </varlistentry>
 502
 503      <varlistentry>
 504       <term>checksum</term>
 505       <listitem>
 506        <para>
 507         This optional parameter is a string which, when given, makes
 508         Pazpar2 return the original record for a specific target. The
 509         checksum is returned as attribtue 'checksum' in element
 510         'location' for show command and record command (when checksum
 511         and offset is NOT given).
 512         The nativesyntax setting, as usual, is used to determine how to
 513         create XML from the original record - unless parameter
 514         <literal>binary</literal> is given in which the record is
 515         fetched as "raw" from ZOOM C (raw, original record).
 516        </para>
 517        <para>
 518         When offset/checksum is not given, the Pazpar2 metadata for the record
 519         is returned and with metadata for each targets' data specified
 520         in a 'location' list.
 521        </para>
 522       </listitem>
 523      </varlistentry>
 524
 525
 526      <varlistentry>
 527       <term>nativesyntax</term>
 528       <listitem>
 529        <para>
 530         This optional parameter can be used to override pz:nativesyntax
 531         as given for the target. This allow an alternative nativesyntax
 532         to be used for original records (see parameteroffset above).
 533        </para>
 534       </listitem>
 535      </varlistentry>
 536
 537      <varlistentry>
 538       <term>syntax</term>
 539       <listitem>
 540        <para>
 541         This optional parameter is the record syntax used for raw
 542         transfer (i.e. when offset is specified). If syntax is not given,
 543         but offset is used, the value of pz:requestsyntax is used.
 544        </para>
 545       </listitem>
 546      </varlistentry>
 547
 548      <varlistentry>
 549       <term>esn</term>
 550       <listitem>
 551        <para>
 552         This optional parameter is the element set name used to retrieval
 553         of a raw record (i.e. when offset is specified).
 554         If esn is not given, but offset is used, the value of pz:elements
 555         is used.
 556        </para>
 557       </listitem>
 558      </varlistentry>
 559
 560      <varlistentry>
 561       <term>binary</term>
 562       <listitem>
 563        <para>
 564         This optional parameter enables "binary" response for retrieval
 565         of a original record (i.e. when offset is specified). For binary
 566         response the record by default is fetched from ZOOM C using
 567         the "raw" option or by parameter nativesyntax if given.
 568        </para>
 569       </listitem>
 570      </varlistentry>
 571
 572     </variablelist>
 573    </para>
 574    <para>
 575     Example:
 576     <screen><![CDATA[
 577 search.pz2?session=605047297&command=record&id=3
 578 ]]></screen>
 579
 580     Example output:
 581
 582     <screen><![CDATA[
 583 <record>
 584   <md-title>
 585         The Puget Sound Region : a portfolio of thematic computer maps /
 586   </md-title>
 587   <md-date>1974</md-date>
 588   <md-author>Mairs, John W.</md-author>
 589   <md-subject>Cartography</md-subject>
 590 </record>
 591 ]]></screen>
 592    </para>
 593   </refsect2>
 594
 595   <refsect2 id="command-termlist">
 596    <title>termlist</title>
 597    <para>
 598     Retrieves term list(s). Parameters:
 599
 600     <variablelist>
 601      <varlistentry>
 602       <term>session</term>
 603       <listitem>
 604        <para>
 605         Session Id.
 606        </para>
 607       </listitem>
 608      </varlistentry>
 609      <varlistentry>
 610       <term>name</term>
 611       <listitem>
 612        <para>
 613         comma-separated list of termlist names. If omitted,
 614         all termlists are returned.
 615        </para>
 616       </listitem>
 617      </varlistentry>
 618      <varlistentry>
 619       <term>num</term>
 620       <listitem>
 621        <para>
 622         maximum number of entries to return - default is 15.
 623        </para>
 624       </listitem>
 625      </varlistentry>
 626     </variablelist>
 627    </para>
 628    <para>
 629     Example:
 630     <screen><![CDATA[
 631 search.pz2?session=2044502273&command=termlist&name=author,subject
 632 ]]></screen>
 633     Output:
 634     <screen><![CDATA[
 635 <termlist>
 636   <activeclients>3</activeclients>
 637   <list name="author">
 638     <term>
 639       <name>Donald Knuth</name>
 640       <frequency>10</frequency>
 641     </term>
 642       <term>
 643       <name>Robert Pirsig</name>
 644       <frequency>2</frequency>
 645     </term>
 646   </list>
 647   <list name="subject">
 648     <term>
 649       <name>Computer programming</name>
 650       <frequency>10</frequency>
 651     </term>
 652   </list>
 653 </termlist>
 654 ]]></screen>
 655    </para>
 656
 657    <para>
 658     For the special termlist name "xtargets", results
 659     are returned about the targets which have returned the most hits.
 660     The 'term' subtree has additional elements,
 661     specifically a state and diagnostic field (in the example below, a
 662     target ID is returned in place of 'name'.
 663     This may or may not change later.
 664    </para>
 665    <para>
 666     Example
 667     <screen><![CDATA[
 668 <term>
 669   <name>library2.mcmaster.ca</name>
 670   <frequency>11734</frequency>         -- Number of hits
 671   <state>Client_Idle</state>           -- See the description of 'bytarget' below
 672   <diagnostic>0</diagnostic>           -- Z39.50 diagnostic codes
 673 </term>
 674 ]]></screen>
 675    </para>
 676   </refsect2>
 677
 678
 679   <refsect2 id="command-bytarget">
 680    <title>bytarget</title>
 681    <para>
 682     Returns information about the status of each active client. Parameters:
 683
 684     <variablelist>
 685      <varlistentry>
 686       <term>session</term>
 687       <listitem>
 688        <para>
 689         Session Id.
 690         </para>
 691       </listitem>
 692      </varlistentry>
 693     </variablelist>
 694    </para>
 695    <para>
 696     Example:
 697     <screen><![CDATA[
 698 search.pz2?session=605047297&command=bytarget&id=3
 699 ]]></screen>
 700
 701     Example output:
 702
 703     <screen><![CDATA[
 704 <bytarget>
 705   <status>OK</status>
 706   <target>
 707     <id>z3950.loc.gov/voyager/</id>
 708     <hits>10000</hits>
 709     <diagnostic>0</diagnostic>
 710     <records>65</records>
 711     <state>Client_Presenting</state>
 712   </target>
 713   <!-- ... more target nodes below as necessary -->
 714 </bytarget>
 715 ]]></screen>
 716
 717     The following client states are defined: Client_Connecting,
 718     Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
 719     Client_Searching, Client_Presenting, Client_Error, Client_Failed,
 720     Client_Disconnected, Client_Stopped, Client_Continue.
 721    </para>
 722   </refsect2>
 723
 724  </refsect1>
 725  <refsect1>
 726   <title>SEE ALSO</title>
 727   <para>
 728    Pazpar2:
 729    <citerefentry>
 730     <refentrytitle>pazpar2</refentrytitle>
 731     <manvolnum>8</manvolnum>
 732    </citerefentry>
 733   </para>
 734   <para>
 735    Pazpar2 Configuration:
 736    <citerefentry>
 737     <refentrytitle>pazpar2_conf</refentrytitle>
 738     <manvolnum>5</manvolnum>
 739    </citerefentry>
 740   </para>
 741  </refsect1>
 742 </refentry>
 743
 744 <!-- Keep this comment at the end of the file
 745 Local variables:
 746 mode: nxml
 747 nxml-child-indent: 1
 748 End:
 749 -->