This API provides housekeeping information of todays vacant and occupied rooms and also provides check in guest information. 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
{ "authcode": "xxxxxxxxxxxx", "hotel_code":"xxxx" }
Response
Name | Data Type | Description | Example |
roomlist.hotelcode | Integer | Hotel unique code | xxxx |
roomlist.roomid | Integer | ID of Room | 123450000000000001 |
roomlist.unitid | Integer | Unit ID | 123450000000000001 |
roomlist.roomname | String | Name Of Room | 101 |
roomlist.roomtypeid | Integer | RoomType ID | 123450000000000004 |
roomlist.roomtypename | String | Name of RoomType | Delux |
roomlist.isblocked | String | Is Blocked | No |
roomlist.hkstatus | String | Housekeeping Status | Clean |
roomlist.hkremarks | String | Housekeeping Remarks | cleaned |
roomlist.roomstatus | String | Status of Room | Available |
checkinguestlist.hotel_code | Integer | Hotel unique code | xxxx |
checkinguestlist.reservationno | Integer | Reservation Number | 10 |
checkinguestlist.guestname | String | Name of Guest | John Lenth |
checkinguestlist.email | String | Email of Guest | johnl123@example.com |
checkinguestlist.address | String | Address of Guest | 123, abc building, USA |
checkinguestlist.room | String | Room Name | 101 |
checkinguestlist.roomtype | String | Room Type | Delux |
checkinguestlist.ratetype | String | Rate type | Frequent Traveler |
checkinguestlist.bookingdate | Datetime | Date of Booking | 2020-04-11 16:44:47 |
checkinguestlist.checkindate | Datetime | Date of CheckIn | 2020-04-17 15:44:47 |
checkinguestlist.checkoutdate | Datetime | Date of CheckOut | 2020-04-20 19:44:47 |
checkinguestlist.businesssource | Integer | Business source unique id | 123450000000000001 |
checkinguestlist.market | Integer | Market unique id | 123450000000000001 |
checkinguestlist.travelagent | Integer | Travel Agent id | 123450000000000001 |
checkinguestlist.company | String | Name of Company | Ping Man |
checkinguestlist.tavoucherno | Integer | Travel agent Voucher number | 1 |
checkinguestlist.Adult | Integer | Number of adult | 2 |
checkinguestlist.Child | Integer | Number of child | 1 |
checkinguestlist.housekeepingremarks Stayover | String | Housekeeping remarks | Cleaned |
checkinguestlist.bookingstatus | String | Status of booking such as Arrival,Check Out, Due Out,Confirmed Reservation, Void,Cancel,No Show, Maintenance Block,Unconfirmed Reservation,Stayover, Unblock,Dayuse Reservation,Dayuse | Stayover |
Success
{ "roomlist": [ { "hotel_code": "xxxx", "roomid": "123450000000000001", "unitid": "123450000000000001", "roomname": "101", "roomtypeid": "123450000000000004", "roomtypename": "Delux", "isblocked": "No", "hkstatus": "Dirty", "hkremarks": "", "roomstatus": "Available" }, { "hotel_code": "xxxx", "roomid": "123450000000000002", "unitid": "123450000000000002", "roomname": "102", "roomtypeid": "123450000000000004", "roomtypename": "Delux", "isblocked": "No", "hkstatus": "", "hkremarks": "", "roomstatus": "Available" } ], "checkinguestlist": [ { "hotel_code": "xxxx", "reservationno": "8", "guestname": "Mr. John Lenth", "email": "johnl123@example.com", "address": "123, abc building, USA", "room": "103", "roomtype": "Twin", "ratetype": "Frequent Traveller", "bookingdate": "2020-04-11 16:44:47", "checkindate": "2020-03-17 13:37:16", "checkoutdate": "2020-03-20 17:42:00", "businesssource": "", "market": "", "travelagent": "", "company": "", "tavoucherno": "", "Adult": "2", "Child": "1", "housekeepingremarks": "", "bookingstatus": "Stayover" } ] }
Error Codes
Property Deactivated: This property has been deactivated OpenAPI Record invalid: Unauthorized Request. Please check hotel code and authentication code OpenAPI Deactivated: Auth Code is inactive. OpenAPI Request: Property is not authorized to access this api.