GET chains/{chainId}/reservations/cancellations?key={key}&fromDate={fromDate}&toDate={toDate}

Gets all Reservations Cancellations for the hotel chain specified that have been cancelled on a specific date range (max. 60 days).

Request Information

URI Parameters

Name	Description	Type	Additional information
chainId	Chain-Id => checked against the calling applications permissions	integer	Required
key	API - Key identifying the caller	string	Required
fromDate	Start of Date Range, Format YYYY-MM-DD	date	Required
toDate	End of Date Range, Format YYYY-MM-DD	date	Required

Body Parameters

None.

Response Information

Resource Description

List of reservationsCancellation

Collection of ReservationCancellation

Name	Description	Type	Additional information
BookerName	Booker Name	string	None.
CampaignCode	Campaign Code	string	None.
CancellantionFee	Cancellation fee charged	decimal number	None.
CancellantionLCY	Total revenue for the reservation	decimal number	None.
CancellationDate	Date the reservation was cancelled - will be January 1, 0001 if the reservation wasn't cancelled	date	None.
CancellationNumber	The Cancellation Number that is assigned to a Cancelled Reservation	integer	None.
CancellationUser	User who cancelled the reservation	string	None.
CheckInDate	Date the guest will / has checked in	date	None.
CheckOutDate	Date the guest will / has checked out	date	None.
ClientType	Client type.	string	None.
CreatedDate	Date and Time the reservation was created	date	None.
CRtoCustomer	CR to customer	string	None.
Email	E-mail	string	None.
Forfeit	Forfeit	string	None.
GLCodeCredit	General ledger Code (Credit)	string	None.
GLCodeDebit	General ledger Code (Debit)	string	None.
HotelName	Name of the Hotel	string	None.
LengthOfStay	Number of days/nights the guests will stay	integer	None.
LocalCurrency	Local currency code	string	None.
Occupants	Number of persons in the reservation	integer	None.
ReservationId	Internal res_id	integer	None.
RoomType	Name of the reserved room type	string	None.
Telephone	Telephone	string	None.
TransactionCode	Transaction Code	string	None.
Type	Type	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "BookerName": "sample string 1",
    "CampaignCode": "sample string 2",
    "CancellantionFee": 3.0,
    "CancellantionLCY": 4.0,
    "CancellationDate": "2024-11-21T13:35:06.5117506-08:00",
    "CancellationNumber": 6,
    "CancellationUser": "sample string 7",
    "CheckInDate": "2024-11-21T13:35:06.5117506-08:00",
    "CheckOutDate": "2024-11-21T13:35:06.5117506-08:00",
    "ClientType": "sample string 10",
    "CreatedDate": "2024-11-21T13:35:06.5117506-08:00",
    "CRtoCustomer": "sample string 12",
    "Email": "sample string 13",
    "Forfeit": "sample string 14",
    "GLCodeCredit": "sample string 15",
    "GLCodeDebit": "sample string 16",
    "HotelName": "sample string 17",
    "LengthOfStay": 18,
    "LocalCurrency": "sample string 19",
    "Occupants": 20,
    "ReservationId": 21,
    "RoomType": "sample string 22",
    "Telephone": "sample string 23",
    "TransactionCode": "sample string 24",
    "Type": "sample string 25"
  },
  {
    "BookerName": "sample string 1",
    "CampaignCode": "sample string 2",
    "CancellantionFee": 3.0,
    "CancellantionLCY": 4.0,
    "CancellationDate": "2024-11-21T13:35:06.5117506-08:00",
    "CancellationNumber": 6,
    "CancellationUser": "sample string 7",
    "CheckInDate": "2024-11-21T13:35:06.5117506-08:00",
    "CheckOutDate": "2024-11-21T13:35:06.5117506-08:00",
    "ClientType": "sample string 10",
    "CreatedDate": "2024-11-21T13:35:06.5117506-08:00",
    "CRtoCustomer": "sample string 12",
    "Email": "sample string 13",
    "Forfeit": "sample string 14",
    "GLCodeCredit": "sample string 15",
    "GLCodeDebit": "sample string 16",
    "HotelName": "sample string 17",
    "LengthOfStay": 18,
    "LocalCurrency": "sample string 19",
    "Occupants": 20,
    "ReservationId": 21,
    "RoomType": "sample string 22",
    "Telephone": "sample string 23",
    "TransactionCode": "sample string 24",
    "Type": "sample string 25"
  }
]

application/xml, text/xml

Sample:

<ArrayOfReservationCancellation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <ReservationCancellation>
    <BookerName>sample string 1</BookerName>
    <CRtoCustomer>sample string 12</CRtoCustomer>
    <CampaignCode>sample string 2</CampaignCode>
    <CancellantionFee>3</CancellantionFee>
    <CancellantionLCY>4</CancellantionLCY>
    <CancellationDate>2024-11-21T13:35:06.5117506-08:00</CancellationDate>
    <CancellationNumber>6</CancellationNumber>
    <CancellationUser>sample string 7</CancellationUser>
    <CheckInDate>2024-11-21T13:35:06.5117506-08:00</CheckInDate>
    <CheckOutDate>2024-11-21T13:35:06.5117506-08:00</CheckOutDate>
    <ClientType>sample string 10</ClientType>
    <CreatedDate>2024-11-21T13:35:06.5117506-08:00</CreatedDate>
    <Email>sample string 13</Email>
    <Forfeit>sample string 14</Forfeit>
    <GLCodeCredit>sample string 15</GLCodeCredit>
    <GLCodeDebit>sample string 16</GLCodeDebit>
    <HotelName>sample string 17</HotelName>
    <LengthOfStay>18</LengthOfStay>
    <LocalCurrency>sample string 19</LocalCurrency>
    <Occupants>20</Occupants>
    <ReservationId>21</ReservationId>
    <RoomType>sample string 22</RoomType>
    <Telephone>sample string 23</Telephone>
    <TransactionCode>sample string 24</TransactionCode>
    <Type>sample string 25</Type>
  </ReservationCancellation>
  <ReservationCancellation>
    <BookerName>sample string 1</BookerName>
    <CRtoCustomer>sample string 12</CRtoCustomer>
    <CampaignCode>sample string 2</CampaignCode>
    <CancellantionFee>3</CancellantionFee>
    <CancellantionLCY>4</CancellantionLCY>
    <CancellationDate>2024-11-21T13:35:06.5117506-08:00</CancellationDate>
    <CancellationNumber>6</CancellationNumber>
    <CancellationUser>sample string 7</CancellationUser>
    <CheckInDate>2024-11-21T13:35:06.5117506-08:00</CheckInDate>
    <CheckOutDate>2024-11-21T13:35:06.5117506-08:00</CheckOutDate>
    <ClientType>sample string 10</ClientType>
    <CreatedDate>2024-11-21T13:35:06.5117506-08:00</CreatedDate>
    <Email>sample string 13</Email>
    <Forfeit>sample string 14</Forfeit>
    <GLCodeCredit>sample string 15</GLCodeCredit>
    <GLCodeDebit>sample string 16</GLCodeDebit>
    <HotelName>sample string 17</HotelName>
    <LengthOfStay>18</LengthOfStay>
    <LocalCurrency>sample string 19</LocalCurrency>
    <Occupants>20</Occupants>
    <ReservationId>21</ReservationId>
    <RoomType>sample string 22</RoomType>
    <Telephone>sample string 23</Telephone>
    <TransactionCode>sample string 24</TransactionCode>
    <Type>sample string 25</Type>
  </ReservationCancellation>
</ArrayOfReservationCancellation>