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. Direct Connect - Demand (Push)
  4. Interface Specifications – ARI Service
  5. Operation: ARI Update

HotelARIUpdateRQ

  • DirectConnect will use this message to request the OTA to update the ARI information.

  • The information will be sent at the product level.

Allotment:

  • Allotment is supported at the Room Level only.

  • Product Reference: Only InvTypeCode is required in the Product reference.

Element/@Attribute

Parent XPath

Description

Mandatory

@TimeStamp

/HotelARIUpdateRQ

Time of the transaction in xml schema date time format

Y

@Version

/HotelARIUpdateRQ

For this version of the specification set to “1.0”

Y

Authentication

/HotelARIUpdateRQ

All DirectConnect request messages would include an Authentication element. A set of UserName and Password are passed.

Y

@UserName

/HotelARIUpdateRQ/Authentication

The UserName part of the credentials. UserName and Password combination (credentials) required to authorize the request are sent in these attributes.

Y

@Password

/HotelARIUpdateRQ/Authentication

The Password part of the credential.

Y

HotelARIUpdateRequest

/HotelARIUpdateRQ

Contains rate changes for a given hotel. Only the updates of a single product are sent in one request.

Y

@HotelCode

/HotelARIUpdateRQ/HotelARIUpdateRequest

Hotel code of the property whose ARI information is being updated.

Y

@UpdateType

/HotelARIUpdateRQ/HotelARIUpdateRequest

Specifies the type of update i.e. “Partial”. RezGain currently only sends “Partial” updates.

If update type is “Partial”, OTA should overwrite only the values which are specifically passed in the update and retain previously set values for other ARI information. If any element or attribute is missing, they are assumed to retain their previously set values. For example, if Availability information is not passed in the update the OTA must continue to apply the previously set values of Availability for the dates specified. It should be noted that the

OTA could have different values set previously for the dates specified in the update and they should all be retained as is. If an allocation is specified in the update, Free Sale should be turned off.

Y

@InvTypeCode

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /ProductReference

Identifies the room type for which the ARI information is given.

Y

@RatePlanCode

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /ProductReference

Identifies the rate type for which the AR information is given.

Need to be absent in case of Allocation TransientAllotment update.

N

ApplicationControl

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

Identifies the date range that the ARIData applies to.

If any one of the day of week attributes are passed, they all must be passed.

If no day of week attribute is passed, it is assumed that the ARI data applies to all dates within the start date and end dates.

Y

@Start

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /ApplicationControl

The start date of the date range for which the

ARI data applies. The date range includes the start date.

Date format : YYYY-MM-DD

Y

@End

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /ApplicationControl

The end date of the date range for which the ARI data applies. The date range includes the end date.

Date format : YYYY-MM-DD

Y

RateAmounts

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

This element contains the rates and meal plan information.

N

@Currency

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /RateAmounts

The currency of the rates.This must be the primary currency of the hotel. Three letter ISO code.

Y

Base

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /RateAmounts

The base rates. The rates could be expressed as

“Room” rates or occupancy based prices. Single Adult, Two Adults etc. are commonly used base occupancies.

If the UpdateType is “Partial”, OTA should only update the occupancies, which are passed and must retain the old prices for the other occupancies.

N

@OccupancyCode

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /RateAmounts/Base

The code of the base occupancy.

See the Code Lists section for supported values.

Code list Occupancy Codes.

N

@Amount

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /RateAmounts/Base

The rate amount for this occupancy.

N

MealPlans

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /RateAmounts

This element contains the meal plans available for this rate. Meal Plan is also commonly referred to as Board and Pension. For example Bed and Breakfast, Full Board, Half Pension etc.

N

MealPlan

/HotelARIUpdateRQ/HotelARIUpdateRequest /HotelARIData/RateAmounts/MealPlans

This element provides information on one o the meal plan available for this product.

N

@MealPlanCode

/HotelARIUpdateRQ/HotelARIUpdateRequest

/HotelARIData/RateAmounts/MealPlans/MealPlan

The code of the meal plan. Full Board, Half Board, Bed and Breakfast, Room only etc. are commonly used meal plans.

See the Code Lists section for supported values. (Code list Meal Plan Codes).

Mandtory if MealPlan node is present

Y

Additional

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /RateAmounts

Rate amounts for additional occupancies. Extra Adult, Extra Child etc. are commonly used additional occupancies.

If the UpdateType is “Partial”, OTA should only update the occupancies which are passed and must retain the old prices for the other occupancies.

N

@OccupancyCode

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData/RateAmounts/Additional

The code of the additional occupancy.

See the Code Lists section for supported values.

Code list Occupancy Codes.

N

@Amount

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /RateAmounts/Additional

The rate amount for this occupancy.

N

Availability

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

This element provides information regarding the availability of the hotel product.

N

@Master

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

/Availability

This is the master availability. If master is ‘Closed’, the product is not bookable if any of the stay dates includes one of the dates specified by the

Application Control element. If master is

‘Open’, additional restrictions on arrival and departure may be placed. OTA is expected to retain the ARI information when the master availability is changed from ‘Open’ to ‘Closed’, so that when the availability becomes ‘Open’ once again, the previously set values of price and other restrictions could be restored.

N

@Arrival

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

/Availability

This is an availability restriction commonly referred to as Closed To Arrival (CTA). If Arrival availability is ‘Closed’, the product is not bookable if the first date of the stay is one of the dates specified by the Application Control element.

If the UpdateType is “Partial”, and this attribute is not passed, the OTA should

retain the previously existing value of this restriction.

N

@Departure

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

/Availability

This is an availability restriction commonly referred to as Closed To Departure (CTD). If

Departure availability is ‘Closed’, the

product is not bookable if the last date of the stay is one of the dates specified by the Application Control element.

If the UpdateType is “Partial”, and this attribute is not passed, the OTA should

retain the previously existing value of this restriction.

N

BookingLimit

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

This element contains information on the allocation of inventory to the OTA.

N

@FreeSale

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /BookingLimit

Indicates if the hotel has removed all booking limits for this product for this date range.

If this element is not passed, it is assumed that

‘Free Sale’ is off. Further, it is understood that the product would be bookable subject to the limits given below. If this element is set to ‘On’, the OTA may sell the product without regard to the limits given below.

N

TransientAllotment

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /BookingLimit

This element is used to transfer informationon any dynamically allocated hotel inventory. RezGain is a platform for optimizing the distribution of available hotel inventory to OTAs.

N

@Allotment

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData /BookingLimit/TransientAllotment

The number of rooms received in allotment by the hotel under dynamic allocation.

If a negative value is received, the OTA must treat it as a value of 0 and must not offer the product for booking unless Free Sale is set to On.

BookingRules

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

This element contains booking rules. Booking rules are additional restrictions placed by the hotel on bookings of this product.

If the UpdateType is “Partial”, the OTA should only update the values of the restrictions that are passed in the update.

It is assumed that the minimum possible length of stay is 1 and that a MinLoS of 0 is functionally equivalent to MinLoS of 1.

N

MinAdvancedBookingOffset

This element indicates the minimum number of days before the check-in date after which the product is not available to be booked.

N

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData/Bo okingRules

This restriction is usually used to offer discounts on early bookings.

MaxAdvancedBookingOffset

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

/

/BookingRules

This element indicates the maximum number of days before the check-in date before which the product is not available to be booked.

This restriction is usually used to offer last minute discounts on unsold inventory.

N

MinLoSOnArrival

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

/BookingRules

This element indicates the minimum number of nights for which a stay must be booked to obtain this rate. Applies only to bookings where the first date of the booking is one of the dates referred in the Application Control element.

This restriction is usually used to offer discounts on longer stays.

N

MaxLoSOnArrival

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

/BookingRules

This element indicates the maximum number of nights for which a stay can be booked to obtain this rate. Applies only to bookings where the first date of the booking is one of the dates referred in the Application Control element.

N

MinLoSThrough

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

/BookingRules

This element indicates the minimum number of nights for which a stay must be booked to obtain this rate. Applies to bookings where anyof the stay dates of the booking includes any of the dates referred in the Application Control element.

N

MaxLoSThrough

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

/BookingRules

This element indicates the maximum number of nights for which a stay can be booked at this rate. Applies to bookings where any of the stay dates of the booking includes any of the dates referred in the Application Control element.

N

Description

/HotelARIUpdateRQ/HotelARIUpdateRequest/HotelARIData

Reserved for future use.

This element is used to provide a textual description of the product. Usually used to describe the special features of the room or rate. Also used commonly to describe what is included in the price.

N

Last updated 3 months ago