Restriction
- David Martin
- Miquel Galobardes (Unlicensed)
Channel Manager API will send updates for restriction using OTA_HotelAvailNotifRQ message. Channel Manager API will receive the OTA_NotifReportRS and will save the succes or failure of the update.
OTA_HotelAvailNotifRQ
The OTA_HotelAvailNotifRQ message will be used to update the restriction for one Room Type for a single hotel.
Each message will contain a single AvailStatusMessages element with the attribute @HotelCode with the Hotel Code assigned by the Channel Manager.
There can be several AvailStatusMessage child elements per request to hold a data range but the message will be limited to one hotel.
<OTA_HotelAvailNotifRQ EchoToken="4863972f-2d2b-4b6f-bf64-cd4f95bf57ed" TimeStamp="2021-01-01T12:00:00.000Z" Version="1" xmlns="http://www.opentravel.org/OTA/2003/05">
<POS>
<Source>
<RequestorID Type="22" ID="ULYSESCLOUD"/>
</Source>
</POS>
<AvailStatusMessages HotelCode="UC123">
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="BB|3000|BARBBNR" Start="2021-04-20" End="2021-04-23" InvTypeCode="DOB"/>
<RestrictionStatus Status="Close"/>
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="BB|3000|BARBBNR" Start="2021-04-20" End="2021-04-23" InvTypeCode="DOB"/>
<RestrictionStatus Restriction="Arrival" Status="Open"/>
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="BB|3000|BARBBNR" Start="2021-04-20" End="2021-04-23" InvTypeCode="DOB"/>
<RestrictionStatus Restriction="Departure" Status="Open"/>
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="BB|3000|BARBBNR" Start="2021-04-20" End="2021-04-23" InvTypeCode="DOB"/>
<LengthsOfStay>
<LengthOfStay Time="1" MinMaxMessageType="SetMinLOS"/>
</LengthsOfStay>
</AvailStatusMessage>
<AvailStatusMessage>
<StatusApplicationControl RatePlanCode="BB|3000|BARBBNR" Start="2021-04-20" End="2021-04-23" InvTypeCode="DOB"/>
<LengthsOfStay>
<LengthOfStay Time="999" MinMaxMessageType="SetMaxLOS"/>
</LengthsOfStay>
</AvailStatusMessage>
</AvailStatusMessages>
</OTA_HotelAvailNotifRQ>
Element | Number | Description |
|---|---|---|
OTA_HotelAvailNotifRQ | 1 | Main node |
@EchoToken | 1 | Globally unique identifier for the request, the value will be returned in the response EchoToken. |
@TimeStamp | 1 | Time of the transaction in xml schema dateTime format |
@Version | 1 | Always 1 |
OTA_HotelAvailNotifRQ / POS / Source / RequestorID | 1 | This identifies the system which is sending the update for Availability/Restrictions. This element must appear in the first Source element. |
@Type | 1 | Fixed at 22 (ESRP) |
@ID | 1 | Always ULYSESCLOUD |
OTA_HotelAvailNotifRQ / AvailStatusMessages | 1 | Contains the availability messages |
@HotelCode | 1 | The code for the property whose availability is being updated |
AvailStatusMessages / AvailStatusMessage | 1..n | Contains the availability messages. If there is more than one room type to update, there should be one AvailStatusMessage per room type. |
AvailStatusMessage / StatusApplicationControl | 1 | Contains specific info about the room availability |
@Start | 1 | The start date for which the availability update is being set |
@End | 1 | The end date for which the availability update is being set. The end date is inclusive. |
@RatePlanCode | 0..1 | This is the rate plan whose availability is being updated. Must enter RatePlanCode and/or InvTypeCode to identify room |
@InvTypeCode | 0..1 | Identifies the room type for which the availability is being updated. Must enter RatePlanCode and/or InvTypeCode to identify room |
AvailStatusMessage / RestrictionStatus | 0..1 | Delfines restrictions like Stop Sell, Close To Arrival (CTA), Close To Departure (CTD) |
@Status | 1 | "Open" OR "Close" |
@Restriction | 0..1 | "Arrival" OR "Departure". If not present the Stop Sell value if updated |
LengthsOfStay | 0..1 | Optional. Used to update minimum and maximum stays. |
LengthsOfStay / LengthOfStay | 1..2 | Mandatory if LengthsOfStay present. One LengthOfStay can be included for each of "SetMinLOS" and "SetMaxLOS". |
@MinMaxMessageType | 1 | Mandatory if LengthsOfStay present. Possible values are "SetMinLOS" or "SetMaxLOS". |
@Time | 1 | Mandatory if LengthsOfStay present. Sets the minimum or maximum number of days allowed for a stay. Time must be a value above 0. Set Time to 1 to indicate that there is no MinStay requirement, or 999 to indicate no MaxStay requirement. |
OTA_NotifReportRS
This message is returned to the PMS in response to the OTA_HotelAvailNotifRQ message. It notifies whether the OTA_HotelAvailNotifRQ message has been processed successfully.
Example of success Response
<OTA_NotifReportRS EchoToken="daafcc9e-c8c6-484e-87bc-acd7fedb2980" TimeStamp="2021-01-01T12:00:00Z" Version="1.0" xmlns="http://www.opentravel.org/OTA/2003/05">
<Success/>
</OTA_NotifReportRS>Example of error Response
<OTA_NotifReportRS EchoToken="daafcc9e-c8c6-484e-87bc-acd7fedb2980" TimeStamp="2021-01-01T12:00:00Z" Version="1.0" xmlns="http://www.opentravel.org/OTA/2003/05">
<Errors>
<Error Type="3" Code="392">Cannot finder hotelier DOB</Error>
</Errors>
</OTA_NotifReportRS>
Element | Number | Description |
|---|---|---|
OTA_NotifReportRS | 1 | Main element |
@EchoToken | 1 | Return the EchoToken from the request message. |
@Version | 1 | Current version is 1.0 |
@TimeStamp | 1 | Time of the transaction. |
OTA_NotifReportRS / Success | 0..1 | Will only be present if the request processed successfully. The Errors node will not be present if the Success node is present |
OTA_NotifReportRS / Errors | 0..1 | Contains a list of errors if the request failed to process. |
Errors / Error | 1..n | Will be at least one node if there is an Errors Node. |
@Type | 1 | Mandatory if Error present. 3: Biz rule (The business rules for the request message were not met) |
@Code | 0..1 | OTA Error Codes |