GET v1/Suggestion?q={q}&capakey={capakey}&poi={poi}&c={c}

Provides auto-completion functionality for a free form single search line.

Request Information

Parameters

NameDescriptionAdditional information
q
[Optional] A free form search string. May contain community names, sub-community area names, zip codes, street names, house numbers, poi names or parts thereof. A minimum of two characters is required.

Define this parameter in the request URI.

capakey
Obsolete [Optional] A parcel identifier in capakey notation. At least the first five characters are required.

Define this parameter in the request URI.

poi
[Optional] The name of a Point of Interest, or a part thereof.

Define this parameter in the request URI.

c
[Optional] The maximum number of items you want to retrieve in the result. You may not ask more than 25 items. If omitted defaults to 5.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "SuggestionResult": [
    "Trambergstraat 1, Zonhoven",
    "Trambergstraat 10, Zonhoven",
    "Trambergstraat 12, Zonhoven",
    "Trambergstraat 14, Zonhoven",
    "Trambergstraat 15, Zonhoven"
  ]
}

text/javascript, application/javascript, application/json-p

Sample:
({"SuggestionResult":["Trambergstraat 1, Zonhoven","Trambergstraat 10, Zonhoven","Trambergstraat 12, Zonhoven","Trambergstraat 14, Zonhoven","Trambergstraat 15, Zonhoven"]});