Cancellation
Request
The table below describes the elements present in a request along with details around their implementation. Please take special note of required fields.
Endpoint:
/GetCancellation.do
Element Group | Element Name | Type | Req. | Element Description |
|---|---|---|---|---|
cancellationRequest | cancellationRequest | Group | Yes | |
cancellationRequest | timestamp | Attribute | Yes | The current timestamp. (YYYYMMDDThh:mm:ss) |
cancellationRequest | control | Group | Yes | |
control | userName | Element | Yes | The user identifier assigned. This is the unique ID given to you by Bonotel. |
control | passWord | Element | Yes | The password assigned. This is the unique password given to you by Bonotel. |
cancellationRequest | supplierReferenceNo | Element | | Internal reference no sent by Bonotel at the time of booking. |
cancellationRequest | cancellationReason | Element | No | |
cancellationRequest | cancellationNotes | Element | No | |
Response
Element Group | Element Name | Type | Req. | Element Description |
|---|---|---|---|---|
cancellationResponse | cancellationResponse | Group | Yes | |
cancellationResponse | status | Attribute | Yes | Status of the cancellation. Valid values are Y – Cancellation was successful. N – Cancellation was unsuccessful. |
cancellationResponse | errors | Group | No | |
errors | code | Element | No | An internal error code provided by Bonotel. |
errors | description | Element | No | A message describing the error. |
cancellationRequest | tourOperatorOrderNumber | Element | Yes | Reference number of the tour operator booking |
cancellationResponse | cancellationNo | Element | Yes | Your confirmation number for the cancellation transaction. |
cancellationResponse | canellationFee | Element | No | The charge for the cancellation if any. Yes, there is a spelling error in the element name. |
Code Example
Request
/GetCancellation.do
<?xml version="1.0" encoding="utf-8" ?>
<cancellationRequest timestamp="20150325T00:00:00">
<control>
<userName>{{Username}}</userName>
<passWord>{{Password}}</passWord>
</control>
<supplierReferenceNo>PRGFOUSCG</supplierReferenceNo>
<cancellationReason/>
<cancellationNotes>selected a different hotel.</cancellationNotes>
</cancellationRequest>Response
<?xml version="1.0" encoding="utf-8" ?>
<cancellationResponse status="Y">
<tourOperatorOrderNumber>123456</tourOperatorOrderNumber>
<cancellationNo>C4759068</cancellationNo>
<canellationFee>0</canellationFee>
</cancellationResponse>Response Codes
Code | Description |
|---|---|
C1 | Unspecified error. Please contact customer support. |
C2 | User ID not supplied or not valid |
C3 | Reservation already cancelled. |
C4 | Reservation number not provided. |
C5 | Reservation no not found or Reservation no not belongs to this user. |
C6 | No XML input detected. |
C7 | Erroneous or Incomplete Data in Cancellation Request. |
C8 | Request IP Address not matched for the User. |
C9 | Past date reservations cannot be canceled. |
C10 | (Deprecated) |
C11 | Cancellation failed at the supplier end. |