getpointerfile

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.
For more information about saved searches and SDI, see the Axiell Collections online Help.

Syntax

command=getpointerfile&<parameter>=<value>&...

• database (String) name of the database configuration from which to retrieve the metadata of a saved search. The name of this database table must have been specified in the adlibweb.xml file.
• number (Integer) number of the saved search to be retrieved. When a saved search is stored, for instance via an Axiell Collections application, the user has to assign it both a number and a title. It is the assigned number that you have to use here.
• output (String) [optional] output format to be returned. Values for 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.
  Read more about JSON output here.
• callback (String) [optional] returns JSON output wrapped in brackets with your callback function name, for AJAX requests: <callback function name>( <JSON output> ); You don't need to specify output=json, because the output format is JSON by default.
• xmltype (String) [optional] type of XML to be returned (only available value here: 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:

  • The root element is named adlibXML.
  • The pointer file is contained in a record element within a child element from the root with the name recordList.
  • The 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.
  • The saved search metadata is contained within the 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.
  Click here for more information about the structured XML type for saved searches.

Examples