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

Gets all Guests for the hotel specified that have been created on a specific date.

Request Information

URI Parameters

Name	Description	Type	Additional information
hotelId	Hotel-Id => checked against the calling applications permissions	string	Required
key	API - Key identifying the caller	string	Required
date	Date on which the guest was created, Format: YYYY-MM-DD	date	Required

Body Parameters

None.

Response Information

Resource Description

List of Guest

Collection of Guest

Name	Description	Type	Additional information
Address1	Guests main address	string	None.
Address2	Guests secondary Address	string	None.
Cell1	Guests main Cell phone	string	None.
Cell2	Guests secondary Cell-Phone (e.g. work)	string	None.
City1	Guests main city	string	None.
City2	Guests secondary City	string	None.
Country1	Guests main country ISO-Country-Code e.g. CA for Canada	string	None.
Country2	ISO-Country-Code e.g. CA for Canada	string	None.
CreatedDate	Date the Guest was created in the system	date	None.
Email1	Guests main email	string	None.
Email2	Guests secondary email (e.g. work)	string	None.
EmailPromotion	Defines whether the Guests wants to receive promotional emails	boolean	None.
FirstName	Guests first name	string	None.
GuestId	Unique Roomkey - Guest Id	integer	None.
GuestType	Type of guest like wholeseler, travel agent etc.	string	None.
HotelId	Id of the hotel the guest "belongs" to	string	None.
IsGuestTaxExtempt	Flag shows if guest is tax extempt	boolean	None.
LastName	Guests last name	string	None.
LoyaltyNumber	Guests loyalty number	string	None.
Phone1	Guests main Phone	string	None.
Phone2	Guests secondary phone (e.g. work)	string	None.
State1	ISO-State-Code e.g BC for British Columbia	string	None.
State2	ISO-State-Code e.g BC for British Columbia	string	None.
Title	Guests title	string	None.
VIP	VIP indicator	boolean	None.
VIPCode	Guests VIP codes	string	None.
Zip1	Guests main Zip-Code	string	None.
Zip2	Guests secondary Zip-Code	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "Cell1": "sample string 3",
    "Cell2": "sample string 4",
    "City1": "sample string 5",
    "City2": "sample string 6",
    "Country1": "sample string 7",
    "Country2": "sample string 8",
    "CreatedDate": "2024-11-21T10:58:53.7716819-08:00",
    "Email1": "sample string 10",
    "Email2": "sample string 11",
    "EmailPromotion": true,
    "FirstName": "sample string 13",
    "GuestId": 14,
    "GuestType": "sample string 15",
    "HotelId": "sample string 16",
    "IsGuestTaxExtempt": true,
    "LastName": "sample string 18",
    "LoyaltyNumber": "sample string 19",
    "Phone1": "sample string 20",
    "Phone2": "sample string 21",
    "State1": "sample string 22",
    "State2": "sample string 23",
    "Title": "sample string 24",
    "VIP": true,
    "VIPCode": "sample string 26",
    "Zip1": "sample string 27",
    "Zip2": "sample string 28"
  },
  {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "Cell1": "sample string 3",
    "Cell2": "sample string 4",
    "City1": "sample string 5",
    "City2": "sample string 6",
    "Country1": "sample string 7",
    "Country2": "sample string 8",
    "CreatedDate": "2024-11-21T10:58:53.7716819-08:00",
    "Email1": "sample string 10",
    "Email2": "sample string 11",
    "EmailPromotion": true,
    "FirstName": "sample string 13",
    "GuestId": 14,
    "GuestType": "sample string 15",
    "HotelId": "sample string 16",
    "IsGuestTaxExtempt": true,
    "LastName": "sample string 18",
    "LoyaltyNumber": "sample string 19",
    "Phone1": "sample string 20",
    "Phone2": "sample string 21",
    "State1": "sample string 22",
    "State2": "sample string 23",
    "Title": "sample string 24",
    "VIP": true,
    "VIPCode": "sample string 26",
    "Zip1": "sample string 27",
    "Zip2": "sample string 28"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGuest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <Guest>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <Cell1>sample string 3</Cell1>
    <Cell2>sample string 4</Cell2>
    <City1>sample string 5</City1>
    <City2>sample string 6</City2>
    <Country1>sample string 7</Country1>
    <Country2>sample string 8</Country2>
    <CreatedDate>2024-11-21T10:58:53.7716819-08:00</CreatedDate>
    <Email1>sample string 10</Email1>
    <Email2>sample string 11</Email2>
    <EmailPromotion>true</EmailPromotion>
    <FirstName>sample string 13</FirstName>
    <GuestId>14</GuestId>
    <GuestType>sample string 15</GuestType>
    <HotelId>sample string 16</HotelId>
    <IsGuestTaxExtempt>true</IsGuestTaxExtempt>
    <LastName>sample string 18</LastName>
    <LoyaltyNumber>sample string 19</LoyaltyNumber>
    <Phone1>sample string 20</Phone1>
    <Phone2>sample string 21</Phone2>
    <State1>sample string 22</State1>
    <State2>sample string 23</State2>
    <Title>sample string 24</Title>
    <VIP>true</VIP>
    <VIPCode>sample string 26</VIPCode>
    <Zip1>sample string 27</Zip1>
    <Zip2>sample string 28</Zip2>
  </Guest>
  <Guest>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <Cell1>sample string 3</Cell1>
    <Cell2>sample string 4</Cell2>
    <City1>sample string 5</City1>
    <City2>sample string 6</City2>
    <Country1>sample string 7</Country1>
    <Country2>sample string 8</Country2>
    <CreatedDate>2024-11-21T10:58:53.7716819-08:00</CreatedDate>
    <Email1>sample string 10</Email1>
    <Email2>sample string 11</Email2>
    <EmailPromotion>true</EmailPromotion>
    <FirstName>sample string 13</FirstName>
    <GuestId>14</GuestId>
    <GuestType>sample string 15</GuestType>
    <HotelId>sample string 16</HotelId>
    <IsGuestTaxExtempt>true</IsGuestTaxExtempt>
    <LastName>sample string 18</LastName>
    <LoyaltyNumber>sample string 19</LoyaltyNumber>
    <Phone1>sample string 20</Phone1>
    <Phone2>sample string 21</Phone2>
    <State1>sample string 22</State1>
    <State2>sample string 23</State2>
    <Title>sample string 24</Title>
    <VIP>true</VIP>
    <VIPCode>sample string 26</VIPCode>
    <Zip1>sample string 27</Zip1>
    <Zip2>sample string 28</Zip2>
  </Guest>
</ArrayOfGuest>