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
\nRMS to push real-time availability, rates & inventory to the connecting partner; and
\nPartners to push reservations, modifications & cancellations to RMS
\nIt 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.
\nIf 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.
\nFor more information about RMS REST API, please visit the link provided below:
https://app.swaggerhub.com/apis-docs/RMSHospitality/RMS_REST_API/
StartFragment
\nThe 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:
\nOTA_HotelDescriptiveInfoRQ: This method allows querying for room types.
OTA_HotelRatePlanNotifRQ: This method allows querying for rate plans.
The data flow is from RMS to the booking channel.
\nThe 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.
\nIt'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.
\nThe Rates & Availability API enables the synchronization of rates, availability, and inventory between RMS and the booking channel. This API consists of the following methods:
\nOTA_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.
The data flow is from RMS to the booking channel.
\nThe 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.
\nTo 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.
\nThe Reservations API enables the communication of reservation data between the booking channel and RMS. This API includes the following methods:
\nOTA_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.
The data flow is from the booking channel to RMS.
\nThe Reservations API allows partners to push reservation notification requests, including booking creation, modification, and cancellation data, to RMS for both single and group reservations
\nSet 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
\nOnce your channel is published to our test environment, you will receive an email with all the information needed to start development, including:
\nList of rooms/rates mapped to your channel in our test environment
\nLink to the API Portal where you can trigger ARI requests from our demo database to your system for testing during development
\nCredentials for API authentication & portal access
\nWhen 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.
\nAfter certification, we will publish the integration to production for one nominated property to pilot the connection for a 7-day period.
\nUpon 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.
\nThe following sections describe the methods provided by RMS Channel API, and assumes a working knowledge of:
\nHypertext Transfer Protocol (HTTP)
\nSimple Object Access Protocol (SOAP)
\nXML Messaging
\nWebservices
\nWhile 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.
\nRMS 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:
\nEnvelope encapsulating the header & body to identify the XML document as a SOAP message
\nHeader 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)
\nBody containing the XML document based on OTA (Open Travel Alliance http://www.opentravel.org) 2004A specification standards
\n<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n <soap:Header>\n <HTNGHeader xmlns=\"http://htng.org/1.1/Header/\">\n <From>\n <Credential>\n <userName>username</userName>\n <password>password</password>\n </Credential>\n </From>\n </HTNGHeader>\n </soap:Header>\n <soap:Body>\n //OTA Request omitted for brevity\n </soap:Body>\n</soap:Envelope>\n\nDescription:
\n\n\nRMS will send an OTA_HotelDescriptiveInfoRQ to partners to query a list of room types from the booking channel.
\n
Description:
\n\n\nThe response will contain a list of the available rooms in the GuestRooms array for the property specified in the HotelDescriptiveInfo node of the request
\n
Successful Response
\n<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n <soap:Header />\n <soap:Body>\n <OTA_HotelDescriptiveInfoRS xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns =\"http://www.opentravel.org/OTA/2003/05\">\n <Success>True</Success>\n <HotelDescriptiveContents>\n <HotelDescriptiveContent>\n <FacilityInfo>\n <GuestRooms>\n <GuestRoom Code=\"TWIN2BR\" RoomTypeName=\"Standard Room\" />\n <GuestRoom Code=\"2BRTWIN\" RoomTypeName=\"Deluxe Room\" />\n </GuestRooms>\n </FacilityInfo>\n </HotelDescriptiveContent>\n </HotelDescriptiveContents>\n </OTA_HotelDescriptiveInfoRS>\n </soap:Body>\n</soap:Envelope>\n\nDescription:
\n\n\nRMS will send an OTA_HotelRatePlanNotifRQ to partners to query a list of rate plans from the booking channel.
\n
Description:
\n\n\n","urlObject":{"host":["{{vendorEndpoint}}"],"query":[],"variable":[]}},"response":[{"id":"3f87d743-e68b-491f-9c97-9085b9c62d41","name":"OTA_HotelRatePlanNotifRQ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\nThe response will contain a list of Rate Plan codes for the Property specified in the RatePlans node of the request
\n
The Mapping Retrieval API consists of 2 methods which RMS will use to query a list of rooms & rates in the booking channel.
\nAll combinations of rooms and rates provided in the response will be populated in our UI for property users to map with their counterparts in RMS.
\nImplementation of this API is optional. If mapping retrieval is not implemented, channel room/rate codes can be manually entered into RMS for mapping.
\nDescription:
\n\n\nRestrictions are sent via OTA_HotelBookingRuleNotifRQ for each applicable room type/rate plan/stay date combination, and will always include
\nall 3
\nRestrictionStatus/@Restriction:\n
\n- Master: Open or Close
\n- Arrival: Open or ClosedonArrival
\n- Departure: Open or Close
\nand 2
\nLengthOfStay/@MinMaxMessageType:\n
\n- SetMinLOS: Time attribute of zero means no MinLOS is set
\n- SetMaxLOS: Time attribute of zero means no MaxLOS is set
\n
Description:
\n\n\n","urlObject":{"host":["{{vendorEndpoint}}"],"query":[],"variable":[]}},"response":[{"id":"371fd14f-f546-4372-8941-ea0ba17d38cd","name":"OTA_HotelBookingRuleNotifRQ","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nThe expected OTA_HotelBookingRuleNotifRS should contain the word
\nSuccessor the request will be treated as a failed request.
Description:
\n\n\nOccupancy-based rates are sent via OTA_HotelRateAmountNotifRQ for each applicable room type/ rate plan/ stay date combination.
\n
Please note that BaseByGuestAmt/@NumberOfGuests will always start from 1, and iterate through each occupancy until it reaches the maximum occupancy per room set by property users in RMS.
\nFor example, if base rate was $100 for 2 pax, additional adult charge was $10, additional children charge was $5, and max occupancy was 5, it will be sent as:
\n<BaseByGuestAmts>\n <BaseByGuestAmt AmountBeforeTax=\"100.00\" NumberOfGuests=\"1\" AgeQualifyingCode=\"10\"/>\n <BaseByGuestAmt AmountBeforeTax=\"100.00\" NumberOfGuests=\"2\" AgeQualifyingCode=\"10\"/>\n <BaseByGuestAmt AmountBeforeTax=\"110.00\" NumberOfGuests=\"3\" AgeQualifyingCode=\"10\"/>\n <BaseByGuestAmt AmountBeforeTax=\"120.00\" NumberOfGuests=\"4\" AgeQualifyingCode=\"10\"/>\n <BaseByGuestAmt AmountBeforeTax=\"130.00\" NumberOfGuests=\"5\" AgeQualifyingCode=\"10\"/>\n</BaseByGuestAmts>\n<AdditionalGuestAmounts>\n <AdditionalGuestAmount AgeQualifyingCode=\"8\" Amount=\"5.00\"/>\n</AdditionalGuestAmounts>\n\nDescription:
\n\n\n","urlObject":{"host":["{{vendorEndpoint}}"],"query":[],"variable":[]}},"response":[{"id":"112c0d6e-190a-4cf5-ba00-1c665e6373a6","name":"OTA_HotelRateAmountNotifRQ","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nThe expected OTA_HotelRateAmountNotifRS should contain the word
\nSuccessor the request will be treated as a failed request.
Description:
\n\n\nThis message sends a notification to reservation systems that synchronizes the inventory available for sale at the hotel.
\n
Description:
\n\n\n","urlObject":{"host":["{{vendorEndpoint}}"],"query":[],"variable":[]}},"response":[{"id":"079cac5f-47c3-4696-b6bb-70f8c90a0810","name":"OTA_HotelInvCountNotifRQ","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nThe expected OTA_HotelInvCountNotifRS should contain the word
\nSuccessor the request will be treated as a failed request.
The following are the messages we use to sync rates, inventory, & restrictions from RMS to your booking system.
\nOTA_HotelBookingRuleNotifRQ – used to send stop sell, min stay, max stay, closed to arrival & closed to departure notifications at the room/rate level
\nOTA_HotelRateAmountNotifRQ – used to send rate amount notifications at the room/rate level
\nOTA_HotelInvCountNotifRQ – used to send inventory count notifications at the room level
\nSummary of ARI data provided
\nHotel Code
\nRoom Code
\nRate Code
\nStart & End Dates
\nLive inventory
\nOccupancy-based rates
\nExtra child rates (where applicable)
\nCurrency
\nStop sell
\nClosed to Arrival restrictions
\nClosed to Departure restrictions
\nMinimum Length of Stay
\nMaximum Length of Stay
\nDescription:
\n\n\nNew bookings requests are sent from partner to RMS via OTA_HotelResNotifRQ.
\n
Description:
\n\n\n","urlObject":{"protocol":"https","path":["api","ota_api","api","rmsgeneric","booking_submit"],"host":["vgsproxy","rmscloud","com"],"query":[],"variable":[]}},"response":[{"id":"38059421-59ab-4ab9-ac5a-bbee59162613","name":"OTA_HotelResNotifRQ","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nWe will provide the PMSConfirmNumber upon successful receipt of the reservation, this will need to be included in all future updates for this reservation.
\n
Description:
\n\n\nModification requests are sent from partner to RMS via OTA_HotelResModifyNotifRQ.
\n
Description:
\n\n\n","urlObject":{"protocol":"https","path":["api","ota_api","api","rmsgeneric","booking_submit"],"host":["vgsproxy","rmscloud","com"],"query":[],"variable":[]}},"response":[{"id":"5d891275-95d2-4b8b-ba1b-29a9f28d38fc","name":"OTA_HotelResModifyNotifRQ","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nWe will provide the PMSConfirmNumber upon successful receipt of the modification; it may or may not be the same as the original PMSConfirmNumber, please use the most recent one for future updates.
\n
Description:
\n\n\n
Description:
\n\n\n","urlObject":{"protocol":"https","path":["api","ota_api","api","rmsgeneric","booking_submit"],"host":["vgsproxy","rmscloud","com"],"query":[],"variable":[]}},"response":[{"id":"bafb2d20-83a7-453a-84d3-a59210b10ae5","name":"OTA_CancelRQ","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n