Retrieve Rooms API

1 What is the Retrieve Rooms API?
2 Two Types of Retrieve Rooms API
3 Additional Flags
4 How is the Retrieve Rooms API used?
5 How can I test my 'Room Retrieval' endpoint?

What is the Retrieve Rooms API?

SiteConnect uses OTA_HotelAvailRQ messages to retrieve a list of active rooms and rates for a hotel from the Booking Channel side.

SiteConnect makes a request with the OTA_HotelAvailRQ messages to the Booking Channel endpoint.
The Booking Channel responds with the OTA_HotelAvailRS message that contains a list of active rooms and rates for the hotel back to SiteConnect

This service is used by the booking channel's hoteliers to set up their rooms in SiteMinder. The rooms returned by the service must be active in the booking channel for the hoteliers to be able to manage updates.

Two Types of Retrieve Rooms API

Do I use 'Retrieve Room Codes Only' OR 'Retrieve Room Codes and Rate Codes'?

Retrieve Room Codes and Rate Codes - If your channel supports both Room Types and Rate Plans, use the Retrieve Room and Rate Codes message.
Retrieve Room Codes Only - If your channel ONLY supports Room Types (no Rate Plans), use the Retrieve Room Codes Only message.

Additional Flags

What if I need to restrict updates per room (such as rates for contracted rooms)?

Restrict Availability or Rate Updates - If you need to restrict specific updates, you can implement the Retrieve Rooms API - Restrict Availability and/or Rate Updates message.

For example, you have a static rate (or contract rate) that only requires Availability update but not the Rate update. You can apply NO_RATES flag in the OTA_HotelAvailRS messages.

Reservation Only Room Rates - If you need a Room Rate to be mapped that is ONLY for the purpose of reservation delivery into the Channel Manager, use Retrieve Rooms API - Reservation Only Room Rates message.

For example, you have a room rate that is configured ONLY for receiving reservations but does not require both Availability and Rate update. You can apply NO_UPDATES flag in the OTA_HotelAvailRS messages.

How is the Retrieve Rooms API used?

The Retrieve Rooms API ultimately allows Channel Manager users to see what Rooms/RatePlans are available to map to your Booking Channel in the Channel Manager.

Without the Retrieve Rooms API, our users don't have any knowledge of the Rooms/RatePlans you wish to receive Availability/Rates/Restrictions for.

Below is a screenshot of where the information you provide on the OTA_HotelAvailRS is utilised. ONLY return a list of active RoomCode/RateCode combinations in your OTA_HotelAvailRS.

It is important to provide a clear and concise RoomDescription (and RatePlanDescription when using RoomCodes + RateCodes) to ensure Channel Manager users can quickly and easily map/link their Channel Manager 'Room Rates' to your Booking Channel.

Room Rate Mapping Screenshot - The drop down box below contains the RoomDescription - RatePlanDescription data provided by your 'Retrieve Rooms API' endpoint.

How can I test my 'Room Retrieval' endpoint?

We have created a Room Retrieval debugging tool that you can use to make sure that you're returning the correct response and data in response to our OTA_HotelAvailRQ. See the following link to Test Room Retrieval here - https://siteminder.atlassian.net/wiki/spaces/SITECONNECT/pages/2605711684