RMS Channel API
StartFragmentEndFragment
Overview
RMS Channel API is an XML over SOAP interface delivered over secure HTTP (HTTPS), used to connect Online Travel Agencies and other distribution channels with RMS, allowing
RMS to push real-time availability, rates & inventory to the connecting partner; and
Partners to push reservations, modifications & cancellations to RMS
It uses the hotel codes, room codes, and rate codes provided by the partner, so property users must first configure their property, room types, and rate plans on the connecting partner's system, then map them to their counterparts in RMS in order to establish connection.
If you are a web developer, or if your requirements extend beyond basic ARI and reservations, our REST API may be better suited to meet your needs. In addition to providing both PUSH and PULL methods for ARI, RMS REST API also act as a gateway to the RMS database where partners can query for, create, and update a broad subset of data.
For more information about RMS REST API, please visit the link provided below:
https://app.swaggerhub.com/apis-docs/RMSHospitality/RMS_REST_API/
Supported Operations
1. Mapping Retrieval API
StartFragment
The Mapping Retrieval API facilitates the retrieval of room types and rate plans from the booking channel to be mapped with corresponding counterparts in RMS. The API consists of two methods:
OTA_HotelDescriptiveInfoRQ: This method allows querying for room types.OTA_HotelRatePlanNotifRQ: This method allows querying for rate plans.
Direction
The data flow is from RMS to the booking channel.
Description
The Mapping Retrieval API provides a seamless integration between RMS and the booking channel by automatically populating the UI with combinations of rooms and rates retrieved from the channel, allowing property users to easily map these combinations with their counterparts in RMS.
It's important to note that the implementation of this API is optional. If mapping retrieval is not implemented, property users can manually enter channel room/rate codes into RMS for mapping.
2. Rates & Availability API
The Rates & Availability API enables the synchronization of rates, availability, and inventory between RMS and the booking channel. This API consists of the following methods:
OTA_HotelBookingRuleNotifRQ: This method is used to communicate rules and restrictions affecting the availability status.OTA_HotelRateAmountNotifRQ: This method is used to synchronize occupancy-based rates.OTA_HotelInvCountNotifRQ: This method is used to synchronize inventory.
Direction
The data flow is from RMS to the booking channel.
Description
The Rates & Availability API allows RMS to provide live updates of availability, rates, and inventory for all mapped room/rate combinations to the connected booking channel.
To ensure parity between the booking channel and RMS, we will send ARI data for the next two years upon initial connection, and subsequent changes are transmitted as delta updates.
3. Reservations API
The Reservations API enables the communication of reservation data between the booking channel and RMS. This API includes the following methods:
OTA_HotelResNotifRQ: This method is used to communicate new reservation data.OTA_HotelResModifyNotifRQ: This method is used to communicate reservation modification data.OTA_CancelRQ: This method is used to communicate reservation cancellation data.
Direction
The data flow is from the booking channel to RMS.
Description
The Reservations API allows partners to push reservation notification requests, including booking creation, modification, and cancellation data, to RMS for both single and group reservations
Getting Started
Set up a single endpoint for receiving push notifications from RMS, and submit the completed form here https://forms.gle/yGZJgdwLAYASKoHz7 so we can configure your channel in our test and production environments
Once your channel is published to our test environment, you will receive an email with all the information needed to start development, including:
List of rooms/rates mapped to your channel in our test environment
Link to the API Portal where you can trigger ARI requests from our demo database to your system for testing during development
Credentials for API authentication & portal access
When development is complete, please submit the "Channel Summary" form here https://forms.gle/7avK1Da3ZaMsKrsC8 to finalize the list of functionalities implemented and arrange a suitable time for certification. We will test the quality of your implementation to ensure all message types are implemented correctly.
After certification, we will publish the integration to production for one nominated property to pilot the connection for a 7-day period.
Upon successful completion of the pilot phase, the integration process will be considered complete and the channel will be opened up to all properties in production.
Developer Guide
The following sections describe the methods provided by RMS Channel API, and assumes a working knowledge of:
Hypertext Transfer Protocol (HTTP)
Simple Object Access Protocol (SOAP)
XML Messaging
Webservices
While every effort has been made to ensure the information presented is accurate and current, it should be noted that information may have changed since publication. Where errors or inaccuracies are brought to our attention, a reasonable effort will be made to correct them.
RMS Channel API is an XML over SOAP (version 1.1) interface delivered over secure HTTP (HTTPS), with each SOAP message comprised of the following elements:
Envelope encapsulating the header & body to identify the XML document as a SOAP message
Header following the HTNG (Hospitality Technology Next Generation https://www.htng.org) format for authenticating a message to the receiving system via username & password (developers will receive the values for these elements during implementation)
Body containing the XML document based on OTA (Open Travel Alliance http://www.opentravel.org) 2004A specification standards