Regions Live Search

Resource type: regionsLiveSearch

With this API call, regions can be read out by a search term (part of the region name) (“Regions in Address Completion via Autocomplete”).

Parameters:

  • searchstring
    Search term

Request example:

    {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "resourceid": "",
        "identifier": "",
        "resourcetype": "regionsLiveSearch",
        "parameters": {
            "searchstring": "Aachen"
        }
    }

Response:

  • key
    Combination of region level and ID (z.B. „1_5515“)
  • title
    Name of the region. Scheme: Region1 – Region2 – Region3
  • field
    Unique region key

Response example:

...
elements: [
{
	key: "1_5409",
	title: "Bezirk Aachen",
	field: "indMulti1186Select5407"
},
{
	key: "2_5415",
	title: "Bezirk Aachen - Aachen Stadt",
	field: "indMulti1186Select5409"
},
...