Retrieve detailed information about rooms and reservations within a specified date range, including room numbers or names, room types, and reservation details such as guest information and current status.
This function is intended for providers that need to monitor room occupancy to manage services in near real time, such as in-room security systems, phone or TV applications, and mini-bar management. For example, a smoke detector may be activated when a guest is present and deactivated when the room is vacant.
For real-time room actions and additional context, you can also use the complementary webhook.
Do not query large date ranges without pre approval with the Minihotel team. Such queries may waste server resources and be inefficient.
Request
<?xml version="1.0" encoding="UTF-8" ?>
<!-- Mini Hotel - Availability and Rates - Request -->
<AvailRaters>
<Authentication username="Test" password="3657488" ResponseType="03" />
<Hotel id="sandbox" />
<DateRange from="2024-07-14" to="2024-07-17" />
</AvailRaters>
Response
The response includes the room number list, i.e. all the rooms available at the hotel (whether they are occupied or vacant), and the reservations who stay or arrive (check-in) at the queried date range.
<AvailRaters>
<Hotel id="sandbox" Name_h="Test Hotel MiniHotel" Name_e="Test Hotel MiniHotel" />
<DateRange from="2024-07-14" to="2024-07-18" />
<Rooms>
<Room Number="01" Rmtype="DBL" />
<Room Number="02" Rmtype="DBL" />
<Room Number="101" Rmtype="DBL" />
<Room Number="102" Rmtype="DBL" />
<Room Number="103" Rmtype="Twin" />
<Room Number="104" Rmtype="Twin" />
<Room Number="301" Rmtype="Twin" />
<Room Number="302" Rmtype="DBL" />
<Room Number="303" Rmtype="DBL" />
<Room Number="304" Rmtype="DBL" />
<Room Number="401" Rmtype="Executive" />
<Room Number="501" Rmtype="SNG" />
</Rooms>
<RoomsTypes>
<RoomType Code="2BEDAPT" Description="Two bedroom apartment" />
<RoomType Code="APT_SEA" Description="Apartment Sea View" />
<RoomType Code="DBL" Description="Double room" />
<RoomType Code="TRP" Description="Triple Room" />
<RoomType Code="Twin" Description="Twin Room" />
</RoomsTypes>
<Reservations>
<Reservation ResNumber="007003163" Namep="Jon" Namef="Doe" RoomNumber="01" RoomType="DBL"
FromYmd="20240713" ToYmd="20240715" RoomsQty="0001" Status="OK" Board="HB" />
<Reservation ResNumber="007003171" Namep="Walter" Namef="Matteo" RoomNumber="104" RoomType="Twin"
FromYmd="20240714" ToYmd="20240715" RoomsQty="0001" Status="OK" Board="HB" />
<Reservation ResNumber="007003108" Namep="Frank" Namef="Enstein" RoomNumber="02" RoomType="DBL" FromYmd="20240715"
ToYmd="20240716" RoomsQty="0001" Status="OK" Board="HB" />
<Reservation ResNumber="007003149" Namep="Cookie" Namef="Jam" RoomNumber="01" RoomType="DBL" FromYmd="20240715"
ToYmd="20240716" RoomsQty="0001" Status="OK" Board="HB" />
</Reservations>
</AvailRaters>
Response Explanation
| Parameter | Description |
|---|---|
| Rooms | A Container holding all the hotel rooms at the time of the query. No matter what date range is used in the query. These rooms may be occupied or unoccupied. |
| RoomsTypes | A Container holding all the hotel room types at the time of the query. No matter what date range is used in the query. These types may be occupied or unoccupied. |
| Reservations | A Container holding all the hotel reservations for the date range used in the query, containing the room number and reservation status (for example: OK, IN, WL). |
Reservations who checkout or cancelled in the queries range are not listed in the response. If a specific room has no reservations staying or arriving at the specified date range, then no reservations will be listed for the room.
OK: Confirmed
OK1–OK9: Mostly available for custom use
OK2: Confirmed – Channel Manager / OTAs
OK4: Confirmed – Booking Engine (Homepage)
WL: Waiting List
PN: Pending
IN: Checked-in
OUT: Checked-out
CL: Cancelled
BL: Blacklisted
LWP: Left Without Payment
BID: Bid / Quote
CLOSE: Closed Room
ALC: Allocation
PRE: Pre-authorization
ℹ️ Additional status values can be customized in the system setup.