The OTA_HotelBookingRuleNotifRQ
is the message that sends the notification of the rules and restrictions affecting the availability status of the hotel. Currently Smarthotel supports the following restrictions:
<?xml version="1.0" encoding="utf-8"?>
<OTA_HotelBookingRuleNotifRQ EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
<POS>
<Source>
<RequestorID ID="APIKEY" MessagePassword="APIPASSWORD"/>
</Source>
</POS>
<RuleMessages HotelCode="12345">
<RuleMessage>
<StatusApplicationControl InvTypeCode="1" RatePlanCode="1" Start="2018-07-24" End="2018-07-31" Mon="true" Fri="true" />
<BookingRules>
<BookingRule>
<RestrictionStatus Restriction="Master" Status="Open" />
<RestrictionStatus Restriction="Arrival" Status="Close" />
<RestrictionStatus Restriction="Departure" Status="Close" />
<LengthsOfStay>
<LengthOfStay MinMaxMessageType="SetMinLOS" Time="2" />
<LengthOfStay MinMaxMessageType="SetMaxLOS" Time="7" />
</LengthsOfStay>
</BookingRule>
</BookingRules>
</RuleMessage>
</RuleMessages>
</OTA_HotelBookingRuleNotifRQ>
Element / @Attribute | Parent | Info | Values | Occurrence |
---|---|---|---|---|
RuleMessages | OTA_HotelBookingRuleNotifRQ | Container for the individual RuleMessage(s). An OTA_HotelBookingRuleNotifRQ contains the booking rules for a single hotel. Hotel identification information are the attributes of this element. | 1..n | |
@HotelCode | RuleMessages | The ID of the hotel. | [integer] | 1 |
RuleMessage | RuleMessages | Container for the collection of Booking Rules for a given hotel or chain. | 1..n | |
StatusApplicationControl | RuleMessage | Information on what the BookingRule Message applies to (i.e. the combination of inventory and rate codes) and the period of application. The StatusApplicationControl class is used to indicate to which block codes/rate plans/inventory codes a status should be applied. | 1 | |
@InvTypeCode | StatusApplicationControl | The ID of the room. | [integer] | 1 |
@InvType | StatusApplicationControl | Optional attribute to be included when a bed type in a room needs to be updated. Always set to BedType . Omit when updating a room. |
BedType |
0..1 |
@InvCode | StatusApplicationControl | Optional attribute to be included when a bed type in a room needs to be updated. Indicates the ID of the bed type. | [integer] | 0..1 |
@RatePlanCode | StatusApplicationControl | The ID of the rate. | [integer] | 1 |
@Start | StatusApplicationControl | The starting value of the time span. | [yyyy-MM-dd] | 1 |
@End | StatusApplicationControl | The ending value of the time span. | [yyyy-MM-dd] | 1 |
@Mon, @Tue, @Weds, @Thur, @Fri, @Sat, @Sun | StatusApplicationControl | When true , applies only to a particular day. |
true false |
0..1 |
BookingRules | RuleMessage | Container for the collection of Booking Rules which apply for the information indicated in the StatusApplicationControl element. A collection of BookingRule. | 1 | |
BookingRule | BookingRules | The BookingRule element defines restrictions to rates and stays at the hotel for a given rate plan, room type or rate plan/room type combination. | 1..n | |
RestrictionStatus | BookingRule | Availability status assigned to the room rate combination for this booking rule. | 0..n | |
@Restriction | RestrictionStatus | Indicates the type of the restriction. | Arrival Departure Master (default) |
0..1 |
@Status | RestrictionStatus | The status. | Open Close |
1 |
LengthsOfStay | BookingRule | A collection of lengths of stay. A collection of LengthOfStay. | 0..1 | |
LengthOfStay | LengthsOfStay | A collection of patterns defining allowable lengths of stay (LOS). | 1..n | |
@MinMaxMessageType | LengthOfStay | An enumerated type used to define how the minimum and maximum LOS is applied. | SetMinLOS SetMaxLOS |
1 |
@Time | LengthOfStay | Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements. (Only applicable for MinMaxMessageType SetMinLOS and SetMaxLOS .) |
[integer] | 0..1 |
The OTA_HotelBookingRuleNotifRS
is the message used to indicate the status of processing the OTA_HotelBookingRuleNotifRQ
message.
<?xml version="1.0" encoding="utf-8"?>
<OTA_HotelBookingRuleNotifRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
<Success />
<UniqueID ID="123456" Type="18" />
</OTA_HotelBookingRuleNotifRS>
Element / @Attribute | Parent | Info | Values | Occurrence |
---|---|---|---|---|
UniqueID | OTA_HotelBookingRuleNotifRS | An identifier used to uniquely reference an object in a system. | 1 | |
@ID | UniqueID | The queue ID. | [integer] | 1 |
@Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT). Value: 18 = Other |
1 |