projects
/
pazpar2-moved-to-github.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Document new setting icu_chain for service/server
[pazpar2-moved-to-github.git]
/
doc
/
pazpar2_protocol.xml
diff --git
a/doc/pazpar2_protocol.xml
b/doc/pazpar2_protocol.xml
index
b74e42b
..
d332a62
100644
(file)
--- a/
doc/pazpar2_protocol.xml
+++ b/
doc/pazpar2_protocol.xml
@@
-26,7
+26,8
@@
<refpurpose>The webservice protocol of Pazpar2</refpurpose>
</refnamediv>
<refpurpose>The webservice protocol of Pazpar2</refpurpose>
</refnamediv>
- <refsect1><title>DESCRIPTION</title>
+ <refsect1>
+ <title>DESCRIPTION</title>
<para>
Webservice requests are any that refer to filename "search.pz2". Arguments
are GET-style parameters. Argument 'command' is always required and specifies
<para>
Webservice requests are any that refer to filename "search.pz2". Arguments
are GET-style parameters. Argument 'command' is always required and specifies
@@
-34,13
+35,15
@@
request is forwarded to the HTTP server specified in the configuration
using the proxy setting.
This way, a regular webserver can host the user interface (itself dynamic
request is forwarded to the HTTP server specified in the configuration
using the proxy setting.
This way, a regular webserver can host the user interface (itself dynamic
- or static HTML), and Ajax-style calls can be used from JS (or any other client-based
- scripting environment) to interact with the search logic in Pazpar2.
+ or static HTML), and Ajax-style calls can be used from JS (or any other
+ client-based scripting environment) to interact with the search logic
+ in Pazpar2.
</para>
<para>
Each command is described in sub sections to follow.
</para>
</para>
<para>
Each command is described in sub sections to follow.
</para>
- <refsect2 id="command-init"><title>init</title>
+ <refsect2 id="command-init">
+ <title>init</title>
<para>
Initializes a session.
Returns session ID to be used in subsequent requests. If
<para>
Initializes a session.
Returns session ID to be used in subsequent requests. If
@@
-63,9
+66,9
@@
</init>
]]></screen>
<para>
</init>
]]></screen>
<para>
- The init command may take a number of setting parameters, similar to
- the 'settings' command described below. These settings are immediately
- applied to the new session. Other parameters for init are:
+ The init command may take a number of setting parameters, similar to
+ the 'settings' command described below. These settings are immediately
+ applied to the new session. Other parameters for init are:
<variablelist>
<varlistentry>
<term>clear</term>
<variablelist>
<varlistentry>
<term>clear</term>
@@
-92,7
+95,8
@@
</para>
</refsect2>
</para>
</refsect2>
- <refsect2 id="command-ping"><title>ping</title>
+ <refsect2 id="command-ping">
+ <title>ping</title>
<para>
Keeps a session alive. An idle session will time out after one minute.
The ping command can be used to keep the session alive absent other
<para>
Keeps a session alive. An idle session will time out after one minute.
The ping command can be used to keep the session alive absent other
@@
-145,7
+149,7
@@
<para>
Example:
<screen><![CDATA[
<para>
Example:
<screen><![CDATA[
- search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
+search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
]]></screen>
Response:
<screen><![CDATA[
]]></screen>
Response:
<screen><![CDATA[
@@
-153,13
+157,14
@@
<status>OK</status>
</settings>
]]></screen>
<status>OK</status>
</settings>
]]></screen>
- </para>
-
+ </para>
+
</refsect2>
</refsect2>
- <refsect2 id="command-search"><title>search</title>
+ <refsect2 id="command-search">
+ <title>search</title>
<para>
Launches a search, parameters:
<para>
Launches a search, parameters:
-
+
<variablelist>
<varlistentry>
<term>session</term>
<variablelist>
<varlistentry>
<term>session</term>
@@
-197,9
+202,12
@@
<term>limit</term>
<listitem>
<para>
<term>limit</term>
<listitem>
<para>
- Narrows the search by one or more facet fields. The limit is
- sequence of one or more field=value pairs separate by comma.
+ Narrows the search by one or more fields (typicall facets).
+ The limit is sequence of one or more field=value pairs separate
+ by comma.
A value that contains a comma should be escaped by backslash (\).
A value that contains a comma should be escaped by backslash (\).
+ The pz:fazetmap configuration item defines how the searches are
+ mapped to a database.
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
@@
-294,7
+302,7
@@
search.pz2?session=2044502273&command=stat
<listitem>
<para>
Session ID
<listitem>
<para>
Session ID
- </para>
+ </para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
@@
-318,8
+326,8
@@
search.pz2?session=2044502273&command=stat
<term>block</term>
<listitem>
<para>
<term>block</term>
<listitem>
<para>
- If block is set to 1, the command will hang until there are records ready
- to display. Use this to show first records rapidly without
+ If block is set to 1, the command will hang until there are records
+ ready to display. Use this to show first records rapidly without
requiring rapid polling.
</para>
</listitem>
requiring rapid polling.
</para>
</listitem>
@@
-334,7
+342,8
@@
search.pz2?session=2044502273&command=stat
field first. A sort field may be followed by a colon followed by
the number '0' or '1', indicating whether results should be sorted in
increasing or decreasing order according to that field. 0==Decreasing is
field first. A sort field may be followed by a colon followed by
the number '0' or '1', indicating whether results should be sorted in
increasing or decreasing order according to that field. 0==Decreasing is
- the default. Sort field names can be any field name designated as a sort field
+ the default.
+ Sort field names can be any field name designated as a sort field
in the pazpar2.cfg file, or the special name 'relevance'.
</para>
</listitem>
in the pazpar2.cfg file, or the special name 'relevance'.
</para>
</listitem>
@@
-379,7
+388,7
@@
search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
Retrieves a detailed record. Unlike the
<link linkend="command-show">show</link> command, this command
returns metadata records before merging takes place. Parameters:
Retrieves a detailed record. Unlike the
<link linkend="command-show">show</link> command, this command
returns metadata records before merging takes place. Parameters:
-
+
<variablelist>
<varlistentry>
<term>session</term>
<variablelist>
<varlistentry>
<term>session</term>
@@
-515,7
+524,7
@@
search.pz2?session=605047297&command=record&id=3
<screen><![CDATA[
search.pz2?session=2044502273&command=termlist&name=author,subject
]]></screen>
<screen><![CDATA[
search.pz2?session=2044502273&command=termlist&name=author,subject
]]></screen>
-Output:
+ Output:
<screen><![CDATA[
<termlist>
<activeclients>3</activeclients>
<screen><![CDATA[
<termlist>
<activeclients>3</activeclients>
@@
-537,8
+546,8
@@
Output:
</list>
</termlist>
]]></screen>
</list>
</termlist>
]]></screen>
- </para>
-
+ </para>
+
<para>
For the special termlist name "xtargets", results
are returned about the targets which have returned the most hits.
<para>
For the special termlist name "xtargets", results
are returned about the targets which have returned the most hits.
@@
-557,9
+566,9
@@
Output:
<diagnostic>0</diagnostic> -- Z39.50 diagnostic codes
</term>
]]></screen>
<diagnostic>0</diagnostic> -- Z39.50 diagnostic codes
</term>
]]></screen>
- </para>
+ </para>
</refsect2>
</refsect2>
-
+
<refsect2 id="command-bytarget">
<title>bytarget</title>
<refsect2 id="command-bytarget">
<title>bytarget</title>
@@
-582,7
+591,7
@@
Output:
<screen><![CDATA[
search.pz2?session=605047297&command=bytarget&id=3
]]></screen>
<screen><![CDATA[
search.pz2?session=605047297&command=bytarget&id=3
]]></screen>
-
+
Example output:
<screen><![CDATA[
Example output:
<screen><![CDATA[
@@
-607,7
+616,8
@@
search.pz2?session=605047297&command=bytarget&id=3
</refsect2>
</refsect1>
</refsect2>
</refsect1>
- <refsect1><title>SEE ALSO</title>
+ <refsect1>
+ <title>SEE ALSO</title>
<para>
Pazpar2:
<citerefentry>
<para>
Pazpar2:
<citerefentry>
@@
-627,15
+637,7
@@
search.pz2?session=605047297&command=bytarget&id=3
<!-- Keep this comment at the end of the file
Local variables:
<!-- Keep this comment at the end of the file
Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
End:
-->
End:
-->