Configuration

Retrieve Available Room List

This API will fetch the available room data between check-in and check-out date. Also, you can add Room Unique Id or Roomtype Unique Id, If you will need particular room data. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/index.php/page/service.kioskconnectivity

Header

Content-Type: application/json

Parameter

Name	Data Type	Description	Example
HotelCode*	INT(11)	Unique Hotel code	xxxx
AuthCode*	VARCHAR(300)	Unique Authentication code	xxxxxxxxxx
Request_Type*	VARCHAR(100)	Request Type	RoomAvailability
RoomData->from_date*	DATE	Check-In Date	2021-12-05
RoomData->to_date*	DATE	Check-Out Date	2021-12-06
RoomData->RoomID	INT(11)	Room Unique ID (Optional)	123400000000000002
RoomData->RoomtypeID	INT(11)	Room Type Unique ID (Optional)	123400000000000002

Request

{
       "RES_Request": {
             "Request_Type": "RoomAvailability",
             "Authentication": {
                     "HotelCode": "xxxx",
                     "AuthCode": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
             },
             "RoomData": {
                     "RoomtypeID": "123400000000000002", (Optional)
                     "RoomID": "123400000000000002",  (Optional)
                     "from_date": "2021-11-30",
                     "to_date": "2021-12-10"
             }
       }
}

Response

Name	Data Type	Description	Example
RoomList-> RoomtypeID	Integer	Roomtype Unique ID	123400000000000001
RoomList-> RoomtypeName	Varchar	Roomtype Name	Deluxe Room
RoomList-> RoomData-> RoomID	Integer	Room Unique ID	123400000000000001
RoomList-> RoomData-> RoomName	Varchar	Room Name/No	105

Success

{
    "Success": {
      "RoomList": 
      [
         {
               "RoomtypeID": "123400000000000002",
               "RoomtypeName": "Deluxe Room",
               "RoomData": 
                [
                    {
                         "RoomID": "123400000000000011",
                         "RoomName": "101"
                    },
                    {
                          "RoomID": "123400000000000012",
                          "RoomName": "102"
                    },
               ]
        },
        {
              "RoomtypeID": "1234700000000000003",
              "RoomtypeName": "Sea View Room",
              "RoomData":
              [
                   {
                         "RoomID": "123400000000000015",
                         "RoomName": "105"
                   },
              ]
         }
    ]
    },
    "Errors": {
          "ErrorCode": "0",
          "ErrorMessage": "Success"
     }
}

Error

{
     "Error": 
     [
        {
           "ErrorCode": "121",
           "ErrorMessage": "Invalid Value. Please check with RoomType Data"
        }
     ]
}

Error Codes

Error Code	Error Name
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	Date – From Date is not a valid date
107	To Date is missing
108	Date – To Date is not a valid date
109	From Date: <Date> To Date : <Date> – Please check From and To date. To Date should be greater than fromdate
111	Missing Parameter OR Invalid Parameter : RoomData
112	Invalid Parameter
113	Invalid Value
121	Invalid Value. Please check with RoomType Data
122	Invalid Value. Please check with Room Data
301	No Data Found
201	Unauthorized request.(Request Type) request is not valid for this hotel code
202	Unauthorized request. Hotel code is not active

Kiosk Connectivity Open

Configuration

Retrieve Identity Type

This API will give you all active Identity Types (Passport, Pancard, etc) available in the hotel. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/index.php/page/service.kioskconnectivity

Header

Content-Type: application/json

Parameter

Name	Data Type	Description	Example
HotelCode *	INT(11)	Unique Hotel code	XXXX
AuthCode *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
Request_Type *	VARCHAR(100)	Request Type	RetrieveIdentityType

Request

 {
       "RES_Request": {
              "Request_Type": "RetrieveIdentityType",
               "Authentication": {
                      "HotelCode": "xxxx",
                      "AuthCode": "xxxxxxxxxxxx"
                }
        }
}

Response

Name	Data Type	Description	Example
IdentityType->IdentityTypeID	Integer	Identity Type Unique id	1234500000000000001
IdentityType->Name	String	Identity Type Name	Passport,Driving License

Success

{      "Success": {   
        "IdentityType": [
        {
           "IdentityTypeID": "1234500000000000001",           
           "Name": "Passport" 
        },
        {
           "IdentityTypeID": "1234500000000000002",          
           "Name": "Driving License"  
        }
      ]
   },
  "Errors": {
    "ErrorCode": "0",
    "ErrorMessage": "Success"
  }
}

Error

{       
   "Errors": {
    "ErrorCode": "301",
    "ErrorMessage": "Unauthorized Request. Please check hotel code and authentication code"
  }
}

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
203	No Data Found

Kiosk Connectivity Open

Configuration

Retrieve Pay Methods

This API will give you all the pay methods available in the hotel. You need to send only active pay methods of the hotel. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/index.php/page/service.kioskconnectivity

Header

Content-Type: application/json

Parameter

Name	Data Type	Description	Example
HotelCode *	INT(11)	Unique Hotel code	XXXX
AuthCode *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
Request_Type *	VARCHAR(100)	Request Type	RetrievePayMethods

Request

 {
       "RES_Request": {
              "Request_Type": "RetrievePayMethods",
               "Authentication": {
                      "HotelCode": "xxxx",
                      "AuthCode": "xxxxxxxxxxxx"
                }
        }
}

Response

Name	Data Type	Description	Example
PayMethods->PayMethodID	Integer	Pay Method Unique id	1234500000000000001
PayMethods->PaymentID	String	Payment Unique id	1234500000000000001
PayMethods->Name	String	Pay Method Name	Cash
PayMethods->ShortCode	String	Pay Method Short Code	Cash
PayMethods->Type	String	Pay Method Type	Cash,Bank
PayMethods->CardProcessing	Integer	Card Processing	0
PayMethods->SurchargeApplicable	String	Surcharge Applicable	1
PayMethods->SurchargeType	String	Surcharge Type	FlatPercent,Amount
PayMethods->SurchargeValue	Decimal	Surcharge Value	5
PayMethods->SurchargeID	Integer	Surcharge Unique ID	1234500000000000001
PayMethods->SurchargeName	String	Surcharge Name	Surcharge

Success

{      "Success": {   
        "PayMethods": [
        {
          "PayMethodID": "1234500000000000001",          
          "PaymentID": "1234500000000000001",    
          "Name": "Cash",
          "ShortCode": "Cash",
          "Type": "Cash",
          "CardProcessing": "0",
          "SurchargeApplicable": "1",
          "SurchargeType": "FlatPercent",
          "SurchargeValue": "5",
          "SurchargeID": "1234500000000000001",
          "SurchargeName": "Surcharge"
        },
        {
          "PayMethodID": "1234500000000000002",          
          "PaymentID": "1234500000000000002",    
          "Name": "Cheque",
          "ShortCode": "Chq",
          "Type": "Bank",
          "CardProcessing": "0",
          "SurchargeApplicable": "0",
          "SurchargeType": "",
          "SurchargeValue": "",
          "SurchargeID": "",
          "SurchargeName": ""
        }
      ]
   },
  "Errors": {
    "ErrorCode": "0",
    "ErrorMessage": "Success"
  }
}

Error

{    
  "Errors": {
    "ErrorCode": "301",
    "ErrorMessage": "Unauthorized Request. Please check hotel code and authentication code"
  }
}

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
203	Payment Methods are not available in this hotel

Kiosk Connectivity Open

Configuration

Retrieve Currency

This API will give you all the currencies available in the hotel. You need to send only active currency of the hotel. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/index.php/page/service.kioskconnectivity

Header

Content-Type: application/json

Parameter

Name	Data Type	Description	Example
HotelCode *	INT(11)	Unique Hotel code	XXXX
AuthCode *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
Request_Type *	VARCHAR(100)	Request Type	RetrieveCurrency

Request

 {
       "RES_Request": {
              "Request_Type": "RetrieveCurrency",
               "Authentication": {
                      "HotelCode": "xxxx",
                      "AuthCode": "xxxxxxxxxxxx"
                }
        }
}

Response

Name	Data Type	Description	Example
CurrencyList->CurrencyID	Integer	Currency Unique id	1234500000000000001
CurrencyList->Country	String	Country name	India
CurrencyList->Currency	String	Currency Name	Rupees
CurrencyList->CurrencyCode	String	Currency Code	INR
CurrencyList->Sign	String	Currency sign	₹
CurrencyList->DigitsAfterDecimal	Integer	Currency Digits After Decimal	2
CurrencyList->IsBaseCurrency	String	Is Base Currency	0,1
CurrencyList->ExchangeRate	Decimal	Currency Exchange Rate	15.0000

Success

{      "Success": {   
        "CurrencyList": [
        {
          "CurrencyID": "1234500000000000001",
          "Country": "Argentina",
          "Currency": "Dollar ARS",
          "CurrencyCode": "ARS",
          "Sign": "$",
          "DigitsAfterDecimal": "2",
          "IsBaseCurrency": "0",
          "ExchangeRate": "15.0000"
        },
        {
         "CurrencyID": "1234500000000000002",
          "Country": "India",
          "Currency": "Rupees",
          "CurrencyCode": "INR",
          "Sign": "₹",
          "DigitsAfterDecimal": "2",
          "IsBaseCurrency": "1",
          "ExchangeRate": "1.0000"

        }
      ]
   },
  "Errors": {
    "ErrorCode": "0",
    "ErrorMessage": "Success"
  }
}

Error

{       
   "Errors": {
    "ErrorCode": "301",
    "ErrorMessage": "Unauthorized Request. Please check hotel code and authentication code"
  }
}

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
203	No Data Found

Kiosk Connectivity Open

Configuration

Retrieve Payment Gateways

This API provides all payment gateways which are available for your Booking Engine. The API can return data in JSON formats. The web service responds to HTTP GET requests. You need to take eZee Reservation to use this API.

End Point URL

[BaseUrl]booking/reservation_api/listing.php?APIKey=[API_KEY]&request_type=[Request_Type]&HotelCode=[Hotel_Code]

Header

–

Parameter

Name	Data Type	Description	Example
[BaseUrl] *	–	Live server URL	https://live.ipms247.com/
[Request_Type] *	–	Use Keyword “ConfiguredPGList”
[Hotel_Code] *	INT(11)	Unique Hotel code	XXXX
[API_KEY] *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXX

Request

https://live.ipms247.com/booking/reservation_api/listing.php?APIKey=XX&request_type=ConfiguredPGList&HotelCode=XX

Response

Name	Data Type	Description	Example
paymenttypeunkid	Integer(20)	Payment uniqueid	xxxxxxxxxxxx
hotel_code	Integer(11)	Unique hotel code	1234
shortcode	String	Short code	AirPay
paymenttype	String	Source of business	AirPay

Success

[
{
"paymenttypeunkid": "4000000000000048",
"hotel_code": "1234",
"shortcode": "AirPay",
"paymenttype": "AirPay”
}
]

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
DBConnectError	database not connected.
-1	No Data found.
APIACCESSDENIED	Your property doesn’t have access to API integration or Key is incorrect. Please contact support for this.
BadRequest	Bad request type.
UnknownError	Unknown Error
InvalidHotelCode	Invalid Hotel code.Please check your property code.

eZee Reservation Required Meta Search Open

Configuration

Verify Travel Agent

In this API, we expect some details from the client to be sent in request and based on that request we verify Travel Agent user and return verified Travel Agent information for properties in which it is created. The API can return data in JSON formats. The web service responds to HTTP GET requests.

You need to take eZee Reservation to use this API.

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?APIKey=[APIKey]&request_type=[request_type]&username=[username]&password=[password]&groupcode=[groupcode]

Header

–

Parameter

Name	Data Type	Description	Example
[BaseUrl] *	–	Live server URL	https://live.ipms247.com/
[Request_Type] *	–	Use Keyword “VerifyUser”
[Hotel_Code] *	INT(11)	Unique Hotel code	XXXX
[API_KEY] *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXX
[username] *	VARCHAR(300)	Pass travel agent user name	XXXXXXXXX
[password] *	VARCHAR(300)	Pass base_64 encoded encrypted password. Here’s the online tool for base_64 encoded encryption	base64_encode($x)
[groupcode] *	VARCHAR(300)	Unique group code for each registered chain of properties.	XXXXX

Request

https://live.ipms247.com/booking/reservation_api/listing.php?APIKey=XX&request_type=VerifyUser&username=XX&password=XX&groupcode=XX

Response

Name	Data Type	Description	Example
contactunkid	Integer(20)	Unique contact id	xxxxxxxxxxxx
salutation	String	Salutation of user	301, 404 etc
business_name	String	Name of business	Reservation already processed
name	String	User name	Jhon
address	String	Address of user	3817 Sugar Camp Road
city	String	City name	New York
state	String	State name	New York
zipcode	Integer	zipcode	123456
country	String	Country name	USA
phone	Integer	Phone number	123456789
mobile	Integer	Mobile number	1234567890
email	String	Email id	PamalaWHam@rhyta.com
isusercreated	String	Is user created	1 or 0

Success

"contact_detail":{
"26":{"contact_detail":{"contactunkid":"2600000000001612","salutation":"Mr.","business_name":"OLX","name":"Maximum","address":null,"city":null,"state":null,"zipcode":null,"country":"India","phone":null,"mobile":null,"email":"Maximum@gmail.com","isusercreated":"1"}},
"1023":{"contact_detail":{"contactunkid":"102300000000000844","salutation":"Mr.","business_name":"OLX","name":"Maximum","address":null,"city":null,"state":null,"zipcode":null,"country":"India","phone":null,"mobile":null,"email":"Maximum@gmail.com","isusercreated":"1"}},
"3419":{"contact_detail":{"contactunkid":"341900000000000098","salutation":"Mr.","business_name":"OLX","name":"Maximum","address":null,"city":null,"state":null,"zipcode":null,"country":"India","phone":null,"mobile":null,"email":"Maximum@gmail.com","isusercreated":"1"}}

Error Codes

Error Code	Error Name
HotelCodeEmpty	Hotel code is empty.
NORESACC1	This request is valid for Reservation Account only. You may not have opted for Reservation Account Or Groups Code and Authentication are invalid.
UNAUTHREQ	Unauthorized request. This request is not valid for this hotel code.
2	Cannot Parse Request
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.
INVUSEPASS	Invalid Username and Password.
UnknownError	Unknown Error
InvalidHotelCode	Invalid Hotel code.Please check your property code.

eZee Reservation Required Meta Search

Configuration

Retrieve Extras Rate Based on Parameters

This API will give you a total extra service rate on the basis of configured Extra Charges, check in date and check out date in your property. The API can return data in JSON formats. The web service responds to HTTP GET requests.

This API will fulfill both needs to give you details for single extra charges or multiple extra charges at a time. You need to take eZee Reservation to use this API.

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]&check_in_date=[CHECK_IN_DATE]&check_out_date=[CHECK_OUT_DATE]&ExtraChargeId=[EXTRACHARGEID]&Total_ExtraItem=[TOTAL_EXT RAITEM]

Header

–

Parameter

Name	Data Type	Description	Example
[BaseUrl] *	–	Live server URL	https://live.ipms247.com/
[Request_Type] *	–	Use Keyword “CalculateExtraCharge”
[Hotel_Code] *	INT(11)	Unique Hotel code	XXXX
[API_KEY] *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXX
[CHECK_IN_DATE] *	DATE	Pass Check in date in YYYY-MM-DD format	2020-07-05
[CHECK_OUT_DATE] *	DATE	Pass Check out date in YYYY-MM-DD format	2020-07-07
[EXTRACHARGEID] *	VARCHAR(300)	Pass [single\|multiple] extra charge id’s for your property	Single : XXX Multiple : XXX, YYY
[TOTAL_EXT RAITEM] *	VARCHAR(300)	Pass total number of items for [single\|multiple] extra charges	Single : 2 Multiple : 2, 3 Sample 1: Extra charge Rule : Per Pax, Adults : 2, Child : 1 Pass [TOTAL_EXTRAITEM] = 3 Sample 2: Extra charge Rule : Per Quantity, Quantity: 2 Pass [TOTAL_EXTRAITEM] = 2

Request

https://live.ipms247.com/booking/reservation_api/listing.php?request_type=CalculateExtraCharge&HotelCode=XXX&APIKey=XXX&check_in_date=XXX&check_out_date=XXX&ExtraChargeId=XXX&Total_ExtraItem=X

Response

Name	Data Type	Description	Example
IndividualCharge		List of Individual Charge	xxx
TotalCharge		Total of charge	160

Success

{
"IndividualCharge": { "XXX": 150,
"YYY": 10
},
"TotalCharge": 160
}

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.
CheckDate	Check out date should be greater than Check in date
DBConnectError	Database not connected.
getExtraChargeListError	Extra Charge 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.
UnknownError	Unknown Error
4	Timeout requested. Stops requests for the specified time.
InvalidHotelCode	Invalid Hotel code.Please check your property code.
BadRequest	Bad request type.

eZee Reservation Required Meta Search

Configuration

Retrieve Salutations and Country

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.

Meta Search Open

Configuration

Retrieve Room Types

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.

Meta Search Open

Configuration

Retrieve Hotel Amenities

This API provides list of hotels amenities of a property which is used for displaying on any website or 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 “HotelAmenity”	–
[Hotel_Code] *	INT(11)	Unique Hotel code	XXXX
[API_KEY] *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXX
[LANGUAGE]	VARCHAR(20)	[Optional] Default is en. Pass language code. Language codes are available here.	en

Request

https://live.ipms247.com/booking/reservation_api/listing.php?request_type=HotelAmenity&HotelCode=XXX&APIKey=XXX&language=en

Success

[
{
"amenity": "Chinar Hotel @ Spa Naftalan"
},
{
"amenity": "STD and IDD dialing access"
},
{
"amenity": "parking lot"
},
{
"amenity": "Fruit basket upon check-in"
},
]

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.
HotelAmenityListingError	Hotel amenity listing 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.

Meta Search Open

Configuration

Retrieve Hotel Information

This API provides the list of hotel information for groups or chains. This is mainly used for displaying data to the combo box only. The API can return data in JSON formats. The web service responds to HTTP GET requests.

URL 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

The base URI for the web service for Chain Properties is as follows :

[BaseUrl]booking/reservation_api/listing.php?request_type=[Request_Type]&GroupCode=[Group_Code]&APIKey=[API_KEY];

The base URI for the web service for Single Property is as follows :

[BaseUrl]booking/reservation_api/listing.php?request_type=[Request_Type]&HotelCode=[Hotel_Code]&APIKey=[API_KEY];

Header

–

Parameter

Name	Data Type	Description	Example
[BaseUrl] *	–	Live server URL	https://live.ipms247.com/
[request_type] *	–	Use Keyword “HotelList”	–
[GroupCode] * [HotelCode] *	INT(11)	Unique Group code Or Hotel code	XXXXXX or XXXX
[APIKey] *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
[LANGUAGE]	VARCHAR(20)	[Optional] Default is en. Pass language code. Language codes are available here.	en

Single Properties – Request

https://live.ipms247.com/booking/reservation_api/listing.php?request_type=HotelList&HotelCode=XXXX&APIKey=XXXXXX&language=en

Chain Properties – Request

https://live.ipms247.com/booking/reservation_api/listing.php?request_type=HotelList&GroupCode=XXXXXX&APIKey=XXXXXX&language=en

Success

[
{
"Hotel_Code": "xxxx", 
"Hotel_Name": "Hotel Abc", 
"City": "Surat",
"State": "Guj",
"Country": "India",
 "Property_Type": "Resort",
 "HotelImages": [
"abc1.jpg",
"abc21.jpg",
]
},
{
"Hotel_Code": "xxxx", 
"Hotel_Name": "Hotel ZY", 
"City": "Surat",
"State": "Gujarat",
"Country": "India",
 "Property_Type": "Hotel", 
"HotelImages": [
"img.jpg"
]
},
]

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.
HotelListingError	Hotel 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.

Meta Search Open

Configuration

Retrieve Room Information

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

https://live.ipms247.com/pmsinterface/pms_connectivity.php

Header

Content-Type: application/json

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

Kiosk Connectivity Open PMS Connectivity

Configuration

Check Hotel Authentication

This API checks authentication and returns hotel information if authentication is valid. The API can return data in XML formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/index.php/page/service.pos2pms

Header

Content-Type: application/xml

Parameter

Name	Data Type	Description	Example
auth *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
oprn *	VARCHAR(150)	Use Keyword “gethotelinfo”

Request

<?xml version="1.0" standalone="yes"?>
<request>
     <auth>xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</auth>
     <oprn>gethotelinfo</oprn>
</request>

Response

Name	Data Type	Description	Example
status	String	Status value will be providedValues: ok, error	ok
msg	String	Message result will be providedValues: success or error message	success
hotelname	String	Name of Hotel	Hotel
hotelcode	Integer	ID of Room	xxxx

Success

<?xml version='1.0' standalone='yes'?>
<response>
    <status>ok</status>
    <msg>success</msg>
    <hotelname>Mega Hills Hotel</hotelname>
    <hotelcode>xxxx</hotelcode>
</response>

Error

<?xml version='1.0' standalone='yes'?>
<response>
    <status>error</status>
    <msg>Invalid Authentication</msg>
</response>

Error Codes

Errors	Description
Hotel Code In-Active	The Property has been deactivated
API Authkey is deactivated	The Authcode/Key has been deactivated
Invalid Authentication	Invalid data
Bad Request	Invalid Request Parameter
Invalid API Request. Don’t have this API access	Invalid Request Method

POS Connectivity

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Categories

Tags