Transmission of the booking rules based on OTA_HotelAvailNotifRQ / OTA_HotelAvailNotifRS
The OTA_HotelAvailNotifRQ / OTA_HotelAvailNotifRS can be used to transmit the booking rules on all the agreed levels. A request will be send every time a change in the booking rules has been detected on our system.
Other usages of OTA_HotelAvailNotifRQ / OTA_HotelAvailNotifRS
Determining the level for the booking rules
To indicate for which level (hotel, room type, rate plan or product) a booking rule should be applied, the attributes InvCode and/or RatePlanCode are used. In the Hotel-Spider system all the booking rules can be managed on all 4 levels. However a specific booking rule will only be accessible if at least one connected channel requires it.
<StatusApplicationControl Start="2015-09-24" End="2015-10-14" />
<StatusApplicationControl Start="2015-09-24" End="2015-10-14" InvCode="00P5519245316dc1" />
<StatusApplicationControl Start="2015-09-24" End="2015-10-14" RatePlanCode="00P551924536469f" />
<StatusApplicationControl Start="2015-09-24" End="2015-10-14" InvCode="00P5519245316dc1" RatePlanCode="00P551924536469f" />
The Hotel-Spider system will send the following request
<OTA_HotelAvailNotifRQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.opentravel.org/OTA/2003/05" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelAvailNotifRQ.xsd" TimeStamp="2012-10-05T14:20:50" Target="Test" Version="1.000" EchoToken=""> <POS> <Source> <RequestorID ID="MASTERUSERNAME" MessagePassword="MASTERPASSWORD" Type="13"></RequestorID> </Source> </POS> <AvailStatusMessages HotelCode="1234HotelCode"> <AvailStatusMessage> <StatusApplicationControl Start="2015-09-24" End="2015-10-14" InvTypeCode="00P5519245316dc1" RatePlanCode="00P551924536469f" /> <LengthsOfStay> <LengthOfStay Time="2" MinMaxMessageType="SetMinLOS"/> <LengthOfStay Time="5" MinMaxMessageType="SetMaxLOS"/> </LengthsOfStay> <RestrictionStatus Restriction="Master" Status="Open"/> <RestrictionStatus Restriction="Arrival" Status="Open"/> <RestrictionStatus Restriction="Departure" Status="Open"/> <RestrictionStatus MinAdvancedBookingOffset="P2W" MaxAdvancedBookingOffset="P1Y"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
Request structure
OTA_HotelAvailNotifRQ
Parent: None (Root element)
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
TimeStamp | Yes | The format should respect the ISO 8601 2015-11-16T22:23:48+00:00 |
Target | Yes | When sending updates to the staging environment "Test" must be used. When sending updates to the production environment "Production" must be used. |
Version | Yes | The default value should be "1.000" |
EchoToken | Yes | This string should be returned in the response |
Child elements: POS (when using POS authentication. See Authentication methods for more information), AvailStatusMessages
AvailStatusMessages
Parent: OTA_HotelAvailNotifRQ
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
HotelCode | Yes | The ID of the hotel on the online booking system |
Child elements: AvailStatusMessage
AvailStatusMessage
Parent: Inventories
Mandatory: yes
Attributes: None
Child elements: StatusApplicationControl
StatusApplicationControl
Parent: Inventory
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
InvCode | No | The ID of the room type on the online booking system |
RatePlanCode | No | The ID of the rate plan on the online booking system |
Start | Yes | The format will respect ISO 8601 2015-11-16 |
End | Yes | The format will respect ISO 8601 2015-11-16 |
Mon | No | Does this update apply to a Monday |
Tue | No | Does this update apply to a Tuesday |
Weds | No | Does this update apply to a Wednesday |
Thur | No | Does this update apply to a Thursday |
Fri | No | Does this update apply to a Friday |
Sat | No | Does this update apply to a Saturday |
Sun | No | Does this update apply to a Friday |
Child elements: None
LengthsOfStay
Parent: AvailStatusMessage
Mandatory: yes
Attributes: None
Child elements: LengthOfStay
LengthOfStay
Parent: LengthsOfStay
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
Time | Yes | The new price to apply on the online booking system |
MinMaxMessageType | Yes | Possible values are:
|
Child elements: None
RestrictionStatus
Parent: AvailStatusMessage
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
Restriction | No | Possible values:
|
Status | No | Possible values are:
|
MinAdvancedBookingOffset | No | Value is given using the ISO 8601 Duration notation |
MaxAdvancedBookingOffset | No | Value is given using the ISO 8601 Duration notation |
Child elements: None
The online booking system must respond with either of the following formats
<OTA_HotelAvailNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2015-11-25T17:21:43+01:00" EchoToken="" CorrelationID="" Version="1.0"> <Success /> </OTA_HotelAvailNotifRS>
<OTA_HotelAvailNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2015-11-25T17:21:43+01:00" EchoToken="" CorrelationID="" Version="1.0"> <Errors> <Error Code="3008" Type="13" Status="NotProcessed" ShortText="Processing error" Tag="/">Hotel ID invalid</Error> </Errors> </OTA_HotelAvailNotifRS>
Response structure
OTA_HotelAvailNotifRS
Parent: None (Root element)
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
TimeStamp | Yes | The format should respect the ISO 8601 2015-11-16T22:23:48+00:00 |
Target | Yes | When sending updates to the staging environment "Test" must be used. When sending updates to the production environment "Production" must be used. |
Version | Yes | The default value should be "1.000" |
EchoToken | Yes | This string should be returned in the response |
Child elements: Success, Errors
Success
Parent: OTA_HotelAvailNotifRS
Mandatory: no
Attributes: None
Child elements: None
Errors
Parent: OTA_HotelAvailNotifRS
Mandatory: No
Attributes: None
Child elements: Error
Error
Parent: Errors
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
Code | Yes | The unique error code assigned by the online booking system |
Type | Yes | |
Status | Yes | Possible values are:
|
ShortText | Yes | A short textual explanation of the error. Max 64 characters. |
Tag | Yes | Indicates which element and/or attribute provoked the error to occur |
Child elements: None