This API helps you to apply close on arrival restrictions for specific date ranges for a property. With this feature, you can restrict the availability of a room, by making a room unavailable to book if the guest checks in on a certain date.
The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| Request_Type * | – | Use Keyword “UpdateCOA” | |
| HotelCode * | INT(11) | Unique Hotel code | XXXX |
| AuthCode * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| RatePlanID * | INT(20) | Unique Rate Plan ID | 123450000000000001 |
| FromDate * | DATETIME | Update From date. [Format: yyyy-mm-dd] | 2020-06-25 |
| ToDate * | DATETIME | Update To date [Format: yyyy-mm-dd] | 2020-06-27 |
| COA * | INT(1) | COA oprvalue [1 or 0] 1: Enable COA 0: Disable COA | 1 OR 0 |
Request
{
"RES_Request": {
"Request_Type": "UpdateCOA",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxxxxxxxxxx"
},
"RatePlan": [
{
"RatePlanID": "123450000000000001",
"FromDate": "2019-06-21",
"ToDate": "2019-06-22",
"COA": "0"
},
{
"RatePlanID": "123450000000000001",
"FromDate": "2019-06-25",
"ToDate": "2019-06-27",
"COA": "0"
}
]
}
}
Response
| Name | Data Type | Description | Example |
| Success.SuccessMsg | – | Generate Success Response Message | COA Successfully Updated |
| Errors.ErrorCode | – | Response Error Code | 122, 127 etc |
| Errors.ErrorMessage | – | Generate Response Message | COA value is missing |
Success
{ "Success": {
"SuccessMsg": "COA Successfully Updated"
},
"Errors": {
"ErrorCode": "0",
"ErrorMessage": "Success"
}
}
Error Codes
| Error Code | Error Name |
| 100 | Missing required parameters. |
| 500 | Error occurred during processing |
| 502 | Request Type is missing |
| 101 | Hotel Code is missing |
| 102 | Authentication Code is missing |
| 105 | From Date is missing |
| 106 | (From Date) – From Date is not a valid date |
| 107 | To Date is missing |
| 108 | (To Date) – To Date is not a valid date |
| 109 | From Date (From Date) To Date : (To Date) – Please check From and To date. To Date should be greater than fromdate |
| 301 | Unauthorized Request. Please check hotel code and authentication code |
| 302 | Unauthorized Request. Integration is not allowed |
| 303 | Auth Code is inactive. |
| 201 | Unauthorized request.(Request Type) request is not valid for this hotel code |
| 202 | Unauthorized request. Hotel code is not active |
| 122 | Rate Plan ID is missing |
| 127 | COA value is missing |
| 128 | Invalid COA value |