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
  • Service
  • Supported Restrictions and Occupancies
  1. Our Products
  2. Channel Manager
  3. Direct Connect - Demand (Push)
  4. Interface Specifications – ARI Service

Technical Overview

Service

The ARI Update Service provides four primary operations:

  1. List of Properties:

    • Request: HotelPropertyListGetRQ

    • Response: HotelPropertyListGetRS

  2. List of Products:

    • Request: HotelProductListGetRQ

    • Response: HotelProductListGetRS

  3. Fetch ARI Information:

    • Request: HotelARIGetRQ

    • Response: HotelARIGetRS

  4. Update ARI Information:

    • Request: HotelARIUpdateRQ

    • Response: HotelARIUpdateRS

Communication Protocols

  • Method: HTTP POST is used for the requested operations.

  • Request and Response Format: Each operation involves posting the appropriate request XML data, and the OTA returns the desired response XML data.

  • HTTP Content Type: text/xml

    • Example HTTP header:

Content-Type: text/xml; charset=utf-8

Authentication

  • Implementation: Authentication and authorization are both implemented using common credentials. See Hotel Authorization below for details.

Reliability Mechanisms and Constraints

  • Property List Message: Only one hotel can be specified in a request or response message, except for the Property List message.

  • Volume of Messages: Due to the high volume of messages exchanged between DirectConnect and the OTA, the mechanisms and constraints described in Table B must be implemented.

Type

Mechanism/Constraint

Description

Retry

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

The DirectConnect and OTA will have a retry mechanism in place for communication errors and business error.

Concurrency

Simultaneous connections per property Can be multithread

DirectConnect interface will establish multiple connections per Property for different room type at any given time for updating the ARI events.

Timeout

Time out after 60,000 milliseconds (1 minute)

Idle connections (no packets sent by either side) for more than 1 minute should be closed.

Character Set

Support for UTF-8

All messages exchanged must have UTF-8 encoding

Date Range

366 days

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

Message

Size

2 MB

Maximum size for a single message must not exceed 2 MB.

Supported Restrictions and Occupancies

Channel Manager Attribute

Attribute Type

Data Type

XML

Attribute

Description

Allocation

Settings

Integer

TransientAllotment

Number of rooms available to sellable

Available

Settings

Boolean

Master

Also known as Stopsell, ClosedOut or Availability. Denotes if Room is open or closed to sell

CTA

Restrictions

Boolean

Arrival

Closed to arrival. Room cannot booked if CTA is ON for a checking date

CTD

Restrictions

Boolean

Departure

Closed to departure. Room cannot booked if CTD is ON for a checkout date

FreeSale

Settings

Boolean

FreeSale

Unlimited number of rooms. No restrictions for restrictive units

MinLOS

Restrictions

Integer

MinLoSOnArrival

Minimum number of nights required to book a room w.r.t. check-in date

MinLOSThrough

Restrictions

Integer

MinLoSThrough

Minimum number of nights required to book a room w.r.t. complete stay dates

MaxLOS

Restrictions

Integer

MaxLoSOnArrival

Maximum number of nights required to book a room w.r.t. check-in date

MaxLOSThrough

Restrictions

Integer

MaxLoSThrough

Maximum number of nights required to book a room w.r.t. complete stay dates

MinAdvancePurchase

Restrictions

Integer

MinAdvancedBookingOffset

Minimum no. of days in advance a room can be booked

MaxAdvancePurchase

Restrictions

Integer

MaxAdvancedBookingOffset

Maximum no. of days in advance a room can be booked.

1Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A1"

Nightly rates of pax=[1Adult] for given room-rate combination

2Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A2"

Nightly rates of pax=[2Adult] for given room-rate combination

3Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A3"

Nightly rates of pax=[3Adult] for given room-rate combination

4Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A4"

Nightly rates of pax=[4Adult] for given room-rate combination

5Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A5"

Nightly rates of pax=[5Adult] for given room-rate

6Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A6"

Nightly rates of pax=[6Adult] for given room-rate combination

7Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A7"

Nightly rates of pax=[7Adult] for given room-rate combination

8Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A8"

Nightly rates of pax=[8Adult] for given room-rate combination

9Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A9"

Nightly rates of pax=[9Adult] for given room-rate combination

10Adult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="A10"

Nightly rates of pax=[10Adult] for given room-rate combination

1Child

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="C1"

Nightly rates of pax=[1Child] for given room-rate combination

2Child

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="C2"

Nightly rates of pax=[2Child] for given room-rate combination

3Child

Occupancy based Pricing (OPB)

Decimal

Base Amount

OccupancyCode="C3"

Nightly rates of pax=[3Child] for given room-rate combination

4Child

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="C4"

Nightly rates of pax=[4Child] for given room-rate combination

5Child

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="C5"

Nightly rates of pax=[5Child] for given room-rate combination

AdditionalAdult / ExtraAdult

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="AA"

Nightly rates of pax=[AdditionalAdult] for given room-rate combination

AdditionaChild / ExtraChild

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="AC"

Nightly rates of pax=[AdditionalAdult] for given room-rate combination

RoomPrice

Occupancy based Pricing

(OPB)

Decimal

Base Amount

OccupancyCode="SR"

Nightly rates of complete room for given room-rate combination

Last updated 3 months ago