The OTA_NotifReportRQ message is sent by the PMS to Effective Tours in order to confirm the delivery of one of more reservations, modifications or cancellations. If a reservation, modification or cancellation is not confirmed as delivered it will continue to be delivered to the PMS in response to the OTA_ReadRQ message. Please note that confirming the delivery of a reservation does not necessarily mean that the reservation was successfully created in the PMS. The OTA_NotifReportRQ message allows for confirming a delivery which was erroneous.
OTA_NotifReportRQ
Note that a
OTA_NotifReportRQmust contain either aSuccessor anErrorselement. If multiple reservations were processed and both a success and an error message need to be returned then twoOTA_NotifReportRQmessages need to be sent. One containing theSuccesselement and ids for the successfully processed reservations and one containing theErrorsand ids for the reservations that failed to process.
Example of PMS confirming the delivery of a reservation what was processed successfully
- The presence of the
<Success/>element indicates that the reservation was created in the PMS - The
UniqueIDelement informs Effective Tours which reservation message is being confirmed - The
HotelReservationIDholds the ID of the newly created reservation in the PMS
<OTA_NotifReportRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2005-08-01T09:30:47+02:00" EchoToken="echo-abc123">
<Success/>
<NotifDetails>
<HotelNotifReport>
<HotelReservations>
<HotelReservation CreateDateTime="2010-01-01T12:00:00" ResStatus="Book">
<UniqueID Type="16" ID="3123456"/>
<ResGlobalInfo>
<HotelReservationIDs>
<HotelReservationID ResID_Type="14" ResID_Value="PMS-111333"/>
</HotelReservationIDs>
</ResGlobalInfo>
</HotelReservation>
</HotelReservations>
</HotelNotifReport>
</NotifDetails>
</OTA_NotifReportRQ>
Example of PMS confirming the delivery of a reservation what was NOT processed successfully
- The presence of the
<Error/>element indicates that the reservation was not created in the PMS - The
UniqueIDelement informs Effective Tours which reservation is being confirmed - No
HotelReservationIDis present if the PMS was unable to save the reservation
<OTA_NotifReportRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2005-08-01T09:30:47+02:00" EchoToken="echo-abc123">
<Errors>
<Error Type="3" Code="402">Invalid room type</Error>
</Errors>
<NotifDetails>
<HotelNotifReport>
<HotelReservations>
<HotelReservation CreateDateTime="2010-01-01T12:05:00" ResStatus="Book">
<UniqueID Type="16" ID="3123456"/>
</HotelReservation>
</HotelReservations>
</HotelNotifReport>
</NotifDetails>
</OTA_NotifReportRQ>
OTA_NotifReportRQ Specification
| Node | Number | Description |
|---|---|---|
| OTA_NotifReportRQ | 1 | Root element |
| @Version | 1 | Current Version 1.0 |
| @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 |
| OTA_NotifReportRQ / Success | 0..1 | Either Success or Error element present |
| OTA_NotifReportRQ / Errors | 0..1 | Contains a list of errors if the reservation, modification or cancellation failed to process. |
| Errors / Error | 1..n | Should be at least one node if there is an Errors Node. |
| @Type | 1 | Mandatory if Error present. |
| @Code | 0..1 | Any code from the OTA code table for ‘Error Codes (ERR)’ can be used. |
| OTA_NotifReportRQ / NotifDetails / HotelNotifReport | 1 | Container for HotelReservations |
| HotelNotifReport / HotelReservations / HotelReservation | 1..n | One for each reservation being confirmed |
| @CreateDateTime | 0..1 | The time the reservation was created on the PMS. Mandatory if ResStatus is “Book”. |
| @LastModifyDateTime | 0..1 | The time the reservation was updated on the PMS. Mandatory if ResStatus is Modify or Cancel. |
| @ResStatus | 0..1 | Allowed values are “Book”, “Modify” or “Cancel” |
| HotelReservation / UniqueID | 1 | The identifier of the reservation message as known to Effective Tours. The HotelReservation UniqueID of type 16 from the OTA_ResRetrieveRS response |
| @Type | 1 | Value of ’16’ which refers to ‘Reference’ in the OTA Unique Id Type (UIT) code table |
| @ID | 1 | Effective Tours identifier of the reservation |
| HotelReservation / ResGlobalInfo | 0..1 | Present if the reservation is part of a successful delivery batch |
| HotelReservation / ResGlobalInfo / HotelReservationIDs / HotelReservationID | 1 | Container for the PMS reservation identifier |
| @ResID_Type | 1 | Value of ’14’ which refers to ‘Reservation’ in the OTA Unique Id Type (UIT) code table |
| @ResID_Value | 1 | The identifier of the reservation created by the PMS |
OTA_NotifReportRS
This message is sent to the PMS in response to the OTA_NotifReportRQ message. It confirms the Effective Tours processed the OTA_NotifReportRQ message successfully.
Success Response
<tns:OTA_NotifReportRS Version="1.0" TimeStamp="2005-08-01T09:30:47+02:00" EchoToken="echo-abc123">
<tns:Success></tns:Success>
</tns:OTA_NotifReportRS>
Failure Response
<tns:OTA_NotifReportRS Version="1.0" TimeStamp="2005-08-01T09:30:47+02:00" EchoToken="echo-abc123">
<tns:Errors>
<tns:Error Type="3" Code="385">Could not find Notifications to confirm with notification id='3123456'</Error>
</tns:Errors>
</tns:OTA_NotifReportRS>
OTA_NotifReportRS Specification
| Element | Number | Description |
|---|---|---|
| OTA_NotifReportRS | 1 | Root element |
| @Version | 1 | Current version is 1.0 |
| @EchoToken | 1 | Return the EchoToken from the request message. |
| @TimeStamp | 1 | Time of the transaction in xml schema dateTime format |
| OTA_NotifReportRS / Success | 0..1 | Either Success or Error element present |
| OTA_NotifReportRS / Errors | 0..1 | Contains a list of errors if the confirmation failed to process. |
| Errors / Error | 1..n | Should be at least one node if there is an Errors Node. |
| @Type | 1 | Mandatory if Error present. |
| @Code | 0..1 | Any code from the OTA code table for ‘Error Codes (ERR)’ can be used. |
Last Updated: Nov 26, 2019
—- —- —- —- —- —- —- — — — — —
Back to API Documentation