Getpointerfile returns metadata and a hit list of the requested saved search (aka pointer file), in Axiell AdlibXML format.
command=getpointerfile&<parameter>=<value>&...
output
can be either json
or xml
(xml
is the default, so you don't need to specify that explicitly). However, the output format produced by jQuery applications is always JSON, so you don't need to specify the output type there either.output=json
, because the output format is JSON by default.
structured
).
The Axiell WebAPI can return saved searches in two different XML formats: the implicit, default format and the 'structured' format. These formats have the following characteristics:
adlibXML
.
record
element within a child element from the root with the name recordList
.recordList
element is followed by a diagnostics
element, which contains meta information about the search, such as the number of records that were found and the xmltype used.record
element and by default comprises the title of the saved search, the number, the owner (the name of the user who created the saved search), a repeated hit
element containing the record numbers from this saved search, and possibly some SDI information and an accesslist
with user names and associated access rights. If xmltype=structured
has been specified, the repeated hit
element in the saved search metadata will be replaced by a hitlist
element containing repeated record
elements in which the priref
attribute indicates the record number. The advantage of the hitlist/record
node is that it may contain any xml you wish, allowing the creator of the saved search to add custom metadata about the saved search. Custom metadata can only be added via the WebAPI, not via the creation of saved searches in Collections applications.
The metadata returned for the requested saved search comprises the assigned saved search number, its title, the selection statement (an advanced search language statement or manual selection statement), the owner (creator of the saved search), the number of hits (records referred to in the saved search), the actual hits (record numbers), the date the saved search was created and modified, and possibly access rights details (user names and their access rights to this saved search as a number: 1 = none, 2 = read-only, 3 = write, 4 = full) and possibly some SDI information if the saved search has been set up to be rerun (profiled) automatically on a regular basis.
The creation date, the access rights details and the possibility for structured, custom metadata are present from version 6.6.0.[build unknown yet].
For more information about saved searches and SDI, see the Axiell Collections online Help.
Retrieve the metadata of saved search 3 from collect.inf show
Note that the syntax is different from search
commands.
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&command=getpointerfile&number=3
Retrieve the metadata of saved search 3 from collect.inf, in the structured XML type show
The difference with the default XML type is in the hit list. Click here for more information about the structured XML type for saved searches.
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&command=getpointerfile&number=3&xmltype=structured
- no Adlib.Data-specific description available yet; see the URL request tab for all information -
- no jQuery-specific description available yet; see the URL request tab for all information -