5. GetHotels

Version 19.1 by Giorgi Mdivnishvili on 2024/04/10 09:52

Method Description

The GetHotels method is used to retrieve a list of hotels by country.
In order to be able to retrieve a list of hotels in United Arab Emirates, for example, you need to pass the country code "AE" as a parameter.

Endpoint URL - [GET]

Request Parameters

Request Body

none

Response Body

[
  {
   "hotelCode": "string",
   "hotelName": "string",
   "hotelClass": "string",
   "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "countryCode": "string",
   "countryName": "string",
   "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "cityName": "string",
   "districtName": "string",
   "hotelType": "CityHotel",
   "latitude": "string",
   "longitude": "string",
   "hasAlcohol": true,
   "hasFreeWifi": true,
   "hasMetro": true,
   "hasPool": true,
   "hasMall": true
  }
]

example

{
       "hotelCode": "cfbca5b5-4090-4bcd-805a-463d83423b86",
       "hotelName": "Ramada Abu Dhabi Corniche",
       "hotelClass": "4",
       "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
       "countryCode": "AE",
       "districtUID": "ee402984-6d1d-4fcf-915d-f31b14fa8b0f",
       "cityName": "Abu Dhabi",
       "districtName": "Abu Dhabi",
       "hotelType": "CityHotel",
       "latitude": "24.503759",
       "longitude": "54.374577",
       "hasAlcohol": false,
       "hasFreeWifi": true,
       "hasMetro": false,
       "hasPool": true,
       "hasMall": false
    },
    {
       "hotelCode": "c64b6082-2337-4519-8c33-4bcdef76b16b",
       "hotelName": "Emirates Palace Mandarin Oriental, Abu Dhabi",
       "hotelClass": "5",
       "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
       "countryCode": "AE",
       "districtUID": "ee402984-6d1d-4fcf-915d-f31b14fa8b0f",
       "cityName": "Abu Dhabi",
       "districtName": "Abu Dhabi",
       "hotelType": "BeachHotel",
       "latitude": "24.461556",
       "longitude": "54.317404",
       "hasAlcohol": false,
       "hasFreeWifi": true,
       "hasMetro": false,
       "hasPool": true,
       "hasMall": false
    },

Schema

Success

[Hotel{

hotelCodestring
nullable: true
hotelNamestring
nullable: true
hotelClassstring
nullable: true
cityUIDstring($uuid)
nullable: true
countryCodestring
nullable: true
countryNamestring
nullable: true
districtUIDstring($uuid)
nullable: true
cityNamestring
nullable: true
districtNamestring
nullable: true
hotelTypeHotelTypeEnumstringEnum:
[ CityHotel, BeachHotel, SecondLineBeach ]
latitudestring
nullable: true
longitudestring
nullable: true
hasAlcoholboolean
hasFreeWifiboolean
hasMetroboolean
hasPoolboolean
hasMallboolean

}]

Definitions

Warning

- `hotelCode`: (string) The unique identifier for the hotel.

- `hotelName`: (string) The name of the hotel.

- `hotelClass`: (string) The class or star rating of the hotel. For example, "4" for a 4-star hotel.

- `cityUID`: (string) The unique identifier for the city where the hotel is located.

- `countryCode`: (string) The ISO 3166-1 alpha-2 country code for the country where the hotel is located. For example, "AE" for United Arab Emirates.

- `districtUID`: (string) The unique identifier for the district where the hotel is located.

- `cityName`: (string) The name of the city where the hotel is located.

- `districtName`: (string) The name of the district where the hotel is located.

- `hotelType`: (string) The type of the hotel. For example, "CityHotel" for a hotel located in a city. possibe variations - CityHotel, BeachHotel, SecondLineBeach

- `latitude`: (string) The latitude of the hotel's location.

- `longitude`: (string) The longitude of the hotel's location.

- `hasAlcohol`: (boolean) Indicates whether the hotel serves alcohol. `true` means it does, `false` means it does not.

- `hasFreeWifi`: (boolean) Indicates whether the hotel offers free Wi-Fi. `true` means it does, `false` means it does not.

- `hasMetro`: (boolean) Indicates whether the hotel is near a metro station. `true` means it is, `false` means it is not.

- `hasPool`: (boolean) Indicates whether the hotel has a pool. `true` means it does, `false` means it does not.

- `hasMall`: (boolean) Indicates whether the hotel is near a shopping mall. `true` means it is, `false` means it is not.

FieldTypeDescription
hotelCodestringThe UUID of the hotel.
hotelNamestringThe name of the hotel.
hotelClassstringThe class or star rating of the hotel.
cityUIDstringThe UUID of the city where the hotel is located.
countryCodestringThe ISO code of the country where the hotel is located.
districtUIDstringThe UUID of the district where the hotel is located.
cityNamestringThe name of the city where the hotel is located.
districtNamestringThe name of the district where the hotel is located.
hotelTypestringThe type of the hotel. Possible values are "CityHotel" and "BeachHotel".
latitudestringThe latitude of the hotel's location.
longitudestringThe longitude of the hotel's location.
hasAlcoholbooleanWhether the hotel serves alcohol.
hasFreeWifibooleanWhether the hotel provides free Wi-Fi.
hasMetrobooleanWhether there is a metro station near the hotel.
hasPoolbooleanWhether the hotel has a pool.
hasMallbooleanWhether there is a mall near the hotel.