GET hotels/{hotelId}/availabilities?key={key}&date={date}

Gets Room Availability for the hotel specified on a specific date

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hotelId

Id of the Hotel for which to return availabilities

string

Required

key

API - Key identifying the caller

string

Required

date

date for which to return availabilities, Format YYYY-MM-DD

date

Required

Body Parameters

None.

Response Information

Resource Description

Array of Availability

Availability
NameDescriptionTypeAdditional information
Date

Date on which the rates are valid

date

None.

OverBookingLimit

Number of allowed over-bookings

integer

None.

OutOfOrderRooms

Number of out-of-order Rooms

integer

None.

TransientAvailable

number of available rooms

integer

None.

GroupAvailable

Number of Rooms blocked for groups

integer

None.

RoomTypeAvailability

List of RoomTypes and their availability

Collection of RoomTypeAvailability

None.

Response Formats

application/json, text/json

Sample:
{
  "Date": "2022-10-05T23:39:23.7386294-07:00",
  "OverBookingLimit": 2,
  "OutOfOrderRooms": 3,
  "TransientAvailable": 4,
  "GroupAvailable": 5,
  "RoomTypeAvailability": []
}

application/xml, text/xml

Sample:
<Availability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <Date>2022-10-05T23:39:23.7386294-07:00</Date>
  <GroupAvailable>5</GroupAvailable>
  <OutOfOrderRooms>3</OutOfOrderRooms>
  <OverBookingLimit>2</OverBookingLimit>
  <RoomTypeAvailability />
  <TransientAvailable>4</TransientAvailable>
</Availability>