Push API - Availability and Inventory

Element/@Attribute

Description

Occurrences

@TimeStamp

Time of the transaction in xml schema date-time format

1

@EchoToken

Unique Identifier to track the RQ/RS message

1

@Target

 Always set to “Production”

1

@Version

Always set to “1.0”

1

AvailStatusMessages

Contains list of availability messages (AvailStatusMessage)

1

@HotelCode

The code of the property whose availability is being updated

1

@HotelName

The name of the property whose availability is being updated

0..1

AvailStatusMessage

An availability message. One of the BookingLimit or RestrictionStatus or LengthsOfStay must be included

1..n

@BookingLimit

The number of rooms available. Optional, to be set at Room level

0…1

@BookingLimitMessageType

Always set to “SetLimit”. Mandatory if “BookingLimit” is available

0…1

StatusApplicationControl

The date range, room type code and rate code for which this notification is sent is specified in the element.

1

@Start

The start date for which the availability update is being set

1

@End

The end date for which the availability update is being set

1

@invCode

Identifies the Room type for which the availability is being updated. The room type code + rate code identify a unique product for which this update applies.

1

@RatePlanCode

Identifies the Rate plan for which the availability is being updated. Optional, in case of Inventory count (“BookingLimit”) only.

0..1

@UniqueID

Unique identifier for each availability message

1

@LengthsOfStay

Availability based on length of stay can be set using this. Optional

0..1

/OTA_HotelAvailNotifRQ/AvailStatusMessages/AvailStatusMessage

LengthOfStay

Mandatory if LengthsOfStay is present

 1

@Time

Mandatory if LengthOfStay is present. Sets the minimum number of days required for a stay.

1

@TimeUnit

 Mandatory if LengthOfStay is present. Always set to “Day”

1

@MinMaxMessageType

Mandatory if LengthOfStay is

present. Stay control type. Can be

any of the options below:

SetMinLOS : To set minimum length

of stay.

SetMaxLOS: To set maximum length

of stay.

1

RestrictionStatus

 Availability status assigned to the room rate combination.

0..1

@Status

The restriction status. Mandatory if

RestrictionStatus is present. Can be

any of the options below:

Open: The Sale is open.

Close: The Sale is closed.

ClosedOnArrival: Arrival is closed.

ClosedOnDeparture: Departure is

closed.

OpenOnArrival: Arrival is open.

OpenOnDeparture: Departure is

open.

ClosedOnArrivalDeparture: Both

Arrival & Departure is closed.

MinAdvancedBookingOffset:

Minimum number of days before

the arrival date the hotel is

bookable.

1

Element/@Attribute

Description

 Occurrences

@TimeStamp

Time of the transaction in XML schema date-time format

1

@EchoToken

Unique Identifier to track the RQ/RS message

1

@Target

 Always set to “Production”

1

@Version

Always set to “1.0”

1

@Success

If included this element will indicate that the request message was successfully processed. Either a Success element or Errors/error element(s) are required in every response.

0..1

Errors

Either a Success element or Errors/Error element are required in every response.

 0..1

Error

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

If an Errors element is included, one or more Error elements are required.

1

@Type

This is an enumeration of HTNG approved error types (OTA code list EWT). See appendix for supported values.

 1

This is an enumeration of

1

@Code

This is an enumeration of HTNG approved error codes (OTA code list ERR). See appendix for supported values.