Add Guest Profile to Bookings

by

This API helps you to Add Sharer data (name, phone, mobile, email, etc). The API can return data in JSON formats. The web service responds to HTTP POST requests.

Note : Maximum Five sharers  will only be processed at a time.

End Point URL

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

Header

Content-Type: application/json

Parameter

NameData TypeDescriptionExample
HotelCode*INT(11)Unique Hotel codexxxx
AuthCode*VARCHAR(300)Unique Authentication codexxxxxxxxxx
Request_Type*VARCHAR(100)Request TypeAddSharer
Sharers->BookingId*VARCHAR(255)Unique Booking Id/Reservation No456
Sharers->SalutationVARCHAR(100)SalutationMr.
Sharers->FirstName*VARCHAR(500)First Namexxxxxx
Sharers->LastName*VARCHAR(500)Last Namexxxxxx
Sharers->Gender*VARCHAR(25)Male/FemaleMale/Female
Sharers->Type*VARCHAR(25)For Update Type (Adult/Child)Adult
Sharers->DateOfBirthDATEDate Of Birthformat: YYYY-MM-DD1985-05-05
Sharers->SpouseDateOfBirthDATESpouse date of birthformat: YYYY-MM-DD1987-01-25
Sharers->WeddingAnniversaryDATEWedding anniversary dateformat: YYYY-MM-DD1987-10-05
Sharers->AddressVARCHAR(1000)Address500 Kingston
Sharers->CityVARCHAR(100)Name of cityToronto
Sharers->StateVARCHAR(100)State nameOntario
Sharers->CountryVARCHAR(100)Country nameCanada
(for country 
https://api.ezeetechnosys.com/#589
Sharers->NationalityVARCHAR(100)NationalityIndia
(for country 
https://api.ezeetechnosys.com/#589)
Sharers->ZipcodeInteger(11)zip code123456
Sharers->PhoneInteger(20)Phone number1234567890
Sharers->MobileInteger(20)Mobile number1234567890
Sharers->FaxInteger(20)Fax number1234567890
Sharers->Email*VARCHAR(255)Email id abc@xyz.com
Sharers->RegistratioNoVARCHAR(255)Registration number12345
Sharers->IdentityIdBIGINT(20)Identity unique Id1234500000000000001
Sharers->IdentityNoVARCHAR(255)Identity type number123456789
Sharers->ExpiryDateDATEExpiry dateformat: YYYY-MM-DD2022-05-02

Request 

1.For Single Booking Request
{
   "RES_Request": {
         "Request_Type": "AddSharer",
         "Authentication": {
               "HotelCode": "xxxx",
               "AuthCode": "xxxxxxxxxxxx"
           },
         "Sharers": [{
                "BookingId": "RES101",  
                "Salutation": "Ms.",
                "FirstName": "Hexvi.S.", 
                "LastName": "Shaby", 
                "Gender": "Female", 
                "Type": "Adult",         
                "DateOfBirth": "",
                "SpouseDateOfBirth": "",
                "WeddingAnniversary": "",
                "Address": "",
                "City": " Brockway",
                "State": "CA",
                "Country": "Germany",
                "Nationality": "Malta",
                "Zipcode": "95730",
                "Phone": "",
                "Mobile": "3534",
                "Fax": "564564",
                "Email": "LarryLForney@rhyta.com", 
                "RegistrationNo": "",
                "IdentityTypeID": "894300000000000003",
                "IdentityNo": "12345667765",
                "ExpiryDate": ""
           }
           ]
       }
 }

2.For Multiple Booking Request
{
  "RES_Request": {
        "Request_Type": "AddSharer",
        "Authentication": {
               "HotelCode": "xxxx",
               "AuthCode": "xxxxxxxxxxxx"
         },
        "Sharers": [{
               "BookingId": "RES102", 
               "Salutation": "Ms.",
               "FirstName": "Willi", 
               "LastName": "Crooswoth", 
               "Gender": "Female", 
               "Type": "Adult",         
               "DateOfBirth": "",
               "SpouseDateOfBirth": "",
               "WeddingAnniversary": "",
               "Address": "",
               "City": " Brockway",
               "State": "CA",
               "Country": "Germany",
               "Nationality": "Malta",
               "Zipcode": "95730",
               "Phone": "",
               "Mobile": "3534",
               "Fax": "564564",
               "Email": "LarryLForney@rhyta.com",  
               "RegistrationNo": "",
               "IdentityTypeID": "2700000000000001",
               "IdentityNo": "12345667765",
               "ExpiryDate": ""
          },
          {
               "BookingId": "RES112",
               "Salutation": "Ms.",
               "FirstName": "Test",
               "LastName": "One",
               "Gender": "Female",
               "Type": "Adult",
               "DateOfBirth": "",
               "SpouseDateOfBirth": "",
               "WeddingAnniversary": "",
               "Address": "",
               "City": " Brockway",
               "State": "CA",
               "Country": "Germany",
               "Nationality": "Malta",
               "Zipcode": "95730",
               "Phone": "",
               "Mobile": "3534",
               "Fax": "564564",
               "Email": "LarryLForney@rhyta.com",
               "RegistrationNo": "",
               "IdentityTypeID": "2700000000000001",
               "IdentityNo": "12345667765",
               "ExpiryDate": ""

          }
           ]
      }
 }

Response

NameData TypeDescription Example
Success->SuccessMsgStringSuccess MessageSuccessfully Done
Errors->ErrorCodeintegerError Code100
Errors->ErrorMessageStringError MessageSuccess

Success

1.Full operation is successfully completed
{
    "Success": {
        "SuccessMsg": "Sharer is successfully added for Booking RES101"
    },
    "Errors": {
        "ErrorCode": "0",
        "ErrorMessage": "Success"
    }
}


2.Full operation Is successfully completed for multiple booking
{
        "Success": {
              "SuccessMsg": "Sharer is successfully added for Booking RES101,RES112"
        },
        "Errors": {
             "ErrorCode": "0",
             "ErrorMessage": "Success"
        }
}
3.In case some booking are successfully added and some have errors for multiple bookings
{
    "Success": {
        "SuccessMsg": "Sharer is successfully added for Booking RES101"
    },
    "Errors": [
        {
            "ErrorCode": "114",
            "ErrorMessage": 
                "Country not properly added, it should be according to our database for Booking : RES112"
        }
    ]
}

Error

{
    "Errors": {
        "ErrorCode": "615",
        "ErrorMessage": "Unauthorized Request: This request is not valid."
    }
}

Error Codes

Error CodeError Name
100Missing required parameters
500Error occurred during processing.
502Invalid Request Type
101Hotel Code is missing
102Authentication Code is missing
303Auth Code is inactive
201Unauthorized request.(Request Type) request is not valid for this hotel code
202Unauthorized request. Hotel code is not active
615Unauthorized Request: This request is not valid.
600Something went wrong. please try again. Booking
110BookingId is missing
111You cannot add more sharers as the maximum limit for adults reached for the type of room offered, so adding Sharer failed for Booking
112You cannot add more sharers as the maximum limit for children reached for the type of room offered, so adding Sharer failed for Booking
121Either firstname/lastName or Email is mandatory to process your request for Booking
114Country/Nationality is not properly added, it should be according to our database for Booking
115Invalid field <field> for Booking
116Invalid value “<value>” for field “<field name>” for Booking
113We don’t find this reservation in our system. So you can’t add guest for Booking
117Reservation is canceled,noshow or void. So you can’t add guest for Booking
118Reservation is past checked out. So you can’t add guest for Booking
120Maximum five sharers will be processed at a time

Click here to Register