This API provides limited information of roomtypes for a property which can be used for the mapping or display purpose in the external applications. The API can return data in JSON formats. The web service responds to HTTP GET requests.
URI Request
Request parameters are supplied by appending a question mark (?) to the base URI, followed by a sequence of parameter names and values separated by an ampersand (&).
End Point URL
[BaseUrl]booking/reservation_api/listing.php?request_type=[Request_Type]&HotelCode=[Hotel_Code]&APIKey=[API_KEY]&publishtoweb=1;
Header
Parameter
| Name | Data Type | Description | Example |
| [BaseUrl] * | – | Live server URL | https://live.ipms247.com/ |
| [Request_Type] * | – | Use Keyword “RoomTypeList” | |
| [Hotel_Code] * | INT(11) | Unique Hotel code | XXXX |
| [API_KEY] * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| [LANGUAGE] | VARCHAR(20) | [Optional] Default is en. Pass language code. Language codes are available here. | en |
| publishtoweb | TINYINT(1) | 1 – will retrieve all Room Types0 – will retrieve room types which are published to WEBDefault value is 0 | 0 OR 1 |
Request
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=RoomTypeList&HotelCode=XXX&APIKey=XXX&language=en&publishtoweb=1
Response
| Name | Data Type | Description | Example |
| roomtypeunkid | INT(20) | Unique Room Type ID | 123400000000000001 |
| roomtype | VARCHAR(255) | Room Type Name | Deluxe, Luxury |
| base_adult_occupancy | INT(11) | Base adult occupancy in room | 2 |
| base_child_occupancy | INT(11) | Base child occupancy in room | 2 |
| max_adult_occupancy | INT(11) | Maximum adult occupancy in room | 4 |
| max_child_occupancy | INT(11) | Maximum child occupancy in room | 4 |
Success
[
{
"roomtypeunkid": "123400000000000001",
"roomtype": "King",
"shortcode": "KNG",
"base_adult_occupancy": "2",
"base_child_occupancy": "2",
"max_adult_occupancy": "4",
"max_child_occupancy": "4"
},
{
"roomtypeunkid": "123400000000000004",
"roomtype": "Deluxe",
"shortcode": "DLX",
"base_adult_occupancy": "5",
"base_child_occupancy": "5",
"max_adult_occupancy": "6",
"max_child_occupancy": "7"
},
{
"roomtypeunkid": "123400000000000006",
"roomtype": "Suite River View",
"shortcode": "SRV",
"base_adult_occupancy": "3",
"base_child_occupancy": "2",
"max_adult_occupancy": "5",
"max_child_occupancy": "3"
}
]
Error Codes
| Error Code | Error Name |
| HotelCodeEmpty | Hotel code is empty. |
| NORESACC | This request is valid for Reservation Account only. You may not have opted for Reservation Account Or Hotel Code and Authentication are invalid. |
| UNAUTHREQ | Unauthorized request. This request is not valid for this hotel code. |
| getRoomTypeListError | Room Type List error |
| -1 | No Data found. |
| APIACCESSDENIED | Your property doesn’t have access to API integration or Key is incorrect. Please contact support for this. |
| ParametersMissing | Missing parameters. |