Cancellation Notif
OTA Message Pair: OTA_CancelRQ / OTA_CancelRS
The OTA Cancel message may be used for cancelling a reservation. This message cancels the entire reservation, i.e., it may not be used to cancel only part of the itinerary segments in a booking. (This must be done through OTA_HotelResModifyNotifRQ)
Direction
- 3rd Party can send request to Levart and expect a response.
Request
<OTA_CancelRQ xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 https://secure.levartdistributionsystems.com.au/html/schema/OTA/2015B/OTA_CancelRQ.xsd"
TimeStamp="2020-06-19T22:21:23+08:00" Target="Production" Version="1.0" CancelType="Cancel">
<UniqueID Type="14" ID="987654321" ID_Context="CrsConfirmNumber" />
<UniqueID Type="14" ID="123456789" ID_Context="PmsConfirmNumber" />
<Verification>
<PersonName>
<Surname>Bloggs</Surname>
</PersonName>
</Verification>
</OTA_CancelRQ>
Request Specification
Element | Num | Description |
---|---|---|
OTA_CancelRQ | 1 | Root element |
@Version | 1 | Version of the document. Currently 1.0 |
@CancelType | 1 | Always 'Cancel' |
UniqueID | 1..n | The reservation ID that is being cancelled by this message. Will have a CrsConfirmNumber and a PmsConfirmNumber. |
UniqueID > @Type | 2 | Always 14 for both. |
UniqueID > @ID | 2 | |
UniqueID > @ID_Context | 2 | The context of the Unique Identifier, the Levart based should be: 'PmsConfirmNumber' and for external bookings it should be 'CrsConfirmNumber' |
Verification | 1 | Details of the person in the original bookings. |
Verification > PersonName | 1 | |
PersonName > Surname | 1 | Surname of the person in the original booking. |
Response (Success)
<OTA_CancelRS xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 https://secure.levartdistributionsystems.com.au/html/schema/OTA/2015B/OTA_CancelRS.xsd"
TimeStamp="2020-06-19T22:21:23+08:00" Target="Production" Version="1.0">
<Success/>
<UniqueID Type="14" ID="987654321" ID_Context="CrsConfirmNumber" />
<CancelInfoRS>
<UniqueID Type="14" ID="123456789" ID_Context="PmsConfirmNumber" />
</CancelInfoRS>
</OTA_CancelRS>
Response (Error)
<OTA_CancelRS xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 https://secure.levartdistributionsystems.com.au/html/schema/OTA/2015B/OTA_CancelRS.xsd"
TimeStamp="2020-06-19T22:21:23+08:00" Target="Production" Version="1.0">
<Warnings>
<Warning Type='1'>Error: Could not cancel reservation '987654321', PmsConfirmNumber does not match (Expected: 123456789X, Recieved: 123456789)</Warning>
</Warnings>
<UniqueID Type="14" ID="987654321" ID_Context="CrsConfirmNumber"/>
<CancelInfoRS>
<UniqueID Type="14" ID="" ID_Context="PmsConfirmNumber"/>
</CancelInfoRS>
</OTA_CancelRS>
Response Specification
Element | Num | Description |
---|---|---|
OTA_CancelRS | 1 | Root Element |
@Version | 1 | Version of the document. Currently 1.0 |
Errors | 0..1 | List of errors (If errors encountered) |
Errors > Error | 1..n | Error message |
Warnings | 0..1 | List of warnings (If warnings encountered) |
Warnings > Warning | 1..n | Warning message |
Success | 0..n | Successful processing if element exists. |
UniqueID | 1 | UniqueID element for CrsConfirmNumber (3rd Party) |
UniqueID > @Type | 1 | |
UniqueID > @ID | 1 | |
UniqueID > @ID_Context | 1 | |
CancelInfoRS | 1 | |
CancelInfoRS > UniqueID | 1 | UniqueID element for CrsConfirmNumber (Levart) |