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

Gets all Groups for the hotel specified on a specific date.

Request Information

URI Parameters

Name	Description	Type	Additional information
hotelId	Hotel ID for which to retrieve groups	string	Required
key	API - Key identifying the caller	string	Required
date	Date for which to return groups	date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Group

Name	Description	Type	Additional information
HotelId	Unique Id for this Hotel used in the RoomKey backend	string	None.
HotelName	Name of the Hotel	string	None.
GroupId	Group Id stored in Roomkey backend	string	None.
GroupName	Group Name	string	None.
StartDate	Group start date - first day of the block	date	None.
EndDate	Group end date - last day of the block	date	None.
AbsoluteCutoffDate	Cut-off date - date for releasing blocked rooms	date	None.
CutoffType	Cut-off type - (A) Absolute: Releases the whole block (1) Day by bay: Each day it releases 1 more day of the block	string	None.
GroupRoomType	List of Room types and Rates	Collection of GroupRoomType	None.
GroupDailyRevenue	Daily revenue for the Group - based on reservations	Collection of GroupDailyRevenue	None.
ContactName	Contact Name	string	None.
ContactPhone	Contact phone number	string	None.
ContactFax	Contact Fax number	string	None.
ContactAddress	Address	string	None.
ContactCityName	City	string	None.
ContactPostalCode	Postal code / ZIP	string	None.
ContactStateProv	State / Province	string	None.
ContactCountryId	Country ID	string	None.
ContactCountryName	Country Name	string	None.
ContactEMail	E-mail	string	None.
ContactCompanyName	Company name	string	None.
ContactCompanyCode	Company Id	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "HotelId": "sample string 1",
    "HotelName": "sample string 2",
    "GroupId": "sample string 3",
    "GroupName": "sample string 4",
    "StartDate": "2024-11-21T18:01:58.4787062-08:00",
    "EndDate": "2024-11-21T18:01:58.4787062-08:00",
    "AbsoluteCutoffDate": "2024-11-21T18:01:58.4787062-08:00",
    "CutoffType": "sample string 8",
    "GroupRoomType": [],
    "GroupDailyRevenue": [],
    "ContactName": "sample string 9",
    "ContactPhone": "sample string 10",
    "ContactFax": "sample string 11",
    "ContactAddress": "sample string 12",
    "ContactCityName": "sample string 13",
    "ContactPostalCode": "sample string 14",
    "ContactStateProv": "sample string 15",
    "ContactCountryId": "sample string 16",
    "ContactCountryName": "sample string 17",
    "ContactEMail": "sample string 18",
    "ContactCompanyName": "sample string 19",
    "ContactCompanyCode": "sample string 20"
  },
  {
    "HotelId": "sample string 1",
    "HotelName": "sample string 2",
    "GroupId": "sample string 3",
    "GroupName": "sample string 4",
    "StartDate": "2024-11-21T18:01:58.4787062-08:00",
    "EndDate": "2024-11-21T18:01:58.4787062-08:00",
    "AbsoluteCutoffDate": "2024-11-21T18:01:58.4787062-08:00",
    "CutoffType": "sample string 8",
    "GroupRoomType": [],
    "GroupDailyRevenue": [],
    "ContactName": "sample string 9",
    "ContactPhone": "sample string 10",
    "ContactFax": "sample string 11",
    "ContactAddress": "sample string 12",
    "ContactCityName": "sample string 13",
    "ContactPostalCode": "sample string 14",
    "ContactStateProv": "sample string 15",
    "ContactCountryId": "sample string 16",
    "ContactCountryName": "sample string 17",
    "ContactEMail": "sample string 18",
    "ContactCompanyName": "sample string 19",
    "ContactCompanyCode": "sample string 20"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <Group>
    <AbsoluteCutoffDate>2024-11-21T18:01:58.4787062-08:00</AbsoluteCutoffDate>
    <ContactAddress>sample string 12</ContactAddress>
    <ContactCityName>sample string 13</ContactCityName>
    <ContactCompanyCode>sample string 20</ContactCompanyCode>
    <ContactCompanyName>sample string 19</ContactCompanyName>
    <ContactCountryId>sample string 16</ContactCountryId>
    <ContactCountryName>sample string 17</ContactCountryName>
    <ContactEMail>sample string 18</ContactEMail>
    <ContactFax>sample string 11</ContactFax>
    <ContactName>sample string 9</ContactName>
    <ContactPhone>sample string 10</ContactPhone>
    <ContactPostalCode>sample string 14</ContactPostalCode>
    <ContactStateProv>sample string 15</ContactStateProv>
    <CutoffType>sample string 8</CutoffType>
    <EndDate>2024-11-21T18:01:58.4787062-08:00</EndDate>
    <GroupDailyRevenue />
    <GroupId>sample string 3</GroupId>
    <GroupName>sample string 4</GroupName>
    <GroupRoomType />
    <HotelId>sample string 1</HotelId>
    <HotelName>sample string 2</HotelName>
    <StartDate>2024-11-21T18:01:58.4787062-08:00</StartDate>
  </Group>
  <Group>
    <AbsoluteCutoffDate>2024-11-21T18:01:58.4787062-08:00</AbsoluteCutoffDate>
    <ContactAddress>sample string 12</ContactAddress>
    <ContactCityName>sample string 13</ContactCityName>
    <ContactCompanyCode>sample string 20</ContactCompanyCode>
    <ContactCompanyName>sample string 19</ContactCompanyName>
    <ContactCountryId>sample string 16</ContactCountryId>
    <ContactCountryName>sample string 17</ContactCountryName>
    <ContactEMail>sample string 18</ContactEMail>
    <ContactFax>sample string 11</ContactFax>
    <ContactName>sample string 9</ContactName>
    <ContactPhone>sample string 10</ContactPhone>
    <ContactPostalCode>sample string 14</ContactPostalCode>
    <ContactStateProv>sample string 15</ContactStateProv>
    <CutoffType>sample string 8</CutoffType>
    <EndDate>2024-11-21T18:01:58.4787062-08:00</EndDate>
    <GroupDailyRevenue />
    <GroupId>sample string 3</GroupId>
    <GroupName>sample string 4</GroupName>
    <GroupRoomType />
    <HotelId>sample string 1</HotelId>
    <HotelName>sample string 2</HotelName>
    <StartDate>2024-11-21T18:01:58.4787062-08:00</StartDate>
  </Group>
</ArrayOfGroup>