GET hotels/{hotelId}/groups/availability?key={key}&fromDate={fromDate}&toDate={toDate}&tRateIds={tRateIds}

Gets all group availabilities on a specific date range (max. 60 days) and assigned to any of the Template Rates passed

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hotelId

Hotel Id for which to return the group availabilites

string

Required

key

API - Key identifying the caller

string

Required

fromDate

Start Date Range, Format YYYY-MM-DD

date

Required

toDate

End Date Range, Format YYYY-MM-DD

date

Required

tRateIds

Comma separated list of Template Rate IDs

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of GroupAvailability
NameDescriptionTypeAdditional information
StartDate

date

None.

EndDate

date

None.

GroupAvailRoomType

Collection of GroupAvailRoomType

None.

GroupRatePlan

Collection of GroupRatePlan

None.

GroupAvailRoomRates

Collection of GroupAvailRoomRates

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "StartDate": "2022-10-05T23:18:23.8996542-07:00",
    "EndDate": "2022-10-05T23:18:23.915272-07:00",
    "GroupAvailRoomType": [],
    "GroupRatePlan": [],
    "GroupAvailRoomRates": []
  },
  {
    "StartDate": "2022-10-05T23:18:23.8996542-07:00",
    "EndDate": "2022-10-05T23:18:23.915272-07:00",
    "GroupAvailRoomType": [],
    "GroupRatePlan": [],
    "GroupAvailRoomRates": []
  }
]

application/xml, text/xml

Sample:
<ArrayOfGroupAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <GroupAvailability>
    <EndDate>2022-10-05T23:18:23.915272-07:00</EndDate>
    <GroupAvailRoomRates />
    <GroupAvailRoomType />
    <GroupRatePlan />
    <StartDate>2022-10-05T23:18:23.8996542-07:00</StartDate>
  </GroupAvailability>
  <GroupAvailability>
    <EndDate>2022-10-05T23:18:23.915272-07:00</EndDate>
    <GroupAvailRoomRates />
    <GroupAvailRoomType />
    <GroupRatePlan />
    <StartDate>2022-10-05T23:18:23.8996542-07:00</StartDate>
  </GroupAvailability>
</ArrayOfGroupAvailability>