suggest
Suggest returns a list of keys from one or more indexed fields listed in an adlibweb.xml <searchFields> specification, which contain the (partial) word you provided as the search key.
Syntax
suggest=<value>&<parameter>=<value2>&...
-
database
(String)
database on which to perform the suggest function.
-
value
(String)
the search value for which to return the keys
-
limit
(Integer)
[optional] maximum amount of keys to return (default = 10).
-
id
(String)
[optional]
<searchFields> id attribute if multiple <searchfields> specifications (intended for q= searching) exist in adlibweb.xml.
-
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.
The advantage of JSON for this particular function is that it contains information about the formatting of the contained data in "spans" nodes: the "attributes" metadata contains either the value 1 (for bold layout), 2 (for italics) or 3 (for both bold and italics formatting). Only bold layout is currently automatically applied to the part of a retrieved index key that matches the suggest value on which you were searching. (Manual formatting of field data is not possible yet in Axiell Collections or Internet Server.)
Read more about JSON output here.
Description
The suggest command (available from October 2016) retrieves only those terms or names which contain the (partial or complete) word provided as the search key. To search on a partial word (the starting letters of a word to be precise) if truncation is off, type an asterisk directly behind the partial word. Suggest only works if one or more <searchFields> specifications exist in the adlibweb.xml configuration file. Suggest effectively uses a <searchFields> specification to know which indexes to search for the value you're interested in.
You can choose to have the output formatted as JSON if you'd like the search key part of each retrieved index value to be highlighted as bold text automatically.
Examples
Description
- no Adlib.Data-specific description available yet; see the URL request tab for all information -
Examples
Description
- no Adlib.Data-specific description available yet; see the URL request tab for all information -
Examples