Rooms and Rates
Message Exchange Workflow
OTA_HotelAvailRQ
- request made by SiteMinder to the Booking Channel endpoint.OTA_HotelAvailRS
- response sent by the Booking Channel.
Request
Example
<OTA_HotelAvailRQ
xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0" AvailRatesOnly="true">
<AvailRequestSegments>
<AvailRequestSegment AvailReqType="Room">
<HotelSearchCriteria>
<Criterion>
<HotelRef HotelCode="HOTELCODE"/>
</Criterion>
</HotelSearchCriteria>
</AvailRequestSegment>
</AvailRequestSegments>
</OTA_HotelAvailRQ>
Specification
OTA_HotelAvailRQ
Element
1
Root element for the request.
@xmlns
String
1
Defines the XML namespace for the request. Will be set to http://www.opentravel.org/OTA/2003/05
@EchoToken
String
1
Unique identifier for the request, used to match requests and responses.
@TimeStamp
DateTime
1
Time when the request was generated.
@Version
String
1
Specifies the API version. Will be set to 1.0
.
@AvailRatesOnly
Boolean
1
Indicates that only availability rates should be returned. Will be set to true
.
AvailRequestSegments
Element
1
Container for availability request segments.
AvailRequestSegment
Element
1
Single availability request segment.
@AvailReqType
String
1
Specifies the type of availability request. Will be set to Room
.
HotelSearchCriteria
Element
1
Container for the hotel search criteria.
Criterion
Element
1
Single search criterion.
HotelRef
Element
1
Reference to a specific hotel.
@HotelCode
String
1
Identifier for the hotel.
Response
Examples
<OTA_HotelAvailRS
xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
<Success/>
<RoomStays>
<RoomStay>
<RoomTypes>
<RoomType RoomTypeCode="SGL">
<RoomDescription Name="Single Room">
<Text>Single bed for single occupancy.</Text>
</RoomDescription>
</RoomType>
</RoomTypes>
<RatePlans>
<RatePlan RatePlanCode="BAR">
<RatePlanDescription Name="Best Available Rate">
<Text>Best Available Rate.</Text>
</RatePlanDescription>
</RatePlan>
</RatePlans>
</RoomStay>
<!-- Additional RoomStay elements -->
</RoomStays>
</OTA_HotelAvailRS>
Additional Details
<OTA_HotelAvailRS
xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
<Success/>
<RoomStays>
<RoomStay>
<RoomTypes>
<RoomType RoomTypeCode="SGL">
<RoomDescription Name="Single Room">
<Text>Single bed for single occupancy.</Text>
</RoomDescription>
<Occupancy AgeQualifyingCode="10" MaxOccupancy="2"/>
</RoomType>
</RoomTypes>
<RatePlans>
<RatePlan RatePlanCode="BAR">
<RatePlanDescription Name="Best Available Rate">
<Text>Best Available Rate.</Text>
</RatePlanDescription>
<AdditionalDetails>
<AdditionalDetail Code="NO_RATES"/>
</AdditionalDetails>
</RatePlan>
</RatePlans>
</RoomStay>
<!-- Additional RoomStay elements -->
</RoomStays>
</OTA_HotelAvailRS>
Specification
OTA_HotelAvailRS
Element
1
Root element for the response.
@xmlns
String
1
Defines the XML namespace for the response. Must be set to http://www.opentravel.org/OTA/2003/05
@EchoToken
String
1
Unique identifier matching the request EchoToken
.
@TimeStamp
DateTime
1
Time when the response was generated.
@Version
String
1
Specifies the API version. Must be set to 1.0
.
Success
Element
0..1
Indicates successful processing of the request.
RoomStays
Element
0..1
Container for room stay information.
RoomStay
Element
1..n
Single room stay information.
RoomTypes
Element
1
Container for room types.
RoomType
Element
1
Single room type information.
@RoomTypeCode
String
1
Code for the room type.
RoomDescription
Element
1
Description of the room.
@Name
String
1
Name of the room.
Text
String
0..1
Description text for the room.
Occupancy
Element
0..1
Occupancy details for the room. Only for OBP.
@AgeQualifyingCode
Integer
1
Age qualification code for the occupancy:
10
Adult
Only for OBP.
@MaxOccupancy
Integer
1
Maximum occupancy for the room.
Min 1
- Max 50
Only for OBP.
RatePlans
Element
0..1
Container for rate plans.
RatePlan
Element
1
Single rate plan information.
@RatePlanCode
String
1
Code for the rate plan.
RatePlanDescription
Element
1
Description of the rate plan.
@Name
String
1
Name of the rate plan.
Text
String
0..1
Description text for the rate plan.
AdditionalDetails
Element
0..1
Additional details about the rate plan.
AdditionalDetail
Element
1..2
Single additional detail.
@Code
String
1
Codes:
NO_RATES
NO_AVAILABILITY
NO_UPDATES
Errors
Element
0..1
Indicates an error occurred during the processing of the request.
Error
Element
1..n
Single error information containing free text.
Help Centre
Last updated
Was this helpful?