Axiell WebAPI home page > WebAPI > scan

WebAPI Browser

scan

Url request
Adlib.Data
jQuery

Scan returns a list of index keys starting from a given value.

Syntax

scan=<field name>&<parameter>=<value>&...

database (String) database on which to perform the scan function. The name of this database must have been specified in the adlibweb.xml file.
The scan command does not apply any stylesheet set in the configuration of the current database in adlibweb.xml
scanval (String) [optional] search value for which to return the keys.
limit (Integer) [optional] maximum amount of keys to return (default = 10).
startfrom (Integer) [optional] first key number to return in the result (default = 1: the first key number in an index is 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.
language (String) [optional] allows you to retrieve index keys from one particular data language: keys from other data languages, or without data language, will not be retrieved from the index. The data language is specified with a standard language code, without the square brackets around it. For instance: language=en-US.
Only if the indexed field is multilingual and actually contains multilingual data, will the index also contain multilingual values to retrieve. (Note that making an existing field multilingual, does not make all existing data in it multilingual.) If indexed values have no data language, then with scan these values can only be retrieved by not using the language argument.

Description

To retrieve a list of index keys, starting from a given value, use the scan command instead of search.
For more information about indexes, see the Axiell Designer Help.

Examples

Retrieve all keys (names) from the index on the creator field in collect.inf show
Note that the creator field is a linked field, linked on reference. Therefore, not the creator field itself has been indexed but the link reference field. To the scan command this makes no difference, as long as there is an associated index. Always enter the field (or tag) in which to search, not the index name.
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&scan=creator
```
run example select text
Retrieve all creator names from the letter 'r' onwards show
- no further description -
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&scan=creator&scanval=r
```
run example select text
Retrieve the first 3 creator names from the letter 'r' onwards show
- no further description -
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&scan=creator&scanval=r&limit=3
```
run example select text
Retrieve the first 3 creator names from the letter 'r' and then from the second creator onwards show
- no further description -
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&scan=creator&scanval=r&limit=3&startfrom=2
```
run example select text