Transmission of the inventories based on OTA_HotelAvailNotifRQ / OTA_HotelAvailNotifRS

The Hotel-Spider system will send an OTA_HotelAvailNotifRQ request to the online booking system every time a change in room availabilities has been detected on our system.

Other usages of OTA_HotelAvailNotifRQ / OTA_HotelAvailNotifRS

Beside transmitting room availabilities, the OTA_HotelAvailNotifRQ / OTA_HotelAvailNotifRS message pair can also be used to transmit booking rules (MinLOS, MaxLOS, Closed to Arrival, Closed to Departure, etc..) as well as the room-based price. Check the corresponding chapters to see use cases.

The Hotel-Spider system will send the following request

OTA_HotelAvailNotifRQ

<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" EchoToken="" Target="Test" Version="1.005">
  <POS>
    <Source>
      <RequestorID ID="MASTERUSERNAME" MessagePassword="MASTERPASSWORD" Type="13"></RequestorID>
    </Source>
  </POS>
  <AvailStatusMessages HotelCode="HOTELCODE">
    <AvailStatusMessage BookingLimit="25" LocatorID="1">
      <StatusApplicationControl Start="2015-09-24" End="2015-09-24" InvTypeCode|InvCode="00P5519245316dc1"/>
    </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:

Name	Mandatory	Description
BookingLimit	Yes	The number of available rooms
LocatorID	No	Can be used to communicate back to the sender exactly which transaction may have had a problem (e.g. "Message 214 had an invalid date range").

Child elements: StatusApplicationControl

StatusApplicationControl

Parent: Inventory

Mandatory: yes

Attributes:

Name	Mandatory	Description
InvCode \| InvTypeCode	Yes	The ID of the room type on the online booking system. Per Booking Channel the Hotel-Spider can send either InvCode or InvTypeCode so please communicate us your preference.
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

RatePlanCode attribute use scenario

The RatePlanCode attribute will only be transmitted if the online booking system manages the availabilities on product level.

The online booking system must respond with either of the following formats

Use case 1. OTA_HotelAvailNotifRS confirmation

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

Use case 2. OTA_HotelAvailNotifRS error notification

<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: NotProcessed Incomplete Complete Unknown
ShortText	Yes	A short textual explanation of the error
Tag	Yes	Indicates which element and/or attribute provoked the error to occur

Child elements: None