Developer Docs
  • Our Products
    • Channel Manager
      • Integration and Onboarding Flow
      • RG Bridge - Supply (Push)
        • Integration Overview
          • Vision of Integration
            • Commercial value and business case
          • Information Data flow
            • One way integration
            • Two Way integration – ARI Broadcast and Reservation fetch
            • Information delivery mechanism
          • Technical feasibility of integration
            • Test property setup
            • Sample reservation data
          • RG Bridge Setup
          • Contract
          • Project Plan
          • Certification
          • Monitoring and after sales support
          • Integration checklist
        • Interface Specifications – Availability and Rates Notification Service
          • RG Bridge Integration Process
          • Intended Audience
          • Typographical Conventions
          • Technical Overview
          • Operations
            • Availability Notification
              • OTA_HotelAvailNotifRQ
                • Change in Inventory count
                • Change in availability status and Restrictions
              • OTA_HotelAvailNotifRS
              • XML Usage Specification
            • Rate Change Notification
              • OTA_HotelRateAmountNotifRQ
              • XML Usage Description
              • OTA_HotelRateAmountNotifRS
              • XML Usage Specification
            • Points to remember
        • Interface Specifications – Reservation Notification Service
          • RG Bridge integration process
          • Intended audience
          • Typographical conventions
          • Technical overview
          • Operations
            • Reservation Notification
              • OTA_HotelResNotifRQ
              • XML Usage specification
              • Sample Reservation Messages
              • OTA_HotelResNotifRS
              • XML Usage specification
          • Points to remember
          • Code Lists
      • RG Bridge - Reservation Retrieval (Pull)
        • Technical overview
        • Operations
          • Reservation Retrieval
            • OTA_ReadRQ
            • XML Usage specification
            • OTA_ResRetrieveRS
            • XML Usage specification
          • Reservation Confirmation
            • OTA_NotifReportRQ
            • XML Usage specification
            • OTA_NotifReportRS
            • XML Usage specification
        • Code Lists
      • Direct Connect - Demand (Push)
        • Introduction
        • Interface Specifications – ARI Service
          • Technical Overview
          • Operation: Property List
            • HotelPropertyListGetRQ
            • HotelPropertyListGetRS
            • Test Use Cases
            • FAQ
          • Operation: Product List
            • HotelProductListGetRQ
            • HotelProductListGetRS
            • Test Use Cases
            • FAQ
          • Operation: ARI Get
            • HotelARIGetRQ
            • HotelARIGetRS
            • Test Use Cases
            • FAQ
          • Operation: ARI Update
            • HotelARIUpdateRQ
            • HotelARIUpdateRS
            • Test Use Cases
            • FAQ
          • Points to remember
          • Code Lists
        • Interface Specifications – Reservation Notification Service
          • Technical overview
            • Communication protocols
            • General design
            • Authentication
          • Operation: Reservation
            • OTA_HotelResNotifRQ
            • OTA_HotelResNotifRS
            • Test use cases
            • FAQ
    • Smart Distribution
      • Onboarding process
      • Certification - Demand
      • Authentication Method
      • Book and Cancel Reservation
        • Transaction Header Formats
        • Book API
          • Book Reservation
          • Cancel Reservation
          • Booking Reservation Request Message Format
          • Booking Reservation Response Message Format
          • Cancel Reservation Request Message Format
      • Multiavailability (Enhanced Shopping Transaction)
        • Transaction Header Formats
        • Enhanced Shopping (EST) – Detailed Rate Information
          • Requesting Specific Rates
          • UltraDirect Account Author Negotiated Rate Processing
          • Unavailable Properties
          • UltraDirect Cache Processing
          • Enhanced Shopping Transaction Request Header Format
          • Enhanced Shopping Transaction Response Message Format
      • Pre-Book
        • Transaction Header Formats
        • Pre Book API
          • Pre-Book Request message format
          • Pre-Book Response message format
      • Property list and Booking Summary
        • PropertyList API
        • Booking Summary API
  • Content
    • Integration Process
    • Certification - Demand
    • Content Retrieve
      • SOAP/HTTP
        • SOAP Envelop
        • SOAP Body
        • Date and Time
        • Specifications for Currency Amounts
      • Transaction Specifications
      • Content Retrieval Request
      • Content Retrieval Response
    • Content Update
      • Overview
      • Transaction List
      • Transaction Flow
      • Batch processing
        • File naming convention
      • Multi-lingual capabilities
      • Associating media to textual content
      • Managing images
      • GDS content updates
      • Office of Foreign Assets Control (OFAC)
      • Interface requirements
        • SOAP envelope
        • Standard element formats
      • Transaction specifications
        • Data mapping of elements
        • Area Information
        • Affiliation information
        • Media information
        • Contact information
        • TPA extensions
        • GDS information
        • Response message
      • Codes lists
        • Credit Card
        • Error and Warning codes
        • Spoken Language
        • State and Country
      • Supported language codes
      • Client application generation using WSDL tool
  • UltraDirect
    • Integration Process
    • Certification
    • Ultradirect transaction sets - XML
      • Transaction header formats
      • Booking transactions
        • Booking request message format..
        • Request message format - Cancel
        • Request message format - Commit/Rollback
        • Request message format - Modify
        • Response message format - Booking
      • Enhanced shopping (EST)
        • Requesting Specific Rates
        • Request message format
        • Response message format.
      • Rate and availability transactions
        • Standard multi-availability
          • Request & Response message format
      • Rate Rules
        • Request message format
        • Response message format
      • Reference data transactions
        • Request message format..
        • Response message format..
      • Single property availability
        • Request message format
        • Response message format
    • XML ultradirect specifications
      • Overview
        • Transaction list
      • Interface requirements
      • Transaction meta data
    • Error Codes..
    • UltraDirect Transaction Samples and Usage
      • Using UltraDirect (Seamless, a real-time transaction)
      • EST (Enhanced Shopping Transaction)
      • Rate Rules
      • Book Reservation
      • Cancellation
      • Book Reservation with session control
      • Modification
      • Booking Storage and Retrieval
      • List of Test Credit Cards
      • Test properties in UAT
      • Guarantee Type and Method Combinations
    • xml ultradirect codes
  • Get in Touch
    • Questions?
Powered by GitBook
On this page
  1. Our Products
  2. Channel Manager
  3. RG Bridge - Supply (Push)
  4. Interface Specifications – Availability and Rates Notification Service

Technical Overview

Last updated 3 months ago

Service

ARI (Availability, Rates, and Inventory) changes can be pushed to RG Bridge in real-time. In the push model, information is sent (pushed) by the system where the information originated. In contrast, in the pull model, the system needing the information periodically connects to access it. The push model's advantage for the PMS (Property Management System) is that it doesn't need to track all changes since the last pull.

Communication Protocols

The exchange of information between RG Bridge and PMS occurs through REST messages.

General Design

Availability and Rates Notification Service:

  • Operations:

    1. Updating Inventory, Availability, and Restrictions:

      • OTA Messages:

        • Request: OTA_HotelAvailNotifRQ

        • Response: OTA_HotelAvailNotifRS

    2. Updating Rates (Base by GuestAmount and AdditionalGuestAmount):

      • OTA Messages:

        • Request: OTA_HotelRateAmountNotifRQ

        • Response: OTA_HotelRateAmountNotifRS

Authentication

  • Basic Authorization: All request messages exchanged between the PMS and RG Bridge must use basic authorization.

    • Credentials: Username and password need to be passed using basic authentication in HTTP headers.

    • Authorization Example:

      Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
    • Content-Type: text/xml

Hotel Product Handling

  • Differences in Categorization: There may be substantial differences in how RG Bridge categorizes hotel products compared to the PMS structure.

  • Understanding Differences: It's crucial to understand these differences to ensure successful integration.

RG Bridge defines hotel products as a combination of a room type and a rate type. A hotel can have many room types and rate types.

  • Rate Types Categorization: PMS systems typically classify rate types into different categories or segments.

  • Translation Requirement: The PMS must translate updates at the level of rate segments/rate categories into either room type level updates or product level updates before sending them to RG Bridge.

Example: If a PMS user updates the availability of the rate segment (Corporate Rate A) by changing the maximum available inventory count from 25 to 15, the PMS must:

  1. Determine all room type-rate type combinations affected by this change.

  2. Generate separate updates for each combination.

This design minimizes the effort required by the hotel to keep the inventory structure synchronized between the PMS and RG Bridge.

Reliability Mechanisms and Constraints

Single Hotel Specification:

  • Only one hotel can be specified in a request message.

Multiple Room Types Update:

  • Multiple room types for the same hotel can be updated in one message exchange.

Rate Type Handling:

  • If a rate type is not specified along with the room type in an update, the update is applied to all products defined for that room type.

Volume of Messages:

  • Due to the high volume of messages exchanged between RG and the PMS, it is essential to implement the reliability mechanisms and constraints described in Table B.

Type

Mechanism/Constraint

Description

Retry

Retry strategy for communication Failure and in case of specific errors returned in XML response

The Systems and PMS will have a retry mechanism in place for communication errors and business error.

Concurrency

Simultaneous connections per property <= 1

PMS RG Interface will establish a single connection per Property at any given time for updating the ARI events, and allows only one Connection per Property at a time for receiving the Booking Notifications.

Timeout

Time out after 60,000

milliseconds (1 minute)

Idle connections (no packets sent by either side) for

more than 1 minute are closed. These should be considered as incomplete and implement are try strategy to re-send data.

Character

Set

Support for UTF-8

All messages exchanged must have UTF-8 encoding

Hotels

Onlydatarelatedtoone hotel can be sent in a single request message

Room Types

Maximum number of

room types in a single request message must be less than 10

Rate Types

Maximum number of rate types in a single request message must be less than 10

Date Range

366 Days

Maximum number of days that a single request message could update must not exceed 366 days.

Message

Size

400 KB

Maximum size for a single message must not exceed 400 KB.