This section will explain about description for element, attribute and example of request for make cancel response.
Example Success Response
<OTA_CancelRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="0.0" TimeStamp="2015-04-23T18:17:54.546+02:00">
<POS>
<Source>
<RequestorID ID="13244" ID_Context="IATA" Type="18" URL="ChannelManager.com"/> </Source>
</POS>
<Success/>
<UniqueID ID="0903" Type="10" ID_Context="AGODA"/>
<UniqueID ID="62025941" Type="14" ID_Context="AGODA"/>
<UniqueID ID="0903PE1500" Type="14" ID_Context="ChannelManager"/>
<UniqueID ID ="0903PE1500" Type="15" ID_Context="ChannelManager"/>
</OTA_CancelRS>
Example Fail Response
<OTA_CancelRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="0.0" TimeStamp="2015-04-23T18:17:54.546+02:00">
<POS>
<Source>
<RequestorID ID="13244" ID_Context="IATA" Type="18" URL="ChannelManager.com"/> </Source>
</POS>
<UniqueID ID="0903" Type="10" ID_Context="AGODA"/>
<UniqueID ID="62025941" Type="14" ID_Context="AGODA"/>
<UniqueID ID="0903PE1500" Type="14" ID_Context="ChannelManager"/>
<TPA_Extensions>
<Error Code="4001" Description="Reservation “0903PE1500” Not Found "/> </TPA_Extensions>
</OTA_CancelRS>
Elements and Attributes
| OTA_CancelRS | |||||
|---|---|---|---|---|---|
| Element or @Attribute | Data Type | No. of occur | Mandatory | Example | Description |
| OTA_CancelRS | datetime | 1 | Y | 2016-09-01T13 :25 :42+07:00 | Indicates the creation date and time of the message using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00). |
| @ timestamp | |||||
| @ version | decimal, n.n | 1 | Y | 0.1 | For all OTA versioned messages, the version of the message is indicated by a decimal value. |
| @ xmlns | string | 1 | Y | http://www.opentravel.org/OTA/2003/05 | Namespace for the OTA payload message. |
| POS | numeric length 8 | 1 | Y | 123456 | Unique identifier of Supplier. |
| Source | |||||
| RequestorID | |||||
| @ ID | |||||
| @ ID_Context | alpha length 4 | 1 | Y | IATA | Used to identify the source of the identifier |
| @ Type | OTA_CodeType | 1 | Y | 18 | Reference to the type of requestor. 18 = Other |
| @ URL | string length | 1 | Y | ChannelManager.com | Used to identify the source url |
| 1 to 50 | |||||
| Success | [0..1] | N | Success element will appear in the response when the cancellation confirmed and it does not appear if the cancellation fail. | ||
| UniqueID | [0..4] | N | |||
| @ID | string | 1 | Y | ID meaning is depend on @Type | |
| length | @Type = 10:@ID = hotel code | ||||
| 1 to 20 | @Type = 14:@ID = reservation number | ||||
| @Type = 15:@ID = cancellation number | |||||
| @Type | numeric | 1 | Y | 10: hotel code | |
| 14: reservation number | |||||
| 15: cancellation number | |||||
| @ID_Context | string length 1 to 50 | 1 | Y | ||
| TPA_Extensions | [0..1] | N | Error element is an element for any fault occur and will be appear when cancellation fail. | ||
| Error | |||||
| @ Code | string | 1 | Y | 4001 | Generic Agoda Error Code. |
| length | Refer to Appendix D | ||||
| 1 to 50 | |||||
| @ Description | string | 1 | Y | Reservation 1234 Not Found | Generic Agoda Error Message. |
| length | Refer to Appendix D | ||||
| 1 to 250 |