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 of 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
 281         <link linkend="sort-default">sort-default"</link>
 282         in pazpar2.cfg, Pazpar2 will default to the built-in
 283         'relevance' ranking.
 284        </para>
 285        <para>
 286         Having sort criteria at search is important for targets that
 287         supports native sorting in order to get best results. Pazpar2
 288         will trigger a new search if search criteria changes from Pazpar2
 289         to target-based sorting or visa-versa.
 290         </para>
 291       </listitem>
 292      </varlistentry>
 293
 294      <varlistentry>
 295       <term>mergekey</term>
 296       <listitem>
 297        <para>
 298         Sets mergekey for this search and rest of session, or until
 299         another mergekey is given for show/search. The mergekey value is a
 300         comma separated list with one or more names as they appear
 301         in the service description  equivalent to
 302         <literal>mergekey="optional"</literal> inside a metadata element.
 303         If the empty string is given for mergekey it is disabled
 304         and rest of session will use the default mergekey from service
 305         or stylesheet.
 306        </para>
 307        <para>
 308         This facility, "dynamic mergekey", appeared in Pazpar2 version
 309         1.6.31.
 310        </para>
 311       </listitem>
 312      </varlistentry>
 313
 314      <varlistentry>
 315       <term>rank</term>
 316       <listitem>
 317        <para>
 318         Sets rank method this search and rest of session, or until
 319         another rank is given for show/search. The rank value is a
 320         comma separated list of pairs field=value pairs. The
 321         format is the same as
 322         <xref linkend="metadata-rank">rank</xref> for a metadata element.
 323         If the empty string is given for rank it is disabled
 324         and rest of session will use the default rank from metadata or
 325         stylesheet.
 326        </para>
 327        <para>
 328         This facility, "dynamic ranking", appeared in Pazpar2 version
 329         1.6.31.
 330        </para>
 331       </listitem>
 332      </varlistentry>
 333
 334     </variablelist>
 335
 336    </para>
 337    <para>
 338     Example:
 339     <screen><![CDATA[
 340 search.pz2?session=2044502273&command=search&query=computer+science
 341 ]]>
 342      </screen>
 343     Response:
 344    <screen><![CDATA[
 345 <search>
 346   <status>OK</status>
 347 </search>
 348      ]]></screen>
 349    </para>
 350   </refsect2>
 351
 352   <refsect2 id="command-stat">
 353    <title>stat</title>
 354    <para>
 355     Provides status information about an ongoing search. Parameters:
 356
 357     <variablelist>
 358      <varlistentry>
 359       <term>session</term>
 360       <listitem>
 361        <para>
 362         Session ID
 363         </para>
 364       </listitem>
 365      </varlistentry>
 366     </variablelist>
 367
 368    </para>
 369    <para>
 370     Example:
 371    <screen><![CDATA[
 372 search.pz2?session=2044502273&command=stat
 373     ]]></screen>
 374     Output
 375     <screen><![CDATA[
 376 <stat>
 377   <activeclients>3</activeclients>
 378   <hits>7</hits>                   -- Total hitcount
 379   <records>7</records>             -- Total number of records fetched in last query
 380   <clients>1</clients>             -- Total number of associated clients
 381   <unconnected>0</unconnected>     -- Number of disconnected clients
 382   <connecting>0</connecting>       -- Number of clients in connecting state
 383   <initializing>0</initializing>   -- Number of clients initializing
 384   <searching>0</searching>         -- ... searching
 385   <presenting>0</presenting>       -- ... presenting
 386   <idle>1</idle>                   -- ... idle (not doing anything)
 387   <failed>0</failed>               -- ... Connection failed
 388   <error>0</error>                 -- ... Error was produced somewhere
 389 </stat>
 390      ]]></screen>
 391   </para>
 392   </refsect2>
 393
 394   <refsect2 id="command-show">
 395    <title>show</title>
 396    <para>
 397     Shows records retrieved. Parameters:
 398     <variablelist>
 399      <varlistentry>
 400       <term>session</term>
 401       <listitem>
 402        <para>
 403         Session ID
 404        </para>
 405       </listitem>
 406      </varlistentry>
 407
 408      <varlistentry>
 409       <term>start</term>
 410       <listitem>
 411        <para>First record to show - 0-indexed.</para>
 412       </listitem>
 413      </varlistentry>
 414
 415      <varlistentry>
 416       <term>num</term>
 417       <listitem>
 418        <para>
 419         Number of records to show If omitted, 20 is used.
 420        </para>
 421       </listitem>
 422      </varlistentry>
 423
 424      <varlistentry>
 425       <term>block</term>
 426       <listitem>
 427        <para>
 428         If block is set to 1, the command will hang until there are records
 429         ready to display. Use this to show first records rapidly without
 430         requiring rapid polling.
 431        </para>
 432       </listitem>
 433      </varlistentry>
 434
 435      <varlistentry>
 436       <term>sort</term>
 437       <listitem>
 438        <para>
 439         Specifies sort criteria. The argument is a comma-separated list
 440         (no whitespace allowed) of sort fields, with the highest-priority
 441         field first. A sort field may be followed by a colon followed by
 442         the number '0' (decreasing) or '1' (increasing).  Default
 443         sort order is decreasing.
 444         Sort field names can be any field name designated as a sort field
 445         in the pazpar2.cfg file, or the special names 'relevance' and
 446         'position'.
 447        </para>
 448        <para>
 449         If not specified here or as
 450         <link linkend="sort-default">sort-default"</link>
 451         in pazpar2.cfg, pazpar2 will default to the built-in
 452         'relevance' ranking.
 453        </para>
 454        <para>
 455         Having sort criteria at search is important for targets that
 456         supports native sorting in order to get best results. pazpar2
 457         will trigger a new search if search criteria changes from pazpar2
 458         to target-based sorting.
 459        </para>
 460        <para>
 461         For targets where If <link linkend="pzsortmap">pz:sortmap</link>
 462         is defined, a sort operation will be executed (possibly including
 463         extending the search).
 464        </para>
 465       </listitem>
 466      </varlistentry>
 467
 468      <varlistentry>
 469       <term>mergekey</term>
 470       <listitem>
 471        <para>
 472         Sets mergekey for this show and rest of session, or until
 473         another mergekey is given for show/search. The mergekey value is a
 474         comma separated list with one or more names as they appear
 475         in the service description  equivalent to
 476         <literal>mergekey="optional"</literal> inside a metadata element.
 477         If the empty string is given for mergekey it is disabled
 478         and rest of session will use the default mergekey from service
 479         or stylesheet.
 480        </para>
 481        <para>
 482         This facility, "dynamic mergekey", appeared in Pazpar2 version
 483         1.6.31.
 484        </para>
 485       </listitem>
 486      </varlistentry>
 487
 488      <varlistentry>
 489       <term>rank</term>
 490       <listitem>
 491        <para>
 492         Sets rank method this show and rest of session, or until
 493         another rank is given for show/search. The rank value is a
 494         comma separated list of pairs field=value pairs. The
 495         format is the same as
 496         <xref linkend="metadata-rank">rank</xref> for a metadata element.
 497         If the empty string is given for rank it is disabled
 498         and rest of session will use the default rank from metadata or
 499         stylesheet.
 500        </para>
 501        <para>
 502         This facility, "dynamic ranking", appeared in Pazpar2 version
 503         1.6.31.
 504        </para>
 505       </listitem>
 506      </varlistentry>
 507
 508      <varlistentry>
 509       <term>snippets</term>
 510       <listitem>
 511        <para>
 512         If specified and set to 1 data will include snippets marked
 513         with &lt;match&gt; tags. Otherwise snippets will not be included.
 514        </para>
 515        <para>
 516         This facility, "snippets", appeared in Pazpar2 version
 517         1.6.32.
 518        </para>
 519       </listitem>
 520      </varlistentry>
 521
 522     </variablelist>
 523    </para>
 524    <para>
 525     Example:
 526     <screen><![CDATA[
 527 search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
 528 ]]></screen>
 529     Output:
 530     <screen><![CDATA[
 531 <show>
 532   <status>OK</status>
 533   <activeclients>3</activeclients>     -- How many clients are still working
 534   <merged>6</merged>                   -- Number of merged records
 535   <total>7</total>                     -- Total of all hitcounts
 536   <start>0</start>                     -- The start number you requested
 537   <num>2</num>                         -- Number of records retrieved
 538   <hit>
 539     <md-title>How to program a computer, by Jack Collins</md-title>
 540     <count>2</count>                   -- Number of merged records
 541     <recid>6</recid>                   -- Record ID for this record
 542   </hit>
 543   <hit>
 544     <md-title>
 545   Computer processing of dynamic images from an Anger scintillation camera :
 546   the proceedings of a workshop /
 547     </md-title>
 548     <recid>2</recid>
 549   </hit>
 550 </show>
 551      ]]></screen>
 552    </para>
 553   </refsect2>
 554
 555   <refsect2 id="command-record">
 556    <title>record</title>
 557    <para>
 558     Retrieves a detailed record. Unlike the
 559     <link linkend="command-show">show</link> command, this command
 560     returns metadata records before merging takes place. Parameters:
 561
 562     <variablelist>
 563      <varlistentry>
 564       <term>session</term>
 565       <listitem>
 566        <para>
 567         Session ID
 568        </para>
 569       </listitem>
 570      </varlistentry>
 571
 572      <varlistentry>
 573       <term>id</term>
 574       <listitem>
 575        <para>
 576         record ID as provided by the
 577         <link linkend="command-show">show</link> command.
 578         </para>
 579       </listitem>
 580      </varlistentry>
 581
 582      <varlistentry>
 583       <term>offset</term>
 584       <listitem>
 585        <para>
 586         This optional parameter is an integer which, when given, makes
 587         Pazpar2 return the original record for a specific target.
 588         The record set from first target is numbered 0,
 589         second record set is numbered 1, etc.
 590         The nativesyntax setting, as usual, is used to determine how to
 591         create XML from the original record - unless parameter
 592         <literal>binary</literal> is given in which the record is
 593         fetched as "raw" from ZOOM C (raw, original record).
 594        </para>
 595        <para>
 596         When offset/checksum is not given, the Pazpar2 metadata for the record
 597         is returned and with metadata for each targets' data specified
 598         in a 'location' list.
 599        </para>
 600       </listitem>
 601      </varlistentry>
 602
 603      <varlistentry>
 604       <term>checksum</term>
 605       <listitem>
 606        <para>
 607         This optional parameter is a string which, when given, makes
 608         Pazpar2 return the original record for a specific target. The
 609         checksum is returned as attribtue 'checksum' in element
 610         'location' for show command and record command (when checksum
 611         and offset is NOT given).
 612         The nativesyntax setting, as usual, is used to determine how to
 613         create XML from the original record - unless parameter
 614         <literal>binary</literal> is given in which the record is
 615         fetched as "raw" from ZOOM C (raw, original record).
 616        </para>
 617        <para>
 618         When offset/checksum is not given, the Pazpar2 metadata for the record
 619         is returned and with metadata for each targets' data specified
 620         in a 'location' list.
 621        </para>
 622       </listitem>
 623      </varlistentry>
 624
 625
 626      <varlistentry>
 627       <term>nativesyntax</term>
 628       <listitem>
 629        <para>
 630         This optional parameter can be used to override pz:nativesyntax
 631         as given for the target. This allow an alternative nativesyntax
 632         to be used for original records (see parameteroffset above).
 633        </para>
 634       </listitem>
 635      </varlistentry>
 636
 637      <varlistentry>
 638       <term>syntax</term>
 639       <listitem>
 640        <para>
 641         This optional parameter is the record syntax used for raw
 642         transfer (i.e. when offset is specified). If syntax is not given,
 643         but offset is used, the value of pz:requestsyntax is used.
 644        </para>
 645       </listitem>
 646      </varlistentry>
 647
 648      <varlistentry>
 649       <term>esn</term>
 650       <listitem>
 651        <para>
 652         This optional parameter is the element set name used to retrieval
 653         of a raw record (i.e. when offset is specified).
 654         If esn is not given, but offset is used, the value of pz:elements
 655         is used.
 656        </para>
 657       </listitem>
 658      </varlistentry>
 659
 660      <varlistentry>
 661       <term>binary</term>
 662       <listitem>
 663        <para>
 664         This optional parameter enables "binary" response for retrieval
 665         of a original record (i.e. when offset is specified). For binary
 666         response the record by default is fetched from ZOOM C using
 667         the "raw" option or by parameter nativesyntax if given.
 668        </para>
 669       </listitem>
 670      </varlistentry>
 671
 672      <varlistentry>
 673       <term>snippets</term>
 674       <listitem>
 675        <para>
 676         If specified and set to 1 data will include snippets marked
 677         with &lt;match&gt; tags. Otherwise snippets will not be included.
 678        </para>
 679        <para>
 680         This facility, "snippets", appeared in Pazpar2 version
 681         1.6.32.
 682        </para>
 683       </listitem>
 684      </varlistentry>
 685
 686     </variablelist>
 687    </para>
 688    <para>
 689     Example:
 690     <screen><![CDATA[
 691 search.pz2?session=605047297&command=record&id=3
 692 ]]></screen>
 693
 694     Example output:
 695
 696     <screen><![CDATA[
 697 <record>
 698   <md-title>
 699         The Puget Sound Region : a portfolio of thematic computer maps /
 700   </md-title>
 701   <md-date>1974</md-date>
 702   <md-author>Mairs, John W.</md-author>
 703   <md-subject>Cartography</md-subject>
 704 </record>
 705 ]]></screen>
 706    </para>
 707   </refsect2>
 708
 709   <refsect2 id="command-termlist">
 710    <title>termlist</title>
 711    <para>
 712     Retrieves term list(s). Parameters:
 713
 714     <variablelist>
 715      <varlistentry>
 716       <term>session</term>
 717       <listitem>
 718        <para>
 719         Session Id.
 720        </para>
 721       </listitem>
 722      </varlistentry>
 723      <varlistentry>
 724       <term>name</term>
 725       <listitem>
 726        <para>
 727         comma-separated list of termlist names. If omitted,
 728         all termlists are returned.
 729        </para>
 730       </listitem>
 731      </varlistentry>
 732      <varlistentry>
 733       <term>num</term>
 734       <listitem>
 735        <para>
 736         maximum number of entries to return - default is 15.
 737        </para>
 738       </listitem>
 739      </varlistentry>
 740     </variablelist>
 741    </para>
 742    <para>
 743     Example:
 744     <screen><![CDATA[
 745 search.pz2?session=2044502273&command=termlist&name=author,subject
 746 ]]></screen>
 747     Output:
 748     <screen><![CDATA[
 749 <termlist>
 750   <activeclients>3</activeclients>
 751   <list name="author">
 752     <term>
 753       <name>Donald Knuth</name>
 754       <frequency>10</frequency>
 755     </term>
 756       <term>
 757       <name>Robert Pirsig</name>
 758       <frequency>2</frequency>
 759     </term>
 760   </list>
 761   <list name="subject">
 762     <term>
 763       <name>Computer programming</name>
 764       <frequency>10</frequency>
 765     </term>
 766   </list>
 767 </termlist>
 768 ]]></screen>
 769    </para>
 770
 771    <para>
 772     For the special termlist name "xtargets", results
 773     are returned about the targets which have returned the most hits.
 774     The 'term' subtree has additional elements,
 775     specifically a state and diagnostic field (in the example below, a
 776     target ID is returned in place of 'name'.
 777     This may or may not change later.
 778    </para>
 779    <para>
 780     Example
 781     <screen><![CDATA[
 782 <term>
 783   <name>library2.mcmaster.ca</name>
 784   <frequency>11734</frequency>         -- Number of hits
 785   <state>Client_Idle</state>           -- See the description of 'bytarget' below
 786   <diagnostic>0</diagnostic>           -- Z39.50 diagnostic codes
 787 </term>
 788 ]]></screen>
 789    </para>
 790   </refsect2>
 791
 792
 793   <refsect2 id="command-bytarget">
 794    <title>bytarget</title>
 795    <para>
 796     Returns information about the status of each active client. Parameters:
 797
 798     <variablelist>
 799      <varlistentry>
 800       <term>session</term>
 801       <listitem>
 802        <para>
 803         Session Id.
 804         </para>
 805       </listitem>
 806      </varlistentry>
 807     </variablelist>
 808    </para>
 809    <para>
 810     Example:
 811     <screen><![CDATA[
 812 search.pz2?session=605047297&command=bytarget&id=3
 813 ]]></screen>
 814
 815     Example output:
 816
 817     <screen><![CDATA[
 818 <bytarget>
 819   <status>OK</status>
 820   <target>
 821     <id>z3950.loc.gov/voyager/</id>
 822     <hits>10000</hits>
 823     <diagnostic>0</diagnostic>
 824     <records>65</records>
 825     <state>Client_Presenting</state>
 826   </target>
 827   <!-- ... more target nodes below as necessary -->
 828 </bytarget>
 829 ]]></screen>
 830
 831     The following client states are defined: Client_Connecting,
 832     Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
 833     Client_Searching, Client_Presenting, Client_Error, Client_Failed,
 834     Client_Disconnected, Client_Stopped, Client_Continue.
 835    </para>
 836   </refsect2>
 837
 838   <refsect2 id="command-service">
 839    <title>service</title>
 840    <para>
 841     Returns service definition (XML). Parameters:
 842     <variablelist>
 843      <varlistentry>
 844       <term>session</term>
 845       <listitem>
 846        <para>
 847         Session ID
 848         </para>
 849       </listitem>
 850      </varlistentry>
 851     </variablelist>
 852    </para>
 853    <para>
 854     The service command appeared in Pazpar2 version 1.6.32
 855    </para>
 856   </refsect2>
 857  </refsect1>
 858  <refsect1>
 859   <title>SEE ALSO</title>
 860   <para>
 861    Pazpar2:
 862    <citerefentry>
 863     <refentrytitle>pazpar2</refentrytitle>
 864     <manvolnum>8</manvolnum>
 865    </citerefentry>
 866   </para>
 867   <para>
 868    Pazpar2 Configuration:
 869    <citerefentry>
 870     <refentrytitle>pazpar2_conf</refentrytitle>
 871     <manvolnum>5</manvolnum>
 872    </citerefentry>
 873   </para>
 874  </refsect1>
 875 </refentry>
 876
 877 <!-- Keep this comment at the end of the file
 878 Local variables:
 879 mode: nxml
 880 nxml-child-indent: 1
 881 End:
 882 -->