X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=4c525fb38602c00ddf038524c93deeeb444fbfd4;hb=ed8400c109b2a440ed32e78368a554a35411e5b3;hp=e227354dfbed8e047f876bae6ec5863cb8dbb4ef;hpb=f1af7094481beba15c9ce3349095681db5981b28;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index e227354..4c525fb 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -107,7 +107,7 @@
-
+
ping
@@ -145,7 +145,7 @@
or possibly a wildcard, and value is the desired value for the
setting.
-
+
Because the settings command manipulates potentially sensitive
information, it is possible to configure Pazpar2 to only allow access
@@ -153,7 +153,7 @@
scripting, which in turn is responsible for authenticating the user,
and possibly determining which resources he has access to, etc.
-
+
As a shortcut, it is also possible to override settings directly in
@@ -181,7 +181,7 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
]]>
-
+
search
@@ -210,7 +210,7 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
Limits the search to a given set of targets specified by the
- filter. The filter consists a comma separated list of
+ filter. The filter consists of a comma separated list of
setting+operator+args
pairs. The setting is a Pazpar2 setting
(such as pz:id).
@@ -277,17 +277,60 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
'position'.
- If not specified here or as sort-default"
- in pazpar2.cfg, Pazpar2 will default to the built-in 'relevance' ranking.
+ If not specified here or as
+ sort-default"
+ in pazpar2.cfg, Pazpar2 will default to the built-in
+ 'relevance' ranking.
- Having sort criteria at search is important for targets that
- supports native sorting in order to get best results. Pazpar2
- will trigger a new search if search criteria changes from Pazpar2
+ Having sort criteria at search is important for targets that
+ supports native sorting in order to get best results. Pazpar2
+ will trigger a new search if search criteria changes from Pazpar2
to target-based sorting or visa-versa.
+
+
+ mergekey
+
+
+ Sets mergekey for this search and rest of session, or until
+ another mergekey is given for show/search. The mergekey value is a
+ comma separated list with one or more names as they appear
+ in the service description equivalent to
+ mergekey="optional" inside a metadata element.
+ If the empty string is given for mergekey it is disabled
+ and rest of session will use the default mergekey from service
+ or stylesheet.
+
+
+ This facility, "dynamic mergekey", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
+
+ rank
+
+
+ Sets rank method this search and rest of session, or until
+ another rank is given for show/search. The rank value is a
+ comma separated list of pairs field=value pairs. The
+ format is the same as
+ rank for a metadata element.
+ If the empty string is given for rank it is disabled
+ and rest of session will use the default rank from metadata or
+ stylesheet.
+
+
+ This facility, "dynamic ranking", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
@@ -305,7 +348,7 @@ search.pz2?session=2044502273&command=search&query=computer+science
]]>
-
+
stat
@@ -347,7 +390,7 @@ search.pz2?session=2044502273&command=stat
]]>
-
+
show
@@ -361,14 +404,14 @@ search.pz2?session=2044502273&command=stat
-
+
startFirst record to show - 0-indexed.
-
+
num
@@ -390,26 +433,6 @@ search.pz2?session=2044502273&command=stat
- mergekey
-
-
- Sets mergekey for this search and rest of session, or until
- another mergekey is given for show/search. The mergekey value is a
- comma separated list with one or more names as they appear
- in the service description equivalent to
- mergekey="optional" inside a metadata element.
- If the empty string is given for mergekey it is disabled
- and rest of session will use the default mergekey from service
- or stylesheet.
-
-
- This facility, "dynamic mergekey", appeared in Pazpar2 version
- 1.6.31.
-
-
-
-
- sort
@@ -421,15 +444,18 @@ search.pz2?session=2044502273&command=stat
Sort field names can be any field name designated as a sort field
in the pazpar2.cfg file, or the special names 'relevance' and
'position'.
-
- If not specified here or as sort-default"
- in pazpar2.cfg, pazpar2 will default to the built-in 'relevance' ranking.
-
- Having sort criteria at search is important for targets that
- supports native sorting in order to get best results. pazpar2
- will trigger a new search if search criteria changes from pazpar2
+
+
+ If not specified here or as
+ sort-default"
+ in pazpar2.cfg, pazpar2 will default to the built-in
+ 'relevance' ranking.
+
+
+ Having sort criteria at search is important for targets that
+ supports native sorting in order to get best results. pazpar2
+ will trigger a new search if search criteria changes from pazpar2
to target-based sorting.
-
For targets where If pz:sortmap
@@ -459,6 +485,40 @@ search.pz2?session=2044502273&command=stat
+
+ rank
+
+
+ Sets rank method this show and rest of session, or until
+ another rank is given for show/search. The rank value is a
+ comma separated list of pairs field=value pairs. The
+ format is the same as
+ rank for a metadata element.
+ If the empty string is given for rank it is disabled
+ and rest of session will use the default rank from metadata or
+ stylesheet.
+
+
+ This facility, "dynamic ranking", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
+
+ snippets
+
+
+ If specified and set to 1 data will include snippets marked
+ with <match> tags. Otherwise snippets will not be included.
+
+
+ This facility, "snippets", appeared in Pazpar2 version
+ 1.6.32.
+
+
+
+
@@ -477,7 +537,7 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
2 -- Number of records retrieved
How to program a computer, by Jack Collins
- 2 -- Number of merged records
+ 2 -- Number of merged records
6 -- Record ID for this record
@@ -495,10 +555,10 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
record
- Retrieves a detailed record. Unlike the
- show command, this command
+ Retrieves a detailed record. Unlike the
+ show command, this command
returns metadata records before merging takes place. Parameters:
-
+
session
@@ -578,7 +638,7 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
syntax
- This optional parameter is the record syntax used for raw
+ This optional parameter is the record syntax used for raw
transfer (i.e. when offset is specified). If syntax is not given,
but offset is used, the value of pz:requestsyntax is used.
@@ -609,16 +669,30 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
+
+ snippets
+
+
+ If specified and set to 1 data will include snippets marked
+ with <match> tags. Otherwise snippets will not be included.
+
+
+ This facility, "snippets", appeared in Pazpar2 version
+ 1.6.32.
+
+
+
+
-
+
Example:
Example output:
-
+
@@ -636,7 +710,7 @@ search.pz2?session=605047297&command=record&id=3
termlist
Retrieves term list(s). Parameters:
-
+
session
@@ -693,7 +767,7 @@ search.pz2?session=2044502273&command=termlist&name=author,subject
]]>
-
+
For the special termlist name "xtargets", results
are returned about the targets which have returned the most hits.
@@ -714,7 +788,7 @@ search.pz2?session=2044502273&command=termlist&name=author,subject
]]>
-
+
bytarget
@@ -732,14 +806,14 @@ search.pz2?session=2044502273&command=termlist&name=author,subject
-
+
Example:
-
+
Example output:
-
+
OK
@@ -753,7 +827,7 @@ search.pz2?session=605047297&command=bytarget&id=3
]]>
-
+
The following client states are defined: Client_Connecting,
Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
Client_Searching, Client_Presenting, Client_Error, Client_Failed,
@@ -761,6 +835,25 @@ search.pz2?session=605047297&command=bytarget&id=3
+
+ service
+
+ Returns service definition (XML). Parameters:
+
+
+ session
+
+
+ Session ID
+
+
+
+
+
+
+ The service command appeared in Pazpar2 version 1.6.32
+
+ SEE ALSO