Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

SiteConnect sends an OTA_HotelAvailRQ to retrieve a list of available rooms and their configurations.

The connected booking channel must return an OTA_HotelAvailRS with a list of RoomStays with all active room and configurations.

Note

Only use this message if your channel does NOT support Rate Codes.
If your channel supports Rate Codes, refer to Retrieve Room and Rate Codes documentation.

...

Element

Attribute

Number

Description

OTA_HotelAvailRS

1

Root element.

@TimeStamp

1

Time of the transaction in xml schema dateTime format. See TimeStamp.

Format like yyyy-MM-dd'T'HH:mm:ssZZ, (without fraction of a second)
i.e '2022-08-01T09:30:47+02:00')

See TimeStamp.

@Version

1

Always "1.0"

@EchoToken

1

Mirror the EchoToken in the OTA_HotelAvailRQ request that your system received. See EchoTokens.

OTA_HotelAvailRS / Success

0..1

Mandatory when success.
Should only be present if it was a successful response.
The Errors node should not be present if the Success node is present.

OTA_HotelAvailRS / RoomStays

0..1

A collection of RoomStay elements.

OTA_HotelAvailRS / RoomStays / RoomStay

1..n

Room stay details.

OTA_HotelAvailRS / RoomStays / RoomStay / RoomTypes / RoomType

1

Each RoomStay element should contain 1 RoomType.

@RoomTypeCode

1

The code identifying this room.

OTA_HotelAvailRS / RoomStays / RoomStay / RoomTypes / RoomType / RoomDescription

1

@Name

1

The room name. This name should be a unique description of the room. E.g. "Deluxe Double Room 1 King size bed". The hotel will use this value to identify the room.

OTA_HotelAvailRS / RoomStays / RoomStay / RoomTypes / RoomType / RoomDescription / Text

0..1

Additional text to describe the room.

OTA_HotelAvailRS / RoomStays / RoomStay / RoomTypes / RoomType / Occupancy

 

0..1

Mandatory, if your channel is using Occupancy Based Pricing.
This element must be included in the all OTA_HotelAvailRS messages for all RoomTypes.

Note

This information will only be used once when initially enabling Occupancy Based Pricing for an established channel, after which time the customer will set/update this value. The information is used to determine the number of occupants to supply rates for. We request that you continue to include it always, even after the initial enablement.

 

@AgeQualifyingCode

1

Mandatory if your channel is using Occupancy Based Pricing
This attribute must be included in all RoomType or RoomType+RatePlan combination.

Always “10” indicating the maximum adult occupancy of the room.

 

@MaxOccupancy

1

Mandatory if your channel is using Occupancy Based Pricing
This attribute indicates the max number of occupants for the RoomType or RoomType+RatePlan combination. This attribute must be included in all RoomType or RoomType+RatePlan combination.

Value Range: Min 1 - Max 50

OTA_HotelAvailRS / Errors

0..1

 Contains a list of errors in the event of a failed request

OTA_HotelAvailRS / Errors / Error

1..n

Mandatory if Errors present.

@Type

1

Mandatory if Errors present.
Any type from the OTA Error Warning Types (EWT) table can be used. In particular, the following types are recommended:

1: Unknown
12: Processing exception

The use of the following types under their respective conditions is mandatory:

4: Authentication (If username and password are not authenticated)
The text must be “Invalid Username and/or Password” in English language.

6: Authorisation (If authenticated username is not authorised to alter hotel data)
The text must be “Hotel not found for HotelCode=XXXXXX” in English language, replacing XXXXXX with HotelCode received in the OTA_HotelAvailRQ.

Note

For more information, refer to our Error Response Samples page.

@Code

0..1

Any code from the OTA Error Codes (ERR) table can be used. If @Code is present, the use of the following codes under their respective conditions is mandatory:

448: System error
392: Invalid hotel code

...