Availability and Restrictions

Message Exchange Workflow

• OTA_HotelAvailNotifRQ - request made by SiteMinder to the Booking Channel endpoint.

• OTA_HotelAvailNotifRS - response sent by the Booking Channel.

Request

Examples

Request A

<OTA_HotelAvailNotifRQ
	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">
	<AvailStatusMessages HotelCode="HOTELCODE">
		<AvailStatusMessage BookingLimit="10"> <!-- Availability -->
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<RestrictionStatus Status="Open"/> <!-- Stop Sell -->
		</AvailStatusMessage>
		<AvailStatusMessage>
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<LengthsOfStay>
				<LengthOfStay MinMaxMessageType="SetMinLOS" Time="1"/> <!-- Min Length of Stay -->
				<LengthOfStay MinMaxMessageType="SetMaxLOS" Time="3"/> <!-- Max Length of Stay -->
			</LengthsOfStay>
		</AvailStatusMessage>
		<AvailStatusMessage>
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<RestrictionStatus Restriction="Arrival" Status="Open"/> <!-- Close to Arrival (CTA) -->
		</AvailStatusMessage>
		<AvailStatusMessage>
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<RestrictionStatus Restriction="Departure" Status="Open"/> <!-- Close to Departure (CTD) -->
		</AvailStatusMessage>
		<!-- Additional AvailStatusMessage elements -->
	</AvailStatusMessages>
</OTA_HotelAvailNotifRQ>

Request B

<OTA_HotelAvailNotifRQ
	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">
	<AvailStatusMessages HotelCode="HOTELCODE">
		<AvailStatusMessage BookingLimit="10"> <!-- Availability -->
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<RestrictionStatus Status="Open"/> <!-- Stop Sell -->
		</AvailStatusMessage>
		<AvailStatusMessage>
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<LengthsOfStay>
				<LengthOfStay MinMaxMessageType="SetForwardMinStay" Time="1"/> <!-- Min Length of Stay -->
				<LengthOfStay MinMaxMessageType="SetForwardMaxStay" Time="3"/> <!-- Max Length of Stay -->
			</LengthsOfStay>
		</AvailStatusMessage>
		<AvailStatusMessage>
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<RestrictionStatus Restriction="Arrival" Status="Open"/> <!-- Close to Arrival (CTA) -->
		</AvailStatusMessage>
		<AvailStatusMessage>
			<StatusApplicationControl End="2024-10-05" InvTypeCode="SGL" RatePlanCode="BAR" Start="2024-10-05"/>
			<RestrictionStatus Restriction="Departure" Status="Open"/> <!-- Close to Departure (CTD) -->
		</AvailStatusMessage>
		<!-- Additional AvailStatusMessage elements -->
	</AvailStatusMessages>
</OTA_HotelAvailNotifRQ>

Specification

Element / @Attribute	Type	M	Description
OTA_HotelAvailNotifRQ	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.
AvailStatusMessages	Element	1	Container for availability status messages.
@HotelCode	String	1	Identifier for the hotel.
AvailStatusMessage	Element	1	Single availability status message.
@BookingLimit	Integer	1	Sets the number of rooms available for sale.
StatusApplicationControl	Element	1	Contains date and room identification information.
@Start	Date	1	The start date for which the update is being set. This date is inclusive.
@End	Date	1	The end date for which the update is being set. This date is inclusive.
@InvTypeCode	String	1	Identifies the room.
@RatePlanCode	String	1	Identifies the rate.
LengthsOfStay	Element	0..2	Used for Minimum Stay and Maximum Stay.
LengthOfStay	Element	1	Single length of stay information.
@MinMaxMessageType	String	1	Can be one of the following: SetMinLOS SetMaxLOS SetForwardMinStay SetForwardMaxStay
@Time	Integer	0..1	Specifies the number of days related to a stay. Valid range: 1 to 9999. Will be excluded if no SetMaxLOS or SetForwardMaxStay is set.
RestrictionStatus	Element	0..1	Used to restrict the room for Stop Sell, Closed to Arrivals, and Closed to Departure.
@Status	String	1	Values: Open (opens room for sale) Close (closes room for sale)
@Restriction	String	0..1	Values: Arrival (closes to arrival) Departure (closes to departure) If no type is specified, assume a full close or open for the room date.

Response

Examples

Success

<OTA_HotelAvailNotifRS
	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/>
</OTA_HotelAvailNotifRS>

Error

<OTA_HotelAvailNotifRS
	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">
	<Errors>
		<Error Type="6" Code="392">Hotel not found for HotelCode=HOTELCODE</Error>
	</Errors>
</OTA_HotelAvailNotifRS>

Specification

Element / @Attribute	Type	M	Description
OTA_HotelAvailNotifRS	Element	1	Root element for the response.
@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 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.
Errors	Element	0..1	Indicates an error occurred during the processing of the request.
Error	Element	1..n	Single error information containing free text.
@Type	Integer	1	Type of error. Refer to Error Warning Types (EWT).
@Code	Integer	0..1	Code representing the error. Refer to Error Codes (ERR).

Help Centre

• Learn about the inventory grid
• Update rates, availability, and restrictions in the inventory grid
• Troubleshoot when inventory is not syncing, or is showing incorrectly on a channel
• Video: Overview of the inventory grid

Testing and Certification

Error Handling

Glossary