Sign in
latestOpenAPI 3.1.02026-08-10390815.4 KB

e5f3dccae7ca

Common/locations

Regions

This endpoint returns a list of regions with translations in the selected languages. The regions returned may be filtered by a location id. For example, you can get the list of regions in the Netherlands or that the Netherlands is a part of by passing: {"country":"nl"}. To get the full list call the endpoint passing an empty body. The region ids returned are what is used as input and output for other endpoints. This endpoint implements pagination of the results.

post/common/locations/regions

Headers

X-Affiliate-Idinteger required

Include here your Affiliate identifier number

Request body

airportstring

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/airports" target="_blank">common/locations/airports</a>.

cityinteger

A signed integer number that uniquely identifies a city. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/cities" target="_blank">common/locations/cities</a>.

countrystring

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/countries" target="_blank">common/locations/countries</a>.

landmarkinteger

A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/landmarks" target="_blank">common/locations/landmarks</a>.

languagesstring[]
pagestring

Pagination token used to retrieve the next page of results. Obtained from next_page.

regioninteger

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling <a href="/demand/docs/open-api/demand-api/commonlocations/common/locations/regions" target="_blank">common/locations/regions</a>.

rowsinteger

The maximum number of results to return.

Example request

{
  "airport": "AMS",
  "country": "nl",
  "languages": [
    "en-us"
  ]
}

Response

Successful response.

request_idstring

Uniquely identifies the request. Please provide this identifier when contacting support.

next_pagestring nullable

Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter page).