GET hotels/{hotelId}/statistics/roomtypeinventory?key={key}&fromDate={fromDate}&toDate={toDate}

Get the inventory calendar for the specified hotel on a specific date range The maximum date range is limited to 30 days.

Request Information

URI Parameters

Name	Description	Type	Additional information
hotelId	Hotel Id	string	Required
key	API - Key identifying the caller	string	Required
fromDate	Date range start date	date	Required
toDate	Date range end date	date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of RoomTypeInventory

Name	Type	Additional information
RoomTypeId	string	None.
RoomTypeCode	string	None.
Date	date	None.
PhysicalCount	integer	None.
AvailableCount	integer	None.
OccupiedCount	integer	None.
BlockedCount	integer	None.
OutOfOrderCount	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "RoomTypeId": "sample string 1",
    "RoomTypeCode": "sample string 2",
    "Date": "2024-11-21T10:42:53.4179048-08:00",
    "PhysicalCount": 4,
    "AvailableCount": 5,
    "OccupiedCount": 6,
    "BlockedCount": 7,
    "OutOfOrderCount": 8
  },
  {
    "RoomTypeId": "sample string 1",
    "RoomTypeCode": "sample string 2",
    "Date": "2024-11-21T10:42:53.4179048-08:00",
    "PhysicalCount": 4,
    "AvailableCount": 5,
    "OccupiedCount": 6,
    "BlockedCount": 7,
    "OutOfOrderCount": 8
  }
]

application/xml, text/xml

Sample:

<ArrayOfRoomTypeInventory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <RoomTypeInventory>
    <AvailableCount>5</AvailableCount>
    <BlockedCount>7</BlockedCount>
    <Date>2024-11-21T10:42:53.4179048-08:00</Date>
    <OccupiedCount>6</OccupiedCount>
    <OutOfOrderCount>8</OutOfOrderCount>
    <PhysicalCount>4</PhysicalCount>
    <RoomTypeCode>sample string 2</RoomTypeCode>
    <RoomTypeId>sample string 1</RoomTypeId>
  </RoomTypeInventory>
  <RoomTypeInventory>
    <AvailableCount>5</AvailableCount>
    <BlockedCount>7</BlockedCount>
    <Date>2024-11-21T10:42:53.4179048-08:00</Date>
    <OccupiedCount>6</OccupiedCount>
    <OutOfOrderCount>8</OutOfOrderCount>
    <PhysicalCount>4</PhysicalCount>
    <RoomTypeCode>sample string 2</RoomTypeCode>
    <RoomTypeId>sample string 1</RoomTypeId>
  </RoomTypeInventory>
</ArrayOfRoomTypeInventory>