Kiosk Connectivity
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
Header
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 |
Bookings
Retrieve List of Bills
This API will fetch the folio related billing information for particular reservation no. like folio no, due amount, total amount, total paid amount, guest name, billing person name The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
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 | RetrieveListofBills |
| BookingId* | VARCHAR(100) | Reservation No. | 11-1 or 12 |
Request
{
"RES_Request": {
"Request_Type": "RetrieveListofBills",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxxxxxx",
"BookingId": "7"
}
}
}
Response
| Name | Data Type | Description | Example |
| FolioList->foliono | Integer | Folio no | 302 |
| FolioList->BillToContact | varchar | Name of billing person | Baiju |
| FolioList->GuestName | varchar | Name of guest who booked reservation | Winsent Lobo |
| FolioList->CurrencyCode | varchar | Currency Code | INR |
| FolioList->TotalCharges | float | Total charges of folio | 500.00 |
| FolioList->PaidAmo | float | Total paid amount of folio | 200.00 |
| FolioList->DueAmount | float | Total due amount of folio | 300.00 |
Success
{
"Success": {
"FolioList": [
{
"foliono": "297",
"BillToContact": "max",
"GuestName": "max",
"CurrencyCode": "INR",
"TotalCharges": "500.00",
"PaidAmount": "-200.00",
"DueAmount": "300.00"
},
{
"foliono": "298",
"BillToContact": "max",
"GuestName": "max",
"CurrencyCode": "INR",
"TotalCharges": "600.00",
"PaidAmount": "-200.00",
"DueAmount": "400.00"
}
]
},
"Errors":{
"ErrorCode": "0",
"ErrorMessage": "Success"
}
}
Error
{
"Errors": {
"ErrorCode": "203",
"ErrorMessage": "Reservation is not found for booking 25"
}
}
Error Codes
| Error Code | Error Name |
| 100 | Missing required parameter – BookingId |
| 500 | Error occurred during processing |
| 502 | Request Type is missing |
| 101 | Hotel Code is missing |
| 102 | Authentication Code is missing |
| 103 | Booking ID is missing |
| 104 | Invalid parameter for bookingId |
| 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 | Reservation is not found for booking |
| 204 | Reservation is cancelled, noshow or void for booking |
Bookings
Guest Check Out
This API helps you to check out your reservation. The API can return data in JSON formats. The web service responds to HTTP POST requests.
Note: Maximum Five checkout will be allowed at a time.
End Point URL
Header
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 | GuestCheckOut |
| Reservation-> BookingId* | VARCHAR(150) | Unique Booking Id/Reservation No | 456 or RES-456 |
Request
1.For Single Booking Request
{
"RES_Request": {
"Request_Type": "GuestCheckOut",
"Authentication": {
"HotelCode": "xxxxx",
"AuthCode": "xxxxxxxxxxxxxxxxxxxxxxx"
},
"Reservation": [
{
"BookingId": "575"
}
]
}
}
2.For Multiple Booking Request
{
"RES_Request": {
"Request_Type": "GuestCheckOut",
"Authentication": {
"HotelCode": "xxxxx",
"AuthCode": "xxxxxxxxxxxxxxxxxxxxxxx"
},
"Reservation": [
{
"BookingId": "575"
},
{
"BookingId": "576"
},
]
}
}
Response
| Name | Data Type | Description | Example |
| Success-> SuccessMsg | String | Success Message | Successfully Done |
| Success-> Invoices-> BookingId | String | Booking Id | 575 |
| Success-> Invoices-> InvoiceNo | String | Invoice Number | 65 |
| Errors->ErrorCode | integer | Error Code | 0 |
| Errors->ErrorMessage | String | Error Message | Success |
Success
1.Full operation is successfully completed
{
"Success": {
"SuccessMsg": "Guest Check Out is successfully done for Booking 575",
"Invoices": [
{
"BookingId": "575",
"InvoiceNo": "65"
}
]
},
"Errors": [
{
"ErrorCode": "0",
"ErrorMessage": "Success"
}
]
}
2.Full operation is successfully completed for multiple booking
{
"Success": {
"SuccessMsg": "Guest Check Out is successfully done for Booking 575,576",
"Invoices": [
{
"BookingId": "575",
"InvoiceNo": "65"
},
{
"BookingId": "576",
"InvoiceNo": "66"
}
]
},
"Errors": [
{
"ErrorCode": "0",
"ErrorMessage": "Success"
}
]
}
3.In case some bookings are successfully checked out and some have errors for multiple bookings
{
"Success": {
"SuccessMsg": "Guest Check Out is successfully done for Booking 575,576",
"Invoices": [
{
"BookingId": "575",
"InvoiceNo": "65"
},
{
"BookingId": "576",
"InvoiceNo": "66"
}
]
},
"Error": [
{
"ErrorCode": 118,
"ErrorMessage": "Booking status has been checked out for Booking 524"
}
]
}
Error
{
"Error": [
{
"ErrorCode": 100,
"ErrorMessage": "Missing required parameters."
}
]
}
Error Codes
| Error Code | Error Name |
| 100 | Missing required parameters. |
| 500 | Error occurred during processing |
| 501 | Error occurred during CheckIn processing |
| 502 | Request Type is missing |
| 600 | Something went wrong! |
| 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 |
| 110 | Booking ID is missing in Reservation block |
| 113 | We don’t find this reservation in our system. So guest check out not performed for booking. |
| 114 | Folio pending on reservation. So guest check out is not performed for Booking |
| 115 | Reservation is not yet checked in. So guest check out is not performed for Booking |
| 116 | Today is not a check out date. So guest check out is not performed for Booking |
| 117 | Booking status has been cancelled, noshow or void. So guest check out is not performed for Booking |
| 118 | Booking status has been checked out for Booking |
| 129 | You are not allowed to check out for more than five bookings |
Bookings
Room Assignment
This API helps you to Assign Room to your reservation. The API can return data in JSON formats. The web service responds to HTTP POST requests.
Note: Maximum Five bookings will be processed at a time.
End Point URL
Header
| Name | Data Type | Description | Example |
| HotelCode* | INT(11) | Unique Hotel code | xxxx |
| AuthCode* | VARCHAR(300) | Unique Authentication code | xxxxxxxxxxxx |
| Request_Type* | VARCHAR(100) | Request Type | AssignRoom |
| RoomAssign->BookingId* | VARCHAR(100) | Reservation No. | RES101,RES112-1 |
| RoomAssign->RoomTypeID* | BIGINT(20) | Unique RoomType ID | 1234500000000000001 Please check API Retrieve Room Information to get RoomTypeID https://api.ezeetechnosys.com/?#519 |
| RoomAssign->RoomID* | BIGINT(20) | Unique Room ID | 1234500000000000001 Please check API Retrieve Room Information to get RoomID https://api.ezeetechnosys.com/?#519 |
Request
{
"RES_Request": {
"Request_Type": "AssignRoom",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxx"
},
"RoomAssign": [{
"BookingId": "RES101",
"RoomTypeID": "1234500000000000001",
"RoomID": "1234500000000000001"
},
{
"BookingId": "RES112-1",
"RoomTypeID": "1234500000000000002",
"RoomID": "1234500000000000002"
}]
}
}
Response
| Name | Data Type | Description | Example |
| Success->SuccessMsg | String | Success Message | Successfully Done |
| Errors->ErrorCode | Integer | Error Code | 100 |
| Errors->ErrorMessage | String | Error Message | Success |
Success
{
"Success": {
"SuccessMsg": "Room Assignment is successfully done for Booking RES101,RES112-1. "
},
"Errors": {
"ErrorCode": "0",
"ErrorMessage": "Success"
}
}
Only 1 Room Assigned Success
{
"Success": {
"SuccessMsg": "Room Assignment is successfully done for Booking RES101"
},
"Errors": {
"ErrorCode": "111",
"ErrorMessage": "Room ID does not belongs to Room Type ID for Booking RES112-1 "
}
}
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 |
| 108 | Booking ID is missing |
| 110 | Room ID is missing for Booking |
| 111 | Room ID does not belongs to Room Type ID for Booking |
| 112 | You are not allowed to room assign for more than five |
| 113 | Booking Id does not exist OR Booking status is void/ cancel/ noshow |
| 114 | Room Type ID is missing for Booking |
| 115 | Room Type ID does not exist for Booking |
| 116 | Room Type ID is not matching with Booking |
| 118 | Invalid Parameter for Booking |
| 127 | Booking Status is not confirmed. so, there is not possible to assign room to Booking |
| 129 | Room has already assigned to Booking |
| 130 | Booking status is checked out. so, there is not possible to assign room to Booking |
| 131 | Room has been already assigned to other booking. So, room assignment is not possible on Booking |
Bookings
Guest Check In
This API helps you to check in to your reservation. The API can return data in JSON formats. The web service responds to HTTP POST requests.
Note: Maximum Five bookings will be processed at a time.
End Point URL
Header
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 | GuestCheckIn |
| Reservation-> BookingId* | VARCHAR(150) | Unique Booking Id/Reservation No | 456 or RES-456 |
| Reservation-> GuestName * | VARCHAR(250) | Guest Name (same as booking Guest Name) | Yasir P Wayde |
| Reservation-> Email * | VARCHAR(250) | Guest Email (same as booking Guest Email) | xxxxxx@example.com |
| Reservation-> Address * | VARCHAR(250) | Guest Address | Street – 5, Sector-10, Main road, Mumbai |
| Reservation-> Phone * | VARCHAR(25) | Guest Phone number | 91XXXXXXXXXX |
| Reservation-> Mobile * | VARCHAR(25) | Guest Mobile number | 91XXXXXXXXXX |
| Reservation-> IdentityTypeID | BIGINT(20) | Identity Unique Id | 1234500000000000001 (To get this ID, please check API [Retrieve Identity Type]) https://api.ezeetechnosys.com/#2059 |
| Reservation-> IdentityNo | VARCHAR(25) | Identity type number | 123456789 |
| Reservation-> IdentityImage | TEXT | Identity image (Encoded Image String) | iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA3NCSVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg== |
| Reservation-> GuestImage | TEXT | Guest image (Encoded Image String) | iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA3NCSVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg== |
| Reservation-> GuestSignature | TEXT | Guest Signature image (Encoded Image String) | iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA3NCSVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg== |
| Reservation-> TaxationId | VARCHAR(155) | Registration number | 123456789 |
Request
1.For Single Booking Request
{
"RES_Request": {
"Request_Type": "GuestCheckIn",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxxxxxxxxxxxxx"
},
"Reservation": [
{
"BookingId": "331",
"GuestName": "XXXXXXXXX",
"Email": "xxxxxx@example.com",
"Address": "XXXXX road",
"Phone": "xxxxxxxxx",
"Mobile": "xxxxxxxxx",
"IdentityTypeID": "1234500000000000001",
"IdentityNo": "xxxxxx",
"IdentityImage": "iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA 3NCSVQICAjb4U/gAAAAEHRF WHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQA AAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"GuestImage": "iVBORw0KGgoAAAANSUhEUgAAABMAAA AWCAIAAACt/zAoAAAAA3NCSVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"GuestSignature": "iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA3NC SVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"TaxationId": "xxxxx"
}
]
}
}
2.For Multiple Booking Request
{
"RES_Request": {
"Request_Type": "GuestCheckIn",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxxxxxxxxxxxxx"
},
"Reservation": [
{
"BookingId": "333-1",
"GuestName": "XXXXXXXXX",
"Email": "xxxxxx@example.com",
"Address": "XXXXX road",
"Phone": "xxxxxxxxx",
"Mobile": "xxxxxxxxx",
"IdentityTypeID": "1234500000000000001",
"IdentityNo": "xxxxxx",
"IdentityImage": "iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA 3NCSVQICAjb4U/gAAAAEHRF WHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQA AAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"GuestImage": "iVBORw0KGgoAAAANSUhEUgAAABMAAA AWCAIAAACt/zAoAAAAA3NCSVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"GuestSignature": "iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA3NC SVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"TaxationId": "xxxxx"
},
{
"BookingId": "333-2",
"GuestName": "XXXXXXXXX",
"Email": "xxxxxx@example.com",
"Address": "XXXXXXXXX road",
"Phone": "xxxxxxxxx",
"Mobile": "xxxxxxxxx",
"IdentityTypeID": "1234500000000000001",
"IdentityNo": "xxxxxx",
"IdentityImage": "iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA 3NCSVQICAjb4U/gAAAAEHRF WHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQA AAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"GuestImage": "iVBORw0KGgoAAAANSUhEUgAAABMAAA AWCAIAAACt/zAoAAAAA3NCSVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"GuestSignature": "iVBORw0KGgoAAAANSUhEUgAAABMAAAAWCAIAAACt/zAoAAAAA3NC SVQICAjb4U/gAAAAEHRFWHRTb2Z0d2FyZQBTaHV0dGVyY4LQCQAAAFRJREFUOMtj/Pr1KwNZgImBXDBSdLLglz5268P0PY+fvf/1+ccfYnX+/fd/xt4nCw89I9m15x98xqMNn85Fh5+RGUK3nn8lU+e7r39G09CoTtrqBAB1MiHSwHyEmgAAAABJRU5ErkJggg==",
"TaxationId": "xxxxx"
}
]
}
}
Response
| Name | Data Type | Description | Example |
| Success-> SuccessMsg | String | Success Message | Successfully Done |
| Success-> GuestRegistrationCards-> BookingId | String | Booking Id | 331 |
| Success-> GuestRegistrationCards-> GRCardNo | String | GR Card Number | 34 |
| Errors->ErrorCode | integer | Error Code | 0 |
| Errors->ErrorMessage | String | Error Message | Success |
Success
1.Full operation is successfully completed
{
"Success": {
"SuccessMsg": "Guest Check In successfully for Booking 331",
"GuestRegistrationCards": [
{
"BookingId": "331",
"GRCardNo": "34"
}
]
},
"Errors": [
{
"ErrorCode": "0",
"ErrorMessage": "Success"
}
]
}
2.Full operation is successfully completed for multiple booking
{
"Success": {
"SuccessMsg": "Guest Check In successfully for Booking 333-1,333-2",
"GuestRegistrationCards": [
{
"BookingId": "333-1",
"GRCardNo": "34"
},
{
"BookingId": "333-2",
"GRCardNo": "35"
}
]
},
"Errors": [
{
"ErrorCode": "0",
"ErrorMessage": "Success"
}
]
}
3.In case some bookings are successfully checked in and some have errors for multiple bookings
{
"Success": {
"SuccessMsg": "Guest Check In successfully for Booking 331-2,332",
"GuestRegistrationCards": [
{
"BookingId": "331-2",
"GRCardNo": "34"
},
{
"BookingId": "332",
"GRCardNo": "35"
}
]
},
"Error": [
{
"ErrorCode": 128,
"ErrorMessage": "Guest has already checked in. So guest check in not performed for Booking 331-1"
}
]
}
Error
{
"Error": [
{
"ErrorCode": 100,
"ErrorMessage": "Missing required parameters."
}
]
}
Error Codes
| Error Code | Error Name |
| 100 | Missing required parameters. |
| 500 | Error occurred during processing |
| 501 | Error occurred during CheckIn processing |
| 502 | Request Type is missing |
| 600 | Something went wrong! |
| 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 |
| 110 | Booking ID is missing in Reservation block |
| 111 | Identity Image string should be in base64_encoded format, So Identity Image not uploaded for booking |
| 112 | Booking Details : GuestName, Address, Email, Phone, Mobile is mandatory to process your checkin request. So guest check in not performed for booking |
| 113 | We don’t find this reservation in our system. So guest check in not performed for booking. |
| 114 | Guest Image string should be in base64_encoded format, So Guest Image not uploaded for booking |
| 115 | Guest Signature string should be in base64_encoded format, So Guest Signature not uploaded for booking |
| 116 | Room is not assigned, so guest check in not performed for booking |
| 117 | Room is dirty, so guest check in not performed for booking |
| 118 | Invalid Fields |
| 119 | Invalid Email address For Booking |
| 120 | <Fields> – Compulsory Fields in order to process for check in |
| 121 | Guest Data is not updated For Booking |
| 122 | The IdentityTypeID is not matching with Hotel Data for Booking |
| 123 | Guest Identity Image is not uploaded For Booking |
| 124 | Guest Image is not uploaded For Booking |
| 125 | Guest Signature is not uploaded For Booking |
| 126 | Today is not a check in date. So guest check in not performed for Booking |
| 127 | Booking Status is not confirmed. So guest check in not performed for Booking |
| 128 | Guest has already checked in. So guest check in not performed for Booking |
| 129 | You are not allowed to check in for more than five bookings. |
| 130 | Booking status is check out. So guest check in not performed for Booking |
| 133 | Room is occupied or not checked-out |
Bookings
Add Guest Profile to Bookings
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
Header
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 | AddSharer |
| Sharers->BookingId* | VARCHAR(255) | Unique Booking Id/Reservation No | 456 |
| Sharers->Salutation | VARCHAR(100) | Salutation | Mr. |
| Sharers->FirstName* | VARCHAR(500) | First Name | xxxxxx |
| Sharers->LastName* | VARCHAR(500) | Last Name | xxxxxx |
| Sharers->Gender* | VARCHAR(25) | Male/Female | Male/Female |
| Sharers->Type* | VARCHAR(25) | For Update Type (Adult/Child) | Adult |
| Sharers->DateOfBirth | DATE | Date Of Birthformat: YYYY-MM-DD | 1985-05-05 |
| Sharers->SpouseDateOfBirth | DATE | Spouse date of birthformat: YYYY-MM-DD | 1987-01-25 |
| Sharers->WeddingAnniversary | DATE | Wedding anniversary dateformat: YYYY-MM-DD | 1987-10-05 |
| Sharers->Address | VARCHAR(1000) | Address | 500 Kingston |
| Sharers->City | VARCHAR(100) | Name of city | Toronto |
| Sharers->State | VARCHAR(100) | State name | Ontario |
| Sharers->Country | VARCHAR(100) | Country name | Canada (for country https://api.ezeetechnosys.com/#589 |
| Sharers->Nationality | VARCHAR(100) | Nationality | India (for country https://api.ezeetechnosys.com/#589) |
| Sharers->Zipcode | Integer(11) | zip code | 123456 |
| Sharers->Phone | Integer(20) | Phone number | 1234567890 |
| Sharers->Mobile | Integer(20) | Mobile number | 1234567890 |
| Sharers->Fax | Integer(20) | Fax number | 1234567890 |
| Sharers->Email* | VARCHAR(255) | Email id | abc@xyz.com |
| Sharers->RegistratioNo | VARCHAR(255) | Registration number | 12345 |
| Sharers->IdentityId | BIGINT(20) | Identity unique Id | 1234500000000000001 |
| Sharers->IdentityNo | VARCHAR(255) | Identity type number | 123456789 |
| Sharers->ExpiryDate | DATE | Expiry dateformat: YYYY-MM-DD | 2022-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
| Name | Data Type | Description | Example |
| Success->SuccessMsg | String | Success Message | Successfully Done |
| Errors->ErrorCode | integer | Error Code | 100 |
| Errors->ErrorMessage | String | Error Message | Success |
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 Code | Error Name |
| 100 | Missing required parameters |
| 500 | Error occurred during processing. |
| 502 | Invalid Request Type |
| 101 | Hotel Code is missing |
| 102 | Authentication Code is missing |
| 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 |
| 615 | Unauthorized Request: This request is not valid. |
| 600 | Something went wrong. please try again. Booking |
| 110 | BookingId is missing |
| 111 | You cannot add more sharers as the maximum limit for adults reached for the type of room offered, so adding Sharer failed for Booking |
| 112 | You cannot add more sharers as the maximum limit for children reached for the type of room offered, so adding Sharer failed for Booking |
| 121 | Either firstname/lastName or Email is mandatory to process your request for Booking |
| 114 | Country/Nationality is not properly added, it should be according to our database for Booking |
| 115 | Invalid field <field> for Booking |
| 116 | Invalid value “<value>” for field “<field name>” for Booking |
| 113 | We don’t find this reservation in our system. So you can’t add guest for Booking |
| 117 | Reservation is canceled,noshow or void. So you can’t add guest for Booking |
| 118 | Reservation is past checked out. So you can’t add guest for Booking |
| 120 | Maximum five sharers will be processed at a time |
Bookings
Add Payment
This API will post the payment with cash/bank type paymethods to a particular single or multiple reservation no. The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
| 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 | AddPayment |
| Reservation->BookingId* | VARCHAR(100) | Reservation No. | 11-1 or 12 |
| Reservation->PaymentId* | INT(20) | Payment Unique id (Click here to get PaymentID) https://api.ezeetechnosys.com/#2048 | 123400000000000007 |
| Reservation->CurrencyId* | INT(20) | Currency Unique id (Click here to get CurrencyId) https://api.ezeetechnosys.com/#2048 | 123400000000000001 |
| Reservation->Payment* | DECIMAL(19,4) | Amount to pay | 100.00 |
| Reservation->Comment | VARCHAR(100) | Comment is optional | Payment for room charges |
| Receipt->FolioNo | INT(20) | FolioNo is optional | 302 |
Request
{
"RES_Request": {
"Request_Type": "AddPayment",
"Authentication": {
"HotelCode": "1234",
"AuthCode": "xxxxxxxxxxxxxxxx"
},
"Reservation": [{
"BookingId": "11-1",
"FolioNo": "", //Optional
"PaymentId": "123400000000000007",
"CurrencyId": "123400000000000001",
"Payment": "70",
"Comment": "payment"
},
{
"BookingId": "12",
"FolioNo": "302", //Optional
"PaymentId": "123400000000000007",
"CurrencyId": "123400000000000001",
"Payment": "200",
"Comment": "payment"
}]
}
}
Parameter
Response
| Name | Data Type | Description | Example |
| Receipt->BookingId | varchar | Reservation No. | 12 |
| Receipt->ReceiptNo | Integer | Receipt No. | 230 |
Success
{
"Success": {
"SuccessMsg": "Payment done successfully for booking 11-1, 12",
"Receipt": [
{
"BookingId": "11-1",
"ReceiptNo": "1521,1524"
},
{
"BookingId": "12",
"ReceiptNo": "1522,1523"
}
]
},
"Errors":[ {
"ErrorCode": "0",
"ErrorMessage": "Success"
}
]
}
Success/Error:
{
"Success": {
"SuccessMsg": "Payment done successfully for booking 12",
"Receipt": [
{
"BookingId": "12",
"ReceiptNo": "232"
}
]
},
"Errors": [
{
"ErrorCode": "113",
"ErrorMessage": "We don't find this reservation in our system. So payment not processed for booking 13"
}
]
}
Error
{
"Errors": [
{
"ErrorCode": "106",
"ErrorMessage": "Payment amount is missing or invalid payment amount for booking 11-1"
}
]
}
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 |
| 103 | Booking ID is missing |
| 104 | Payment Id is missing for booking |
| 105 | Currency Id is missing for booking |
| 106 | Payment amount is missing or invalid payment amount for booking |
| 108 | Error in folio. |
| 109 | Maximum 10 bookings are allowed at a time. |
| 110 | Payment ID not valid |
| 114 | Currency is not valid for booking |
| 115 | Amount is exceeded than folio balance for booking |
| 116 | Invalid parameter for booking |
| 113 | We don’t find this reservation in our system. So payment not processed for booking |
| 117 | Reservation is void. So payment not processed for booking |
| 118 | Reservation is past checked out. So payment not processed for booking |
| 119 | Invalid folio no for booking |
Bookings
Guest Data Update
This API helps you to update guest data (name, phone, mobile, email, etc) and upload documents (guest identity, guest signature, guest image, and voucher image). The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
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 | UploadDocument |
| BookingId* | VARCHAR(255) | Unique Booking Id/Reservation No | 456 |
| FirstName* | VARCHAR(500) | First Name | Torben |
| LastName* | VARCHAR(500) | Last Name | L. Schou |
| Email* | VARCHAR(255) | Email Id | abc@xyz.com |
| UpdateSinglebooking | INT(11) | It is an optional field but please set 1 If you want to update guest data for a single booking. | Value : 1 or 0 For ex: Group Booking: 150 No of Booking: 2 ResNo = 150-1 | Guest = Mr Sanjay ResNo = 150-2 | Guest = Mr Sanjay -> If you want to update ResNo = 150-2 and Mr. Sanjay to Mr. Bharat, you can do it using this parameter. |
| UpdateGuestData->Salutation | VARCHAR(100) | Salutation | Mr |
| UpdateGuestData->FirstName | VARCHAR(500) | For Update First Name | Torben |
| UpdateGuestDat->LastName | VARCHAR(500) | For Update Last Name | L. Schou |
| UpdateGuestData->Gender | VARCHAR(25) | For Update Gender | Male |
| UpdateGuestData->Type | For Update Type (Adult/Child) | Aduit | |
| UpdateGuestData->DateOfBirth | DATE | Date Of Birth | 1985-05-05 |
| UpdateGuestData->SpouseDateOfBirth | DATE | Spouse Date Of Birth | 1987-01-25 |
| UpdateGuestData->WeddingAnniversary | DATE | Wedding Anniversary Date | 1987-10-05 |
| UpdateGuestData->Address | VARCHAR(4000) | Address | 500 Kingston |
| UpdateGuestData->City | VARCHAR(255) | Name of City | Toronto |
| UpdateGuestData->State | VARCHAR(255) | State name | Ontario |
| UpdateGuestData->Country | VARCHAR(255) | Country name | Canada (for country https://api.ezeetechnosys.com/#589) |
| UpdateGuestData->Nationality | VARCHAR(255) | Nationality | India (for country https://api.ezeetechnosys.com/#589) |
| UpdateGuestData->Zipcode | Integer(11) | zip code | 123456 |
| UpdateGuestData->Phone | Integer(20) | Phone number | 1234567890 |
| UpdateGuestData->Mobile | Integer(20) | Mobile Number | 1234567890 |
| UpdateGuestData->Fax | Integer(20) | Fax number | 1234567890 |
| UpdateGuestData->Email | VARCHAR(255) | Email id | abc@xyz.com |
| UpdateGuestData->RegistrationNo | VARCHAR(255) | Registration Number | 12345 |
| UpdateGuestData->IdentityTypeID | BIGINT(20) | Identity Unique Id | 1234500000000000001 (To get this ID, please check API [Retrieve Identity Type]) https://api.ezeetechnosys.com/#2059 |
| UpdateGuestData->IdentityNo | VARCHAR(255) | Identity type number | 123456789 |
| UpdateGuestData->ExpiryDate | DATE | Expiry Date | 2022-05-02 |
| Documents->Type | Integer(1) | Type Of Document Upload | 1 = Identity, 2 = Signature, 3 = Guest Image, 4 = Guest Vouchers |
| Documents->Images | String | Encoded Image String | Alpha-numeric String |
Request
1.For Single Booking Request
{
"RES_Request": {
"Request_Type": "UploadDocument",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxx"
},
"Reservation": [
{
"BookingId": "123",
"GuestDetails": [
{
"FirstName": "Torben",
"LastName": "L. Schou",
"Email": "abc@xyz.com",
"UpdateSinglebooking":0, //Optional
"UpdateGuestData": [
{
"Salutation": "Mr.",
"FirstName": "Torben",
"LastName": "L. Schou",
"Gender": "Male",
"Type": "Adult",
"DateOfBirth": "1985-05-05",
"SpouseDateOfBirth": "1987-05-05",
"WeddingAnniversary": "1987-10-05",
"Address": "500 Kingston",
"City": " Toronto",
"State": "Ontario",
"Country": "Canada",
"Nationality": "India",
"Zipcode": "123456",
"Phone": "1234567890",
"Mobile": "1234567890",
"Fax": "1234567890",
"Email": "abc@xyz.com",
"RegistrationNo": "12345",
"IdentityTypeID": "1234500000000000001",
"IdentityNo": "123456789",
"ExpiryDate": "2012-12-02"
}
],
"Documents": [
{
"Type": "1",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
},
{
"Type": "2",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
},
{
"Type": "3",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
},
{
"Type": "4",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
}
]
}
]
}
]
}
}
2.For Multiple Booking Request
{
"RES_Request": {
"Request_Type": "UploadDocument",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxx"
},
"Reservation": [
{
"BookingId": "123",
"GuestDetails": [
{
"FirstName": "Torben",
"LastName": "L. Schou",
"Email": "abc@xyz.com",
"UpdateSinglebooking":1, //Optional
"UpdateGuestData": [
{
"Salutation": "Mr.",
"FirstName": "Torben",
"LastName": "L. Schou",
"Gender": "Male",
"Type": "Adult",
"DateOfBirth": "1994-03-25",
"SpouseDateOfBirth": "1996-05-05",
"WeddingAnniversary": "1997-10-18",
"Address": "500 Kingston",
"City": " Toronto",
"State": "Ontario",
"Country": "Canada",
"Nationality": "India",
"Zipcode": "123456",
"Phone": "1234567890",
"Mobile": "1234567890",
"Fax": "1234567890",
"Email": "abc@xyz.com",
"RegistrationNo": "12345",
"IdentityTypeID": "1234500000000000001",
"IdentityNo": "123456789",
"ExpiryDate": "2021-05-02"
}
],
"Documents": [
{
"Type": "1",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
},
{
"Type": "2",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
}
]
}
]
},
{
"BookingId": "456",
"Guest Details": [
{
"FirstName": "Daryl",
"LastName": "S. Coleman",
"Email": "pqr@xyz.com",
"UpdateSinglebooking":0, //Optional
"UpdateGuestData": [
{
"Salutation": "Mr.",
"FirstName": "Daryl",
"LastName": "S. Coleman",
"Gender": "Male",
"Type": "Adult",
"DateOfBirth": "1998-10-21",
"SpouseDateOfBirth": "2000-07-10",
"WeddingAnniversary": "2001-01-20",
"Address": "500 Kingston",
"City": " Balimo",
"State": "Papua",
"Country": "Indonesia",
"Nationality": "India",
"Zipcode": "123456",
"Phone": "1234567890",
"Mobile": "1234567890",
"Fax": "1234567890",
"Email": "pqr@xyz.com",
"RegistrationNo": "12345",
"IdentityTypeID": "1234500000000000001",
"IdentityNo": "123456789",
"ExpiryDate": "2023-07-12"
}
],
"Documents": [
{
"Type": "1",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
},
{
"Type": "2",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
},
{
"Type": "3",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
},
{
"Type": "4",
"Images": "iVBORw0KGgoAAAANSUhEUgAAACIAAAAiCAIAAAC1JZyVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAAGtJREFUSIlj/P//PwPtARMd7Bi1ZtSaUWtGrRlm1rAwzr5FkgYFNmZjAbYcQyEHOW7idTEyzLpJosugYLeblIs8D5GKyQ+0aeffEa+YfGvOf/xND2se/PpLD2tIAqPWjFozas2oNaPWDFZrAAbVESQbyOtmAAAAAElFTkSuQmCC"
}
]
}
]
}
]
}
}
Response
| Name | Data Type | Description | Example |
| Success->SuccessMsg | String | Success Message | Successfully Done |
| Errors>ErrorCode | integer | Error Code | 100 |
| Errors>ErrorMessage | String | Error Message | Success |
Success
1.Full Operation Is Successfully Completed
{
"Success": {
"SuccessMsg": "Guest Data/Document successfully uploaded for Booking : 123"
},
"Error": {
"ErrorCode": "0",
"ErrorMessage": "Success"
}
}
2.Full Operation Is Successfully Completed For Multiple Booking
{
"Success": {
"SuccessMsg": "Guest Data/Document successfully uploaded for Booking : 123,456"
},
"Error": {
"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 |
| 110 | Booking ID is missing |
| 111 | Guest Identity Image String should be in base64_encoded format, So Document is not uploaded for BookingId : 123, Guest name : Torben L. Schou Guest Signature Image String should be in base64_encoded format, So Document is not uploaded for BookingId : 123, Guest name : Torben L. Schou Guest Image String should be in base64_encoded format, So Document is not uploaded for BookingId : 123, Guest name : Torben L. Schou Guest Voucher Image String should be in base64_encoded format, So Document is not uploaded for BookingId : 123, Guest name : Torben L. Schou |
| 112 | Identity Information (Type, No) is compulsory to process your request |
| 113 | Either First Name/Last Name or Email is mandatory to process your request |
| 115 | The Identity Type ID is not matching with Hotel Data for BookingId : 123, Guest name : Torben L. Schou |
| 116 | Invalid BookingId |
| 117 | Guest Email : abc@xyz.com Not Exist For BookingId : 123, Guest name : Torben L. Schou Guest Name : Torben L. Schou is not exist For BookingId : 123 |
| 118 | Guest Data is not updated For BookingId : 123 |
| 119 | Missing Parameter OR Invalid Parameter : UpdateGuestData For BookingId : 123 Missing Parameter OR Invalid Parameter : GuestDetails For BookingId : 123 |
| 120 | Invalid Date Format. Please enter YYYY-MM-DD For BookingId : 123, Guest name : Torben L. Schou |
| 121 | Invalid Fields : Cities,States For BookingId : 123, Guest name : Torben L. Schou |
| 122 | Country Name is not matched with our given country name for BookingId : 123, Guest name : Torben L. Schou |
| 123 | Nationality Name is not matched with our given country name for BookingId : 123, Guest name : Torben L. Schou |
| 124 | Maximum 5 booking data update for single request |
| 125 | Please Contact to reception for update profile For BookingId : 123 |
| 126 | Invalid Email address For BookingId : 123, Guest name : Torben L. Schou |
| 127 | Given BookingId : 123 is checkout booking Given BookingId : 123 is void booking Given BookingId : 123 is cancelled booking Given BookingId : 123 is no show booking |
| 128 | Guest name : Torben L. Schou AND Customer Email : abc@xyz.com is repeat same profile multiple times For BookingId : 123 |
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
Header
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 |
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
Header
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 |
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
Header
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 |
Bookings
Retrieve Departures
This API provides guest departures information based on departure dates of bookings. The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| Request_Type * | VARCHAR(250) | Use Keyword “DepartureList” | |
| BookingId | INT(11) | Reservation No (It is Optional) | 12345 |
| RoomNo | VARCHAR(500) | Room No (It is Optional) | 101 |
| Guest | VARCHAR(100) | Guest Name (It is Optional) | test |
| IdentityNo | VARCHAR(255) | Identity No (It is Optional) | ASD43543 |
| GuestEmail | VARCHAR(255) | Guest Email (It is Optional) | abc@gmail.com |
| GuestMobileNo | VARCHAR(255) | Guest Mobile No (It is Optional) | XXXXXXXXXX |
| GuestRegistrationNo | VARCHAR(255) | Guest Registration No (It is Optional) | XXXXXX |
| HotelCode * | INT(11) | Unique Hotel code | XXXX |
| AuthCode * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| from_date * | DATE | To send a from date | 2020-06-05 |
| to_date * | DATE | To send a to date | 2020-07-07 |
Request
{
"RES_Request": {
"Request_Type": "DepartureList",
"BookingId": "12345",
"RoomNo": "101",
"Guest": "Joy T. Mnewy",
"IdentityNo": "ASD43543",
"GuestEmail": "XXXXXX@gmail.com",
"GuestMobileNo": "XXXXXXXXXX",
"GuestRegistrationNo": "XXXXXX",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxxxxxxxxxxxxx"
},
"Date": {
"from_date": "2020-10-05",
"to_date": "2020-10-07"
}
}
}
Response
| Name | Data Type | Description | Example |
| LocationId | INT(11) | Hotel code | xxxx |
| UniqueID | VARCHAR(255) | Unique Booking id | 10125, 86436, B4525 etc |
| BookedBy | VARCHAR(255) | Information regarding Booked by | Booking.com etc |
| Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo. | VARCHAR(255) | Here * denotes guest information like Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo. | shown in JSON response below. |
| Source | VARCHAR(1000) | Booking generated source | Booking.com etc |
| PaymentMethod | VARCHAR(255) | Payment Mode selected by guest | Cash, Credit, CityLedger etc |
| IsChannelBooking | INT(1) | Is booking comes from channel [0 or 1] 1 : Booking from the channel. 0: Booking not from the channel. | 0 or 1 |
| BookingTran. SubBookingId | VARCHAR(255) | Sub booking Id | 138 |
| BookingTran. TransactionId | INT(20) | Booking Transaction ID | 123400000000000163 |
| BookingTran. Status | VARCHAR(100) | Booking Status | New or Modify or Cancel. |
| BookingTran. IsConfirmed | INT(1) | Booking Confirmation Flag. [1 or 0] 1 : Confirmed 0 : Not Confirmed | 1 or 0. |
| BookingTran. CurrentStatus | VARCHAR(100) | Booking Current Status | Arrived, Checked Out, Cancel, Void, etc |
| BookingTran. VoucherNo | VARCHAR(255) | Booking Voucher No | 10203049/8512 |
| BookingTran. PackageCode | INT(20) | Package Code | 123400000000000001 |
| BookingTran. PackageName | VARCHAR(1000) | Package Name | European Plan etc |
| BookingTran. RateplanCode | INT(20) | Unique RatePlan Code | 123400000000000006 |
| BookingTran. RateplanName | STRING(1000) | RatePlan Name | Grand Sea View Junior Suite |
| BookingTran. RoomTypeCode | INT(20) | Unique RoomType Code | 123400000000000006 |
| BookingTran. RoomTypeName | STRING(1000) | RoomType Name | Garden View Studio Room |
| BookingTran. Start | DATE | Check-in date[Format : yyyy-mm-dd] | 2020-10-25 |
| BookingTran. End | DATE | Check-out date [Format : yyyy-mm-dd] | 2020-10-27 |
| BookingTran.TotalRate | DECIMAL(19,4) | Rate on room in amount | 1500.43 |
| BookingTran. | DECIMAL(19,4) | Discount on room in | 500 |
| TotalDiscount | Amount | ||
| BookingTran. TotalExtraCharge | DECIMAL(19,4) | Extra charges in amount(if any) | 300 |
| BookingTran. TotalPayment | DECIMAL(19,4) | Payment for room in amount | 2500.54 |
| BookingTran.* | – | Here * denotes guest informations like Salutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo,IdentityType, IdentityNo, ExpiryDate. | |
| BookingTran. TransportationMode | VARCHAR(100) | Mode of transportation | Bus, car etc |
| BookingTran. Vehicle | VARCHAR(255) | Detail of vehicle | |
| BookingTran. PickupDate | DATE | Pickup date[Format : yyyy-mm-dd] | 2020-10-25 etc |
| BookingTran. PickupTime | TIME | Pickup time | |
| BookingTran. Source | VARCHAR(1000) | Booking generated source | Booking.com |
| BookingTran. Comment | VARCHAR(1000) | Additional Information or comment. | |
| BookingTran. AffiliateName | VARCHAR(1000) | Booking Affiliate Name | |
| BookingTran.AffiliateCode | VARCHAR(1000) | Booking Affiliate Code | |
| BookingTran.* | – | Here * denotes Credit Card Informations like CCLink, CCNo, CCType, CardHolderName, CCExpiryDate, | |
| BookingTran.RentalInfo. EffectiveDate | DATETIME | Booking details for particular effective date | 2020-10-25 etc |
| BookingTran.RentalInfo. PackageCode | INT(20) | Package code | 123400000000000001 |
| BookingTran.RentalInfo. PackageName | VARCHAR(100) | Package Name | European Plan |
| BookingTran.RentalInfo. RoomTypeCode | INT(20) | Unique RoomType Code | 123400000000000006 |
| BookingTran.RentalInfo. RoomTypeName | STRING(100) | RoomType Name | Grand Sea View Junior Suite |
| BookingTran.RentalInfo. RoomName | VARCHAR(100) | Room Name/Number | 102 |
| BookingTran.RentalInfo.Adult | INT(11) | No. of Adults | 2,3,4 etc |
| BookingTran. RentalInfo.Child | INT(11) | No. of Childs | 2,3,4 etc |
| BookingTran. RentalInfo.Rent | DECIMAL(19,4) | Room rental amount | 1500.43 |
| BookingTran. RentalInfo.Discount | DECIMAL(19,4) | Discount on rental room in amount | 500 |
| BookingTran.Sharer.* | – | Here * denotes Sharer informations like Salutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Nationality,Zip Code, Phone, Mobile, Fax, Email,RegistrationNo,IdentityTypeID, IdentityNo, ExpiryDate. | |
| Errors.ErrorCode | – | Response Error Code | 104, 404 etc |
| Errors.ErrorMessage | – | Generate Response Message | Unauthorized Request. etc |
Success
{
"Reservations": {
"Reservation": [
{
"BookingTran": [
{
"SubBookingId": "RES2233",
"TransactionId": "123400000000003264",
"Createdatetime": "2020-10-24 17:57:47",
"Modifydatetime": "2020-10-24 17:57:47",
"Status": "New",
"currentstatus": "Checked Out",
"IsConfirmed": "1",
"CurrentStatus": "Arrived",
"VoucherNo": "",
"PackageCode": "123400000000000003",
"PackageName": "Non Refundable",
"RateplanCode": "123400000000000010",
"RateplanName": "Seaview Deluxe RoomOnly",
"RoomTypeCode": "123400000000000004",
"RoomTypeName": "t1",
"Start": "2020-10-03",
"End": "2020-10-05",
"ArrivalTime": "17:48:00",
"DepartureTime": "17:48:00",
"CurrencyCode": "RS",
"TotalAmountAfterTax": "6939.97",
"TotalAmountBeforeTax": "5881.33",
"TotalTax": "1058.64",
"TotalDiscount": "0.00",
"TotalExtraCharge": "50.85",
"TotalPayment": "0.00",
"TACommision": "0.00",
"Salutation": "Miss.",
"FirstName": "Jia",
"LastName": "",
"Gender": "Male",
"DateOfBirth": "2020-10-01",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": "",
"State": "",
"Country": "Romania",
"Nationality": "India",
"Zipcode": "",
"Phone": "",
"Mobile": "",
"Fax": "",
"Email": "",
“RegistrationNo” : "",
"IdentiyType": "Master ID Card",
"IdentityNo": "43545",
"ExpiryDate": "",
"TransportationMode": "",
"Vehicle": "",
"PickupDate": "",
"PickupTime": "",
"Source": "WEB",
"Comment": "",
"AffiliateName": "",
"AffiliateCode": "",
"CCLink": "",
"CCNo": "",
"CCType": "",
"CCExpiryDate": "",
"CardHoldersName": "",
"TaxDeatil": [
{
"TaxCode": "CGST New",
"TaxName": "CGST New",
"TaxAmount": "263.9000"
},
{
"TaxCode": "CGST New",
"TaxName": "CGST New",
"TaxAmount": "265.4200"
},
{
"TaxCode": "SGST New",
"TaxName": "SGST New",
"TaxAmount": "263.9000"
},
{
"TaxCode": "SGST New",
"TaxName": "SGST New",
"TaxAmount": "265.4200"
}
],
"ExtraCharge": [
{
"ChargeDate": "2020-10-03",
"ChargeCode": "Laundry",
"ChargeName": "Laundry",
"ChargeDesc": "Laundry",
"Remark": "Laundry",
"Quantity": "0",
"AmountBeforeTax": "16.95",
"AmountAfterTax": "20.01"
},
{
"ChargeDate": "2020-10-04",
"ChargeCode": "Laundry",
"ChargeName": "Laundry",
"ChargeDesc": "Laundry",
"Remark": "Laundry",
"Quantity": "0",
"AmountBeforeTax": "16.95",
"AmountAfterTax": "20.01"
},
{
"ChargeDate": "2020-10-05",
"ChargeCode": "Laundry",
"ChargeName": "Laundry",
"ChargeDesc": "Laundry",
"Remark": "Laundry",
"Quantity": "0",
"AmountBeforeTax": "16.95",
"AmountAfterTax": "20.01"
}
],
"RentalInfo": [
{
"EffectiveDate": "2020-10-03",
"PackageCode": "123400000000000003",
"PackageName": "Non Refundable",
"RoomTypeCode": "123400000000000004",
"RoomTypeName": "t1",
"RoomName": "102",
"Adult": "5",
"Child": "1",
"RentPreTax": "2932.19",
"Rent": "3459.99",
"Discount": "0.00"
},
{
"EffectiveDate": "2020-10-04",
"PackageCode": "123400000000000003",
"PackageName": "Non Refundable",
"RoomTypeCode": "123400000000000004",
"RoomTypeName": "t1",
"RoomName": "102",
"Adult": "5",
"Child": "1",
"RentPreTax": "2949.14",
"Rent": "3479.98",
"Discount": "0.00"
}
],
"Sharer": [
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"RegistrationNo" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
},
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"Registration No" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
}
]
}
],
"LocationId": "27",
"UniqueID": "RES2233",
"BookedBy": "John",
"Salutation": "Mr.",
"FirstName": "John",
"LastName": "",
"Gender": "Male",
"Address": "",
"City": "",
"State": "",
"Country": "Romania",
"Zipcode": "",
"Phone": "",
"Mobile": "",
"Fax": "",
"Email": "",
"Source": "WEB",
"PaymentMethod": "Abc",
"IsChannelBooking": "1"
},
]
}
}
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 |
| 303 | No Data Found. |
| 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. |
| 503 | No Data Found. |
Bookings
Retrieve Arrivals
This API provides guest arrival information based on arrival dates of bookings. The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| Request_Type * | VARCHAR(250) | Use Keyword “ArrivalList” | |
| BookingId | INT(11) | Reservation No (It is Optional) | 12345 |
| RoomNo | VARCHAR(500) | Room No (It is Optional) | 101 |
| Guest | VARCHAR(100) | Guest Name (It is Optional) | test |
| IdentityNo | VARCHAR(255) | Identity No (It is Optional) | ASD43543 |
| GuestEmail | VARCHAR(255) | Guest Email (It is Optional) | abc@gmail.com |
| GuestMobileNo | VARCHAR(255) | Guest Mobile No (It is Optional) | XXXXXXXXXX |
| GuestRegistrationNo | VARCHAR(255) | Guest Registration No (It is Optional) | XXXXXX |
| HotelCode * | INT(11) | Unique Hotel code | XXXX |
| AuthCode * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| from_date * | DATE | To send a from date | 2020-06-05 |
| to_date * | DATE | To send a to date | 2020-07-07 |
Request
{
"RES_Request": {
"Request_Type": "ArrivalList",
"BookingId": "12345",
"RoomNo": "101",
"Guest": "Joy T. Mnewy",
"IdentityNo": "ASD43543",
"GuestEmail": "XXXXXX@gmail.com",
"GuestMobileNo": "XXXXXXXXXX",
"GuestRegistrationNo": "XXXXXX",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxxxxxxxxxxxxx"
},
"Date": {
"from_date": "2020-04-05",
"to_date": "2020-04-07"
}
}
}
Response
| Name | Data Type | Description | Example |
| LocationId | INT(11) | Hotel code | xxxx |
| UniqueID | VARCHAR(255) | Unique Booking id | 10125, 86436, B4525 etc |
| BookedBy | VARCHAR(255) | Information regarding Booked by | Booking.com etc |
| Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo. | VARCHAR(255) | Here * denotes guest information like Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo. | shown in JSON response below. |
| Source | VARCHAR(1000) | Booking generated source | Booking.com etc |
| PaymentMethod | VARCHAR(255) | Payment Mode selected by guest | Cash, Credit, CityLedger etc |
| IsChannelBooking | INT(1) | Is booking comes from channel [0 or 1] 1 : Booking from the channel. 0: Booking not from the channel. | 0 or 1 |
| BookingTran. SubBookingId | VARCHAR(255) | Sub booking Id | 138 |
| BookingTran. TransactionId | INT(20) | Booking Transaction ID | 123400000000000163 |
| BookingTran. Status | VARCHAR(100) | Booking Status | New or Modify or Cancel. |
| BookingTran.IsConfirmed | INT(1) | Booking Confirmation Flag. [1 or 0] 1 : Confirmed 0 : Not Confirmed | 1 or 0. |
| BookingTran. CurrentStatus | VARCHAR(100) | Booking Current Status | Arrived, Checked Out, Cancel, Void, etc |
| BookingTran. VoucherNo | VARCHAR(255) | Booking Voucher No | 10203049/8512 |
| BookingTran. PackageCode | INT(20) | Package Code | 123400000000000001 |
| BookingTran. PackageName | VARCHAR(1000) | Package Name | European Plan etc |
| BookingTran. RateplanCode | INT(20) | Unique RatePlan Code | 123400000000000006 |
| BookingTran. RateplanName | STRING(1000) | RatePlan Name | Grand Sea View Junior Suite |
| BookingTran. RoomTypeCode | INT(20) | Unique RoomType Code | 123400000000000006 |
| BookingTran. RoomTypeName | STRING(1000) | RoomType Name | Garden View Studio Room |
| BookingTran. Start | DATE | Check-in date[Format : yyyy-mm-dd] | 2020-10-25 |
| BookingTran. End | DATE | Check-out date [Format : yyyy-mm-dd] | 2020-10-27 |
| BookingTran.TotalRate | DECIMAL(19,4) | Rate on room in amount | 1500.43 |
| BookingTran. | DECIMAL(19,4) | Discount on room in | 500 |
| TotalDiscount | Amount | ||
| BookingTran. TotalExtraCharge | DECIMAL(19,4) | Extra charges in amount(if any) | 300 |
| BookingTran. TotalPayment | DECIMAL(19,4) | Payment for room in amount | 2500.54 |
| BookingTran.* | – | Here * denotes guest informations like Salutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo,IdentityType, IdentityNo, ExpiryDate. | |
| BookingTran. TransportationMode | VARCHAR(100) | Mode of transportation | Bus, car etc |
| BookingTran. Vehicle | VARCHAR(255) | Detail of vehicle | |
| BookingTran. PickupDate | DATE | Pickup date[Format : yyyy-mm-dd] | 2020-10-25 etc |
| BookingTran. PickupTime | TIME | Pickup time | |
| BookingTran. Source | VARCHAR(1000) | Booking generated source | Booking.com |
| BookingTran. Comment | VARCHAR(1000) | Additional Information or comment. | |
| BookingTran. AffiliateName | VARCHAR(1000) | Booking Affiliate Name | |
| BookingTran.AffiliateCode | VARCHAR(1000) | Booking Affiliate Code | |
| BookingTran.* | – | Here * denotes Credit Card Informations like CCLink, CCNo, CCType,CardHolderName, CCExpiryDate, | |
| BookingTran.RentalInfo.EffectiveDate | DATETIME | Booking details for particular effective date | 2020-10-25 etc |
| BookingTran.RentalInfo.PackageCode | INT(20) | Package code | 123400000000000001 |
| BookingTran.RentalInfo.PackageName | VARCHAR(100) | Package Name | European Plan |
| BookingTran.RentalInfo. RoomTypeCode | INT(20) | Unique RoomType Code | 123400000000000006 |
| BookingTran.RentalInfo. RoomTypeName | STRING(100) | RoomType Name | Grand Sea View Junior Suite |
| BookingTran.RentalInfo.Adult | INT(11) | No. of Adults | 2,3,4 etc |
| BookingTran. RentalInfo.Child | INT(11) | No. of Childs | 2,3,4 etc |
| BookingTran. RentalInfo.Rent | DECIMAL(19,4) | Room rental amount | 1500.43 |
| BookingTran. RentalInfo.Discount | DECIMAL(19,4) | Discount on rental room in amount | 500 |
| BookingTran.Sharer.* | – | Here * denotes Sharer informations like Salutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Nationality,Zip Code, Phone, Mobile, Fax, Email,RegistrationNo,IdentityTypeID, IdentityNo, ExpiryDate. | |
| Errors.ErrorCode | – | Response Error Code | 104, 404 etc |
| Errors.ErrorMessage | – | Generate Response Message | Unauthorized Request. etc |
Success
{
"Reservations": {
"Reservation": [
{
"BookingTran": [
{
"SubBookingId": "RES2370",
"TransactionId": "123400000000003428",
"Createdatetime": "2020-01-21 12:10:58",
"Modifydatetime": "2020-01-21 12:10:58",
"Status": "New",
"IsConfirmed": "1",
"CurrentStatus": "Arrived",
"VoucherNo": "",
"PackageCode": "123400000000000012",
"PackageName": "GV",
"RateplanCode": "123400000000000051",
"RateplanName": "Govt GV",
"RoomTypeCode": "123400000000000035",
"RoomTypeName": "Govt",
"Start": "2020-04-07",
"End": "2020-04-08",
"ArrivalTime": "12:10:00",
"DepartureTime": "12:10:00",
"CurrencyCode": "RS",
"TotalAmountAfterTax": "1356.00",
"TotalAmountBeforeTax": "1200.00",
"TotalTax": "156.00",
"TotalDiscount": "0.00",
"TotalExtraCharge": "0.00",
"TotalPayment": "580.00",
"TACommision": "0.00",
"Salutation": "Dr.",
"FirstName": "Maxwel",
"LastName": "Phil",
"Gender": "Male",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": "",
"State": "",
"Country": "Romania",
"Nationality": "India",
"Zipcode": "",
"Phone": "",
"Mobile": "",
"Fax": "",
"Email": "",
“RegistrationNo” : "",
"IdentiyType": "",
"IdentityNo": "",
"ExpiryDate": "",
"TransportationMode": "",
"Vehicle": "",
"PickupDate": "",
"PickupTime": "",
"Source": "WEB",
"Comment": "",
"AffiliateName": "",
"AffiliateCode": "",
"CCLink": "",
"CCNo": "",
"CCType": "",
"CCExpiryDate": "",
"CardHoldersName": "",
"TaxDeatil": [
{
"TaxCode": "PDV 13%",
"TaxName": "PDV 13%",
"TaxAmount": "156.0000"
}
],
"RentalInfo": [
{
"EffectiveDate": "2020-10-07",
"PackageCode": "123400000000000012",
"PackageName": "GV",
"RoomTypeCode": "123400000000000035",
"RoomTypeName": "Govt",
"RoomName": "102",
"Adult": "2",
"Child": "0",
"RentPreTax": "1200.00",
"Rent": "1356.00",
"Discount": "0.00"
}
],
"Sharer": [
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"RegistrationNo" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
},
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"Registration No" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
}
]
}
],
"LocationId": "27",
"UniqueID": "RES2370",
"BookedBy": "Joy Chistian",
"Salutation": "Dr.",
"FirstName": "Joy",
"LastName": "Chistian",
"Gender": "Male",
"Address": "AB-12, Street-2",
"City": "",
"State": "",
"Country": "Romania",
"Zipcode": "",
"Phone": "",
"Mobile": "",
"Fax": "",
"Email": "",
"Source": "WEB",
"PaymentMethod": "GreenTop2",
"IsChannelBooking": "1"
},
]
}
}
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 |
| 303 | No Data Found. |
| 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. |
| 503 | No Data Found. |
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
Header
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 |