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