Axiell WebAPI home page > WebAPI > searchpointerfiles

WebAPI Browser

searchpointerfiles

Url request
Adlib.Data
jQuery

Searchpointerfiles returns a list of metadata from selected saved searches (aka pointer files).

Syntax

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

database (String) database on which to perform the searchpointerfiles function. The name of this database must have been specified in the adlibweb.xml file.
statement (String) a search statement with the syntax: property=value. You can use each available saved search property (the column header in the SQL pointer files table), to filter the pointer files. See the figure below for a list of all saved search properties. You can use each of them to filter on. (A false property will generate an exception.) The value to search on can be truncated by placing an asterisk behind the value.
(Prior to wwwopac.ashx version 3.6.13106.1, a sql search statement with the saved search property, which would be added to the implicit sql where clause, had to be used. Because of the risk of abuse through so-called SQL injection, the search statement format has been changed to a non-sql format.)
limit (Integer) [optional] maximum amount of saved searches to return.
startfrom (Integer) [optional] the sequential number of the first saved search to return in the result (default 1).
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.

Description

The metadata returned per 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 date the saved search was modified, and possibly some SDI information if the saved search has been set up to be profiled (updated) automatically on a regular basis.
For more information about saved searches and SDI, see the Axiell Collections online Help.

Examples

List the metadata of the first 5 saved searches from collect.inf, made by Bert show

http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&command=searchpointerfiles&statement=owner=bert&limit=5

run example select text

List the metadata of the first 5 saved searches from collect.inf, skipping the first one, made by users whose name starts with 'be*' show
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&command=searchpointerfiles&statement=owner=be*&limit=5&startfrom=2
```
run example select text