demand-api-v3-compatible

List accommodation details

This endpoint returns detailed information on all accommodation properties matching a given search criteria. By default, only basic information is returned. To receive extended information use the extras parameter. Is is mandatory to pass one of the input parameters: accommodations, airport, city, country or region.

SecurityHTTP: BearerAuth
Request
header Parameters
Accept
string
Value: "application/json"
Request Body schema: application/json
accommodations
Array of integers <int32> [ 1 .. 100 ] items

A signed integer number that uniquely identifies an accommodation property.

accommodation_facilities
Array of integers <int32>

A signed integer number that uniquely identifies an accommodation property facility. Examples of facilities are: Parking, Restaurant, Room service etc.

accommodation_types
Array of integers <int32>

A signed integer number that uniquely identifies an accommodation property type. Examples of accommodation types are: Apartment, Hostel, Hotel etc.

airport
string^[A-Z]{3}$

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA).

brands
Array of integers <int32>

A signed integer number that uniquely identifies an accommodation brand. Examples of brands are: Radisson Blu, WestCord Hotels, Westin etc.

city
integer <int32>

A signed integer number that uniquely identifies a city.

country
string^[a-z]{2}$

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.

region
integer <int32>

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.

extras
Array of strings

Input parameter to request for additional information about the accommodation property. It should be passed as a JSON array with one or more items.

Items Enum: "DESCRIPTION" "FACILITIES" "PAYMENT" "PHOTOS" "POLICIES" "ROOMS"
languages
Array of strings^[a-z]{2}(-[a-z]{2})?$

An IETF language tag code that uniquely identifies a supported human language or dialect as described here: https://en.wikipedia.org/wiki/IETF_language_tag.

Note that in in demand-api-v3-compatible the whole tag is always lowercase. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US).

Items Enum: "AR" "BG" "CA" "CS" "DA" "DE" "EL" "EN" "EN_GB" "EN_US" "ES" "ES_AR" "ES_MX" "ET" "FI" "FR" "HE" "HI" "HR" "HU" "ID" "IS" "IT" "JA" "KA" "KO" "LT" "LV" "MS" "NL" "NO" "PL" "PT_BR" "PT_PT" "RO" "RU" "SK" "SL" "SR" "SV" "TH" "TL" "TR" "UK" "VI" "ZH_CN" "ZH_TW"
rows
integer <int32> <= 1000

The maximum number of results to return.

page
string

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

post
/demand-api-v3-compatible/details
Request samples
application/json
{ "accommodations": [ 0 ], "accommodation_facilities": [ 0 ], "accommodation_types": [ 0 ], "airport": "AMS", "brands": [ 0 ], "city": 0, "country": "nl", "region": 0, "extras": [ "DESCRIPTION" ], "languages": "en-us", "rows": 1000, "page": "string" }
Responses

200

OK

Response Schema: application/json
Array of objects (DetailsOutputDto)
request_id
string

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

next_page
string

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

Response samples
application/json
{ "data": [ ], "request_id": "string", "next_page": "string" }

List accommodation constants

This endpoint enumerates the internal codes and names, in the selected languages, for relevant accommodation specific types.

These accommodation specific types include the list of facilities that may be available at a property like "Elevator" or "Swimmingpool Outdoor".

For example, the following parameters will return the full list in English (US) and French: {"languages":"en-us","fr"}.

To get the full list call the endpoint passing an empty body. The codes returned are what is used as input and output for other endpoints in the accommodations namespace.

SecurityHTTP: BearerAuth
Request
header Parameters
Accept
string
Value: "application/json"
Request Body schema: application/json
constants
Array of strings

Allows to filter the results only for specific sections.

Items Enum: "ACCOMMODATION_TYPES" "ACCOMMODATION_FACILITIES" "ACCOMMODATION_THEMES" "BED_TYPES" "FACILITY_TYPES" "CHARGE_TYPES" "ROOM_TYPES" "ROOM_FACILITIES" "REVIEW_SCORES"
languages
Array of strings
Default: "en-gb"
Items Enum: "AR" "BG" "CA" "CS" "DA" "DE" "EL" "EN" "EN_GB" "EN_US" "ES" "ES_AR" "ES_MX" "ET" "FI" "FR" "HE" "HI" "HR" "HU" "ID" "IS" "IT" "JA" "KA" "KO" "LT" "LV" "MS" "NL" "NO" "PL" "PT_BR" "PT_PT" "RO" "RU" "SK" "SL" "SR" "SV" "TH" "TL" "TR" "UK" "VI" "ZH_CN" "ZH_TW"
post
/demand-api-v3-compatible/constants
Request samples
application/json
{ "constants": [ "ACCOMMODATION_TYPES" ], "languages": "en-us" }
Responses

200

OK

Response Schema: application/json
data
object (ConstantsOutputDto)
request_id
string

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

next_page
string

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

Response samples
application/json
{ "data": { }, "request_id": "string", "next_page": "string" }