This API provides information of salutations and country list available for your property which can be displayed 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]&language=[LANGUAGE]
Header
Parameter
Name | Data Type | Description | Example |
[BaseUrl] * | – | Live server URL | https://live.ipms247.com/ |
[Request_Type] * | – | Use Keyword “ConfiguredDetails” | |
[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. | Optional Default is en |
Request
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=ConfiguredDetails&HotelCode=XXXX&APIKey=XXXXXX&language=en
Response
Name | Data Type | Description | Example |
Salution | String | Get salutation list | Dr,Jr |
Country List | String | Get country list | Afghanistan,Albania |
Success
{ "Salutation": { "DR": "Dr.", "JN": "Jn.", "MAM": "Mam.", "MR": "Mr.", "MRS": "Mrs.", "MS": "Ms.", "SIR": "Sir", "SR": "Sr." }, "CountryList": { "1": "Afghanistan", "2": "Albania", "3": "Algeria", ..... } }
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. |
2 | Cannot Parse Request |
5 | Recoverable Error. Equivalent to http 503. |
DBConnectError | Database not connected. |
BadRequest | Bad request type. |
-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. |
UnknownError | Unknown Error |
4 | Timeout requested. Stops requests for the specified time. |
InvalidHotelCode | Invalid Hotel code.Please check your property code. |