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