HotelARIGetRS

  • HotelARIGetRS:

    • OTA should respond to the HotelARIGetRQ request by sending a HotelARIGetRS message.

Validation and Errors:

  • Response messages indicating failures must contain at least one error element. It is possible to return more than one error element.

Successful Response:

  • After validating the hotel code and the product, the OTA should:

    • Return a HotelARIGetRS message with a single Success element.

    • Return the ARI information for the products for the hotel in the request.

  • HotelARIDataSet Node:

    • The response message must include one <HotelARIDataSet> node.

    • Inside this element, one HotelARIData node should be included for each date in the date range.

    • In case there is no data loaded for any given date, the HotelARIData node may be replaced with a HotelARIStatus node.

Product Identification:

  • DirectConnect identifies a product by room type and rate type.

Allotment and Restrictions:

  • Allotment is supported at the Room Level.

  • In response XML, Allotment returns at Room Level along with all other restrictions/settings, if applicable.

Element/@Attribute

Parent Xpath

Description

Mandatory

@TimeStamp

/HotelARIGetRS

Time of the transaction in XML schema date-time format.

Y

@Version

/HotelARIGetRS

The version of the message schema. For this version of the specification, set to

“1.0”

Y

Success

/HotelARIGetRS

If included, this element will indicate that the request message was successfully processed.

If this element is returned, a Product element must also be returned. Either a

Success element or an Error element is required in every response.

Y

Errors

/HotelARIGetRS

If included, this element will indicate that the request message could not be processed.

Y?

Error

/HotelARIGetRS/Errors

Description of cause for a fatal problem during request message processing.

*If an Errors element is included, at least one Error element is required.

Y

@Type

/HotelARIGetRS/Errors/Error

This is an enumeration of error types.

See Code Lists below for supported values. Code list ErrorTypes

Y

@Code

/HotelARIGetRS/Errors/Error

This is an enumeration of error codes.

See the Code Lists below for supported values. Code list Error Codes.

Y

HotelARIDataSet

/HotelARIGetRS

This element contains ARI information.

Y

@HotelCode

/HotelARIGetRS/HotelARIDataSet

This attribute identifies the hotel for which the ARI information is given.

Y

HotelARIData

/HotelARIGetRS/HotelARIDataSet

The element is used to transfer the ARI information for a product for a date range (with day-of-week applicability). If different sets o values need to be specified for a single date range based on different days of week applicability, separate HotelARIData elements must be used.

Y

@ItemIdentifier

/HotelARIGetRS/HotelARIDataSet/HotelARIData

A number identifying a HotelARIData element in a HotelARIDataSet collection. Useful for correlating request and response message items.

Y

ProductReference

/HotelARIGetRS/HotelARIDataSet/HotelARIData

Identifies the product for which the ARI information is given.

Y

@InvTypeCode

/HotelARIGetRS/HotelARIDataSet/HotelARIData/ProductReference

Identifies the room type for which the ARI information is being returned.

Y

@RatePlanCode

/HotelARIGetRS/HotelARIDataSet/HotelARIData/ProductRefere nce

Identifies the rate type for which the ARI information is being returned.

Y

ApplicationControl

/HotelARIGetRS/HotelARIDataSet/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

/HotelARIGetRS/HotelARIDataSet/HotelARIData/ApplicationContro l

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

/HotelARIGetRS/HotelARIDataSet/HotelARIData/ApplicationContro l

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

/HotelARIGetRS/HotelARIDataSet/HotelARIData

This element contains Rate amounts for each check-in date between Start date & End date

N

@Currency

/HotelARIGetRS/HotelARIDataSet/HotelARIData/RateAmoun ts

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

Base

/HotelARIGetRS/HotelARIDataSet/HotelARIData/RateAmoun ts

The base rates. The rates could be expressed as “Room” rates or occupancy-based prices. 1 Adult, 2 Adults etc are commonly used base occupancies.

N

@OccupancyCode

/HotelARIGetRS/HotelARIDataSet/HotelARIData/RateAmounts/ Bas e

The code of the base occupancy. See the Code Lists section for supported values. Code list Occupancy Codes.

Y

@Amount

/HotelARIGetRS/HotelARIDataSet/HotelARIData/RateAmounts/ Bas e

The rate amount for this occupancy in the currency mentioned above.

Y

MealPlans

/HotelARIGetRS/HotelARIDataSet/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&Breakfast, Full Board, Half Pension etc.

N

MealPlan

/HotelARIGetRS/HotelARIDataSet/HotelARIData/

RateAmounts/MealPlans

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

N

@MealPlanCode

/HotelARIGetRS/HotelARIDataSet/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

/HotelARIGetRS/HotelARIDataSet/HotelARIData/RateAmoun ts

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

N

@OccupancyCode

/HotelARIGetRS/HotelARIDataSet/HotelARIData/RateAmoun ts

/Additional

The code of the additional occupancy. See the Code Lists section for supported values. Code list Occupancy Codes.

Y

@Amount

/HotelARIGetRS/HotelARIDataSet/HotelARIData/RateAmoun ts

/Additional

The rate amount for this occupancy in the currency mentioned above.

Y

Availability

/HotelARIGetRS/HotelARIDataSet/HotelARIData

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

N

@Master

/HotelARIGetRS/HotelARIDataSet/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. For that matter, this restriction could also be considered to be equivalent to ‘Stop Sell’.

N

@Arrival

/HotelARIGetRS/HotelARIDataSet/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 this element is not passed, it is assumed as Open for arrival.

N

@Departure

/HotelARIGetRS/HotelARIDataSet/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 this element is not passed, it is assumed as Open for departure.

N

BookingLimit

/HotelARIGetRS/HotelARIDataSet/HotelARIData

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

N

@FreeSale

/HotelARIGetRS/HotelARIDataSet/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

/HotelARIGetRS/HotelARIDataSet/HotelARIData/BookingLi mit

This element is used to transfer information on any dynamically allocated hotel inventory. RezGain is a platform for

optimizing the distribution of available hotel inventory toOTAs.

N

@Sold

/HotelARIGetRS/HotelARIDataSet/HotelARIData/BookingLimit/TransientAllotment

This attribute indicates the number rooms already sold by the OTA out of dynamically allocated inventory. It is important to understand that if this attribute is used, the Application Control element must refer to a single date rather than a range of dates.

N

@Allotment

/HotelARIGetRS/HotelARIDataSet/HotelARIData/BookingLi mit

/TransientAllotment

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

N

BookingRules

/HotelARIGetRS/HotelARIDataSet/HotelARIData

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

N

MinAdvancedBookingOffset

/HotelARIGetRS/HotelARIDataSet/HotelARIData/

/BookingRules

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

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

N

MaxAdvancedBookingOffset

/HotelARIGetRS/HotelARIDataSet/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

/HotelARIGetRS/HotelARIDataSet/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

/HotelARIGetRS/HotelARIDataSet/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

/HotelARIGetRS/HotelARIDataSet/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 thestaydates of the booking includes any of the dates referred in the Application Control element.

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

N

MaxLoSThrough

/HotelARIGetRS/HotelARIDataSet/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

/HotelARIGetRS/HotelARIDataSet/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

HotelARIStatus

/HotelARIGetRS/HotelARIDataSet

This element is used to return status information where ARI data is not available or cannot be returned.

N

ProductReference

/HotelARIGetRS/HotelARIDataSet

The product for which the status is sent is specified in this element. Please refer to the description of this element under HotelARIData above.

Y

ApplicationControl

/HotelARIGetRS/HotelARIDataSet

The date range for which the status is sent is specified in this element. Please refer to the description of this element under HotelARIData above.

Y

Status

/HotelARIGetRS/HotelARIDataSet

The status of ARI data on the OTA. This can be used to return an error if the ARI information is not available.

N

@Code

/HotelARIGetRS/HotelARIDataSet/Status

Code 842 can be used to indicate that rates have not been loaded yet for this product for this date range. This is an enumeration of error codes. See Code Lists below for supported values. Code list Error Codes.

N

Last updated