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

Gets all Rate Codes for the hotel specified on a specific date.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hotelId

Hotel-Id => checked against the calling applications permissions

string

Required

key

API - Key identifying the caller

string

Required

date

date for which to return the Rate Codes, Format YYYY-MM-DD

date

Required

Body Parameters

None.

Response Information

Resource Description

Array of RateCode

Collection of RateCode
NameDescriptionTypeAdditional information
Date

Date for this statistic

date

None.

HotelId

Unique Hotel Id

string

None.

InventoryId

Unique Id of the inventory this RateCode belongs to (in combination with HotelId)

string

None.

RateId

Unique Id of the rateChange (in combination with HotelId)

string

None.

Flat

Flat Rate or Percent of Base Rate

boolean

None.

ClosedToArrival

Rate is not available if you arrive on the selected day

boolean

None.

Open

Is Open for current Date

boolean

None.

Name

Name of the Rate Code / Base Rate

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Date": "2022-10-05T23:38:03.8695256-07:00",
    "HotelId": "sample string 2",
    "InventoryId": "sample string 3",
    "RateId": "sample string 4",
    "Flat": true,
    "ClosedToArrival": true,
    "Open": true,
    "Name": "sample string 8"
  },
  {
    "Date": "2022-10-05T23:38:03.8695256-07:00",
    "HotelId": "sample string 2",
    "InventoryId": "sample string 3",
    "RateId": "sample string 4",
    "Flat": true,
    "ClosedToArrival": true,
    "Open": true,
    "Name": "sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRateCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <RateCode>
    <ClosedToArrival>true</ClosedToArrival>
    <Date>2022-10-05T23:38:03.8695256-07:00</Date>
    <Flat>true</Flat>
    <HotelId>sample string 2</HotelId>
    <InventoryId>sample string 3</InventoryId>
    <Name>sample string 8</Name>
    <Open>true</Open>
    <RateId>sample string 4</RateId>
  </RateCode>
  <RateCode>
    <ClosedToArrival>true</ClosedToArrival>
    <Date>2022-10-05T23:38:03.8695256-07:00</Date>
    <Flat>true</Flat>
    <HotelId>sample string 2</HotelId>
    <InventoryId>sample string 3</InventoryId>
    <Name>sample string 8</Name>
    <Open>true</Open>
    <RateId>sample string 4</RateId>
  </RateCode>
</ArrayOfRateCode>