GET api/locations/{countryCode}/search/{filter}?languageCode={languageCode} Authentication required

Use this method to search for any type of location for a specified country, using a term-based filter. This will return any type of location matching the input filter in the specified country

Request

URI Parameters

NameDescriptionTypeAdditional information
countryCode

Country represented by its ISO 3166-1 alpha-2 Code (2 chars long)

string

Required

filter

Term used to search locations in the specified country (min. 3 chars long)

string

Required

languageCode

[Optional] Language represented by its ISO 639-1 Code (2 chars long)

string

Default value is

Response

Returns any type of location matching the specified filter for a specific country

Output : object (See Model)

Ouput Sample

  • application/json, text/json :
  • { "cities": [ { "countryCode": "BE", "code": "21004", "name": "Brussels", "type": "City", "level": 0 } ], "provinces": [ { "countryCode": "BE", "code": "99999990001", "name": "Brussels", "type": "Province", "level": 0 } ], "regions": [ { "countryCode": "BE", "code": "04000", "name": "Brussels", "type": "Region", "level": 0 } ] }
  • application/xml, text/xml :
  • <LocationSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Cities> <Location> <Code>21004</Code> <CountryCode>BE</CountryCode> <Level>0</Level> <Name>Brussels</Name> <ParentCode i:nil="true" /> <Type>City</Type> </Location> </Cities> <PostCodes i:nil="true" /> <Provinces> <Location> <Code>99999990001</Code> <CountryCode>BE</CountryCode> <Level>0</Level> <Name>Brussels</Name> <ParentCode i:nil="true" /> <Type>Province</Type> </Location> </Provinces> <Regions> <Location> <Code>04000</Code> <CountryCode>BE</CountryCode> <Level>0</Level> <Name>Brussels</Name> <ParentCode i:nil="true" /> <Type>Region</Type> </Location> </Regions> </LocationSearchResult>