Axiell WebAPI home page > WebAPI > q

WebAPI Browser

q

Url request
Adlib.Data
jQuery

q provides a simple search command. You just need to provide the value to search.

Syntax

q=<value>&<parameter>=<value2>&...

database (String) database on which to perform the q= search.
value (String) the search value for which to return records. It depends on the truncation attribute of the <searchFields> node in the adlibweb.xml configuration file if explicit truncation, using an asterisk behind the search key, is required when you'd like to perform a truncated search.
facets (String) [optional] a comma-separated list of fields (their English names) or field tags to retrieve the facets (terms or names) from. The fields must have been indexed. This parameter is available from October 2016 for the search command and q= searches and provides the same functionality as the facets command with the important difference that the facets parameter allows the result of any search to include lists of retrieved facets, so that only a single search yields all required data to present a search result and multiple facet lists, whereas using the old facets command means having to perform a search to obtain a search result plus a facets search for every facet list you need.
id (String) [optional] <searchFields> id attribute if multiple <searchFields> specifications (available from October 2016) exist in the adlibweb.xml. Multiple <searchFields> sections, each with their own id, allow for different q= searches. In the call, just include the desired id to specify which <searchFields> specification you'd like to search, e.g.: q=horse&id=descriptions, if "descriptions" is the existing id of a <searchFields> section.

Description

Contrary to the search command, this simple search doesn't require you to put together an advanced search statement, just the value to search for (and the name of the desired database configuration) is enough. The WebAPI knows which indexed fields to search and if the search must be automatically truncated or not, by looking up the appropriate <searchFields> specification in adlibweb.xml. This simple search will search for the search key in all fields listed in the relevant section, with an implicit OR relation: a record will be included in the search result if the search key appears in at least one of the search fields.
It is also possible (from wwwopac.ashx version of October 2016) to specify multiple <searchFields> sections, each identifiable by an id, to allow for different q= searches.

Examples

Search the indexes of all fields listed in the <searchFields> section of the "collect.inf" database configuration in adlibweb.xml, for the truncated term "paint" and retrieve the relevant object records show
It depends on the truncation attribute of the <searchFields> node if explicit truncation, like in this example, is required when you'd like to perform a truncated search. The <searchFields> specification for "collect.inf" is as follows:
<searchFields truncation="false"> <field>object_number</field> <field>object_category</field> <field>title</field> <field>creator</field> <field>creator.role</field> </searchFields>
```
http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&q=paint*
```
run example select text