Integrating Suggest via Plain-Text

This Interface is a proprietary data format which is error-prone and non-upgradeable. We recommend integrating the Suggest module via JSON or REST-API instead of using this Interface.

The standard response from the Suggest engine is in a simple format. The format has been chosen so that the amount of data to be transmitted is very small, enabling results to be displayed as quickly as possible. The request parameters are identical to those of the HTTP and XML interfaces for the Search function. Only the URL is different:

$stringEscapeUtils.escapeHtml($body)

By default, the search term is sent with the parameter query, as with a standard search query.

Output

Sample response:

Runaway - A Road Adventure###1###productName###203474962_tmp_medium.jpg
2 DVDs - Nightmare Boulevard & Shark###1###productName###323012214_medium.jpg
2 Fast 2 Furious###5###productName###

Each line of the output corresponds to a search suggestion, meaning that if the output is empty, there are no suggestions for that search term. The individual values of a suggestion are separated by three hash signs(###) and are in the following sequence:

Suggested text###Number of expected hits###Type of suggestion###Link to preview image

The number of expected hits and the link to the preview image are optional and do not need to contain a value. This response method does not provide additional information on the suggestions.

Chapter Contents