Others

Retrieve Guest

This API provides the guest profiles by filters. Most properties maintains guest database to accumulate the volume of returning guest, for building good relationships and create a better guest experience. This 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

Key	Datatype	Description	Example
Request_Type *	–	Use Keyword “GuestList”
AuthCode *	Varchar(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
HotelCode *	Integer(11)	Unique Hotel code	XXXX
Ids	Varchar(20)	ID of Travel Agent	xxxxxxxxxxxx
Names	Varchar(20)	Names of travel agent	Peter
FromDate	Date	Update From date. [Format: yyyy-mm-dd]	2020-07-01
ToDate	Date	Update To date. [Format: yyyy-mm-dd]	2020-07-03
isActive	INT(1)	Staus : active or not 1=active, 0=inactive	1 or 0

Request (Without Optional Value)

{
       "RES_Request": 
        {
                 "Request_Type": "GuestList",
                 "Authentication": {
                       "HotelCode": "xxxxx",
                       "AuthCode": "xxxxxxxxxxxxxxxxxxxxxx"
                 }
        }
}

Request (With Optional Value)

{
   "RES_Request":
   {
    "Request_type": "GuestList",
     "Authentication": {
             "HotelCode": "xxxxx",
             "AuthCode": "xxxxxxxxxxxxxxxxxxxxxx"
     },
    "Ids": [ //Optional Filter
        "xxxx",
        "xxxx"
     ],
    "Names": [ //Optional Filter
        "AC Company"
    ],
    "Created": { //Optional Filter
        "from_date": "2019-12-05T00:00:00Z",
        "to_date": "2019-12-10T00:00:00Z"
    },
    "Updated": { //Optional Filter
        "from_date": "2019-12-05T00:00:00Z",
        "to_date": "2019-12-10T00:00:00Z"
    },
    "isActive":"0" //Optional Filter,0 or 1 values where 0 = deactivated company and 1= activated company
  }
}

Response

Name	Datatype	Description	Example
Id	Integer	Unique Company agent id	xxxxxxxxxxxxx
AccountName	String	Businessname	Start Travels
AccountCode	String	Short code	STR.
Contact_person	String	Contact person name	Mr.James
Address	String	Address of Travel agent	New York
City	String	City name	New York
PostalCode	Integer	Postal code	101101
State	String	State name	New York
Country	String	Country name	USA
Phone	Integer	Phone number	123456
Mobile	Integer	Mobile number	1234567890
Fax	Integer	Fax Number	123456789
Email	String	Email id	abc@rmail.com
TaxId	String	Tax id	1
RegistrationNo	String	Registration number	123
CommissionPlan	String	Commission plan name	% on all nights (exclu. Tax)
CommissionValue	Decimal	Commission plan value	5
Discount on the standard rate %	Decimal	Discount percentage	5
IsActive	String	Isactive or note	0 or 1

Success

Response:
{
    "Companies": [
        {
             "Id": "51270000000017",
             "AccountName": "IBM", //Business Name
             "AccountCode": "", // Short Code
             "Contact_person": "Mr. Azad Singh",
             "Address: "Rheinlanddamm 207-209",
             “City": "Dortmund",
             "PostalCode": "44137",
             "State": "",
             "Country": "DE",
             “Phone”:”4334534534”,
             “Mobile”:”9000123456”,
             “Fax”:””,
             “Email”:”azadxyz@yahoo.co.in”,
             “TaxId”:”43534534534”,
             “Registration No”:”A3428973449284”,
             "IsActive": true

        }
    ]
}

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
208	Both Updated from_date and to_date are mandatory if any one date is entered
210	No data found
105	From Date is missing.
106	From Date is not a valid date
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
205	Created to_date should be greater than from_date
108	(To Date) – To Date is not a valid date
207	Updated to_date should be greater than from_dat
107	To Date is missing

Open

Others

Create a Travel Agent

This API helps to insert Travel agents for a property or group of properties in a chain. The API can return data in JSON formats. The web service responds to HTTP GET requests. This API can return data in JSON formats. The web service responds to HTTP GET requests.

You need to take eZee Reservation if you want to allow Travel Agent to book a room on behalf of guests.

End Point URL

[BaseUrl]booking/reservation_api/listing.php?APIKey=[API_KEY]&request_type=[Request_Type]&salutation=[salutation]&name=[name]&businessname=[businessname]&country=[country]&email=[email]&HotelCode=[Hotel_Code]&ismailsend=[Ismailsend]

Header

–

Parameter

Name	Data Type	Description	Example
[BaseUrl] *	–	Live server URL	https://live.ipms247.com/
[Request_Type] *		Use Keyword “InsertTravelAgent”
[Hotel_Code] *	INT(11)	Unique Hotel code	XXXX
[API_KEY] *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXX
[name] *	VARCHAR(100)	Travel agent name	user123
[businessname] *	VARCHAR(100)	Business name	xxxxxx
[salutation] *	VARCHAR(10)	Salutation	xxxx
[country] *	VARCHAR(100)	Country name	USA
[email] *	VARCHAR(100)	Email id	abc@gmail.com
bccmailid	VARCHAR(100)	Add Email-id for taking Bcc copy	abc@gmail.com
businesssource	VARCHAR(10)	Business source	true/false
isusercreated	VARCHAR(10)	Is user created	true/false
percentdiscount	INT(11)	Percentage discount	5
address	VARCHAR(200)	Address	A4-Golden street
city	VARCHAR(100)	City	New York
state	VARCHAR(100)	State	california
zipcode	INT(11)	Zipcode	123456
phone	INT(11)	Phone number	123456789
mobile	INT(11)	Mobile number	1234567890
fax	INT(11)	Fax number	123456
allowtoviewccblock	VARCHAR(10)	For allow to view credit card block	true/false
Sendemailtoguest	VARCHAR(10)	For send booking voucher email to Guest if booking made by Travel Agent from booking engine	true/false
[Ismailsend] *	VARCHAR(10)	For Send email to Travel Agent to share Login Information.	true/false

Request

https://live.ipms247.com/booking/reservation_api/listing.php?APIKey=XX&request_type=InsertTravelAgent&name=XX&businessname=GreenTravel&salutation=MR&country=India&email=XX&HotelCode=XX&percentdiscount=10&businesssource=true&isusercreated=true&ismailsend=true

Success

{
"26":"2600000000001612",
"1023":"102300000000000844",
"3419":"341900000000000098"
}

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.
MANDATORYPARAM	[salutation,name,businessname,email,country ] This Parameters are mandatory.
UnknownError	Unknown Error
InvalidHotelCode	Invalid Hotel code.Please check your property code.
BadRequest	Bad request type.

eZee Reservation Required Meta Search

Others

Retrieve A Travel Agent

This API provides the travel agent profiles by filters. Most properties use this information when a guest books a room through a Travel Agency. Also hotels use this data to accumulate the booking volume they receive from these travel agents on an ongoing basis. This 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

Key	Datatype	Description	Example
Request_Type *	–	Use Keyword “TravelAgentList”
AuthCode *	Varchar(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
HotelCode *	Integer(11)	Unique Hotel code	XXXX
Ids	Varchar(20)	ID of Travel Agent	xxxxxxxxxxxx
Names	Varchar(20)	Names of travel agent	Peter
FromDate	Date	Update From date. [Format: yyyy-mm-dd]	2020-07-01
ToDate	Date	Update To date. [Format: yyyy-mm-dd]	2020-07-03
isActive	INT(1)	Travel agent active or not 1=active, 0=inactive	1 or 0

Request

{
"RES_Request": {
"Request_Type": "TravelAgentList",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxx"
},
"Ids": [
"3ed9e2f3-4bba-4df6-8d41-ab1b009b6425"
],
     "Names": [
],
     "Created": {
 "from_date": "2019-12-05",
         "to_date": "2019-12-10"
     },
     "Updated": {
"from_date": "2019-12-05",
         "to_date": "2019-12-10"
     },
     "isActive":"1"

}
}

Response

Name	Datatype	Description	Example
Id	Integer	Unique Travel agent id	xxxxxxxxxxxxx
AccountName	String	Travel agent Businessname	Start Travels
AccountCode	String	Travel aget short code	STR.
Contact_person	String	Contact person name	Mr.James
Address	String	Address of Travel agent	New York
City	String	City name	New York
PostalCode	Integer	Postal code	101101
State	String	State name	New York
Country	String	Country name	USA
Phone	Integer	Phone number	123456
Mobile	Integer	Mobile number	1234567890
Fax	Integer	Fax Number	123456789
Email	String	Email id	abc@rmail.com
TaxId	String	Tax id	1
RegistrationNo	String	Registration number	123
CommissionPlan	String	Commission plan name	% on all nights (exclu. Tax)
CommissionValue	Decimal	Commission plan value	5
Discount on the standard rate %	Decimal	Discount percentage	5
IsActive	String	IsActive or not	0 or 1

Success

{
    "TravelAgent": [
        {
            "Id": "12340000000000028",
            "AccountName": "ABC",
            "AccountCode": "TABC",
            "Contact_person": "Mr. James",
            "Address": "A234-A",
            "City": "New York",
            "PostalCode": "1000011",
            "State": "New York",
            "Country": "USA",
            "Phone": "9898989898",
            "Mobile": "9898989898",
            "Fax": null,
            "Email": "abc@email.com",
            "TaxId": "1",
            "RegistrationNo": null,
            "CommissionPlan": "% on all nights (exclu. Tax)",
            "CommissionValue": "4.0000",
            "Discount on the standard rate %": "7.0000",
            "IsActive": true
        }
    ]
}

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
208	Both Updated from_date and to_date are mandatory if any one date is entered
210	No data found
105	From Date is missing.
106	From Date is not a valid date
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
205	Created to_date should be greater than from_date
108	(To Date) – To Date is not a valid date
207	Updated to_date should be greater than from_dat
107	To Date is missing

Open

Others

Retrieve a Company

This API provides the company profiles by filters. Most properties use this information to source the correct address for invoicing. Also, hotels use this data to accumulate the booking volume they receive from these companies on an ongoing basis. This 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 “CompanyList”
HotelCode *	INT(11)	Unique Hotel code	XXXX
AuthCode *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
Ids	VARCHAR(300)	Add Identity id and also, can add multiple records	Abc4578lk, yzx7426kj
Names	VARCHAR(300)	Add Business name and also, can add multiple records	33Comp, Abc Company
Created. from_date	DATE	To send a created from date	2020-07-05
Created. to_date	DATE	To send a created to date	2020-07-07
Updated. from_date	DATE	To send a updated from date	2020-07-05
Updated. to_date	DATE	To send a updated to date	2020-07-07
isActive	INT(11)	Is Active in 1 or 0	1

Request

{   
"RES_Request": {
        "Request_Type": "CompanyList",
        "Authentication": {
           "HotelCode": "xxxx",
           "AuthCode": "xxxxxxxxxx"
        },
       "Ids": ["abc4578lk","yzx7426kj"],
       "Names": ["33Comp"],
        "Created": {
           "from_date": "2019-12-05",
           "to_date": "2019-12-10"
       },
       "Updated": {
           "from_date": "2019-12-05",
           "to_date": "2019-12-10"
       },
       "isActive":"1"
       }
}

Response

Name	Data Type	Description	Example
Id	INT(11)	Company record id	2700000000003934
AccountName	VARCHAR(255)	Business name	33Comp
AccountCode	VARCHAR(255)	Business shortcode	33c
Contact_person	VARCHAR(255)	Contact person name	33CompAccount
Address	VARCHAR(255)	Address data	street -5, abc road
City	VARCHAR(255)	City	romania
PostalCode	VARCHAR(255)	PostalCode	895623
State	VARCHAR(255)	State
Country	VARCHAR(255)	Country	Romania
Phone	VARCHAR(100)	Phone	789561234
Mobile	VARCHAR(100)	Mobile	44545454554
Fax	VARCHAR(100)	Fax
Email	VARCHAR(255)	Email	33Comp@gmail.com
TaxId	VARCHAR(255)	TaxId	78
RegistrationNo	VARCHAR(255)	RegistrationNo	vb89
IsActive	VARCHAR(100)	IsActive	false

Success

{    "Companies": [
        {
            "Id": "2700000000003934",
            "AccountName": "33Comp",
            "AccountCode": "33c",
            "Contact_person": "33CompAccount",
            "Address": "street -5, abc road",
            "City": "romania",
            "PostalCode": "895623",
            "State": null,
            "Country": "Romania",
            "Phone": "789561234",
            "Mobile": "44545454554",
            "Fax": null,
            "Email": "33Comp@gmail.com",
            "TaxId": "78",
            "RegistrationNo": "vb89",
            "IsActive": false
        }
    ]
}

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
105	From Date is missing
107	To Date is missing
109	Please check From and To date. To Date should be greater than fromdate
208	Both Updated from_date and to_date are mandatory if any one date is entered
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
106	From Date is not a valid date
108	To Date is not a valid date
112	Error: Date range is too long. Please provide dates for 1 month.
210	No data found

Open

Others

Retrieve Guest Stays Statistics

This API gives us the guest stays statistics by which one can accumulate the volume of returning guests thereby helping to create the best guest experience. This API can return data in CSV formats. The web service responds to HTTP POST requests.

End Point URL

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

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

{  
    "hotel_code":"xxxx",
    "authkey" : "xxxxxxxxxxxx"
}

Response

Name	Data Type	Description	Example
Guest Name	String	To get a guest name	Daniel L
Guest Email	String	To get a guest email address	Daniele123@yahoo.com
Total Number of stays	String	To get a guest’s total number of stay in a hotel	2
First stay	Date	To get a guest’s first stay	2020-05-02
First Reservation No	String	To get a guest’s first reservation number	5-1
First Folio No	String	To get a guest’s first folio number	5
Last stay	Date	To get a guest’s last stay	2020-05-02
Last Reservation No	String	To get a guest’s last reservation number	5-1
Last Folio No	String	To get a guest’s last folio number	5
Next stay	Date	To get a guest’s next stay
Next Reservation No	String	To get a guest’s next reservation number
Next Folio No	String	To get a guest’s next folio number
Lifetime Spending	String	To get amount spend	2560.0000

Success

"Guest Name","Guest Email","Total Number of stays","First stay","First Reservation No","First Folio No","Last stay","Last Reservation No","Last Folio No","Next stay","Next Reservation No","Next Folio No","Lifetime Spending"
"Mr. Michel Joy","","1","2020-03-11","5-1","2","2020-03-11","5-1","2","","","","3863.0000"
"Mr. Rechel","","1","2020-03-11","5-2","3","2020-03-11","5-2","3","","","","0.0000"

Error Codes

Property Deactivated : This property has been deactivated
OpenAPI Record invalid : Unauthorized Request. This request is not valid for this hotel code
OpenAPI Deactivated : Auth Code is inactive.
OpenAPI Request : Invalid API Request. Don't have this API access.

Open

Parameter

Parameter

Parameter

Parameter

Parameter

Categories

Tags