This API provides supplied room information for today’s arrival-departure like reservation no, room no and arrival-departure date-time . The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Note: You need set Authcode in Header.
Header
Parameter
Name | Data Type | Description | Example |
request_type * | VARCHAR(150) | Use Keyword “get_calendar” | |
hotel_id * | INT(11) | Unique Hotel code | XXXX |
report_type * | VARCHAR(150) | 3 types of values can be passed with this parameter, checkin – To get today’s Arrivals checkout – To get today’s departure both – To get today’s arrivals & departures | both |
Request
{ "request_type": "get_calendar", "body": { "hotel_id": "xxxx", "report_type":"both" } }
Response
Name | Data Type | Description | Example |
status | String | Failure or success of the request Values: Success, Error | Success |
data.* | Integer | Here * means property ID | xxxx |
data.*.arrivals and/or data.*.departures | String | arrivals or departures parameter will be available according to the value of report_type sent in request | arrivals |
data.*.arrivals.reservation_id | Integer | Reservation ID | 938 |
data.*.arrivals.room_code | String | Room no. of particular room | L3 |
data.*.arrivals.arrival_date_time | Date | Arrival-departure date & time in the below format. YYYY-MM-DD HH:MM:SS | 2020-03-29 12:00:00 |
error_code | – | Error code in case of failure | 101 |
error_message | – | Error Message in case of failure | Invalid Authentication Data |
Success
{ "status": "success", "data": { "12345": { "arrivals": [ { "reservation_id": "32", "room_code": "125", "arrival_date_time": "2020-05-09 12:00:00" } ] } } }
Error Codes
Error Code | Error Name |
101 | Invalid Hotel Id |
102 | Invalid Authentication |
103 | Blank Request |
104 | Invalid Request Format |
105 | Missing Required Parameter |
106 | Invalid Reservation ID |
107 | Invalid Date Format |
108 | Invalid Date Range |
109 | Currently Data can be requested for max 15 days |
110 | Invalid Room Id |
111 | IP Address is not Authorised |
112 | Invalid Request Method |
113 | Hotel Code is not Active |
114 | Invalid Room Code or not associated with supplied room ID |
115 | Internal Problem |