This API provides room types, rate types and rate plans information for a property. 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 “RoomInfo” | |
NeedPhysicalRooms | INT(2) | If you need Room data, then put it “1”. It is optional | 1 / 0 |
HotelCode * | INT(11) | Unique Hotel code | xxxx |
AuthCode * | VARCHAR(300) | Unique Authentication code | xxxxxxxxxx |
Request
{ "RES_Request": { "Request_Type": "RoomInfo", "NeedPhysicalRooms":1, "Authentication": { "HotelCode": "xxxx", "AuthCode": "xxxxxxxxxxxx" } } }
Response
Name | Data Type | Description | Example |
RoomType.ID | Integer | Unique RoomType ID | 1234500000000000001 |
RoomType.Name | String | RoomType Name | Garden View Studio Room |
RoomType.Rooms. RoomID | Integer | Room Unique ID | 1234500000000000001 |
RoomType.Rooms. RoomName | String | Room Number/Name | 101 |
RateType.ID | Integer | Unique RateType ID | 1234500000000000001 |
RateType.Name | String | RateType Name | European Plan |
RatePlan.RatePlanID | Integer | Unique RatePlan ID | 1234500000000000001 |
RatePlan.Name | String | RatePlan Name | Garden View Studio Room |
RatePlan.RoomTypeID | Integer | RoomType ID | 1234500000000000001 |
RatePlan.RoomType | String | RoomType Name | Garden View Studio Room |
RatePlan.RateTypeID | Integer | RateType ID | 1234500000000000001 |
RatePlan.RateType | String | RateType Name | European Plan |
Errors.ErrorCode | – | Response Error Code | 301, 404 etc |
Errors.ErrorMessage | – | Generate Response Message | Success, Unauthorized Request etc. |
Success
{ "RoomInfo": { "RoomTypes": { "RoomType": [ { "ID": "1234500000000000001", "Name": "Sea View Deluxe Room", "Rooms": [ { "RoomID": "1234500000000000001", "RoomName": "101" }, { "RoomID": "1234500000000000002", "RoomName": "102" } }, { "ID": "1234500000000000002", "Name": "Garden View Studio Room", "Rooms": [ { "RoomID": "1234500000000000004", "RoomName": "201" }, { "RoomID": "1234500000000000005", "RoomName": "202" } } ] }, "RateTypes": { "RateType": [ { "ID": "1234500000000000001", "Name": "European Plan" }, { "ID": "1234500000000000002", "Name": "Continental Plan" }, { "ID": "1234500000000000005", "Name": "Indian Plan" } ] }, "RatePlans": { "RatePlan": [ { "RatePlanID": "1234500000000000001", "Name": "Sea View Deluxe Room", "RoomTypeID": "1234500000000000001", "RoomType": "Sea View Deluxe Room", "RateTypeID": "1234500000000000001", "RateType": "European Plan", "RatePlanType": "INDEPENDENT" }, { "RatePlanID": "1234500000000000015", "Name": "Garden View Studio Room", "RoomTypeID": "1234500000000000002", "RoomType": "Garden View Studio Room", "RateTypeID": "1234500000000000001", "RateType": "European Plan", "RatePlanType": "MASTER" } ] } }, "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 |
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 |