Retrieve Inhouse Room Status

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

Content-Type: application/json

Parameter

NameData TypeDescriptionExample
HotelCode *INT(11)Unique Hotel code XXXX
AuthCode *VARCHAR(300)Unique Authentication code XXXXXXXXXXXXXXXXX

Request 

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

Response

NameData TypeDescriptionExample
roomlist.hotelcodeIntegerHotel unique codexxxx
roomlist.roomidIntegerID of Room123450000000000001
roomlist.unitidIntegerUnit ID123450000000000001
roomlist.roomnameStringName Of Room101
roomlist.roomtypeidIntegerRoomType ID123450000000000004
roomlist.roomtypenameStringName of RoomTypeDelux
roomlist.isblockedStringIs BlockedNo
roomlist.hkstatusStringHousekeeping StatusClean
roomlist.hkremarksStringHousekeeping Remarkscleaned
roomlist.roomstatusStringStatus of RoomAvailable
checkinguestlist.hotel_codeIntegerHotel unique codexxxx
checkinguestlist.reservationnoIntegerReservation Number10
checkinguestlist.guestnameStringName of GuestJohn Lenth
checkinguestlist.emailStringEmail of Guestjohnl123@example.com
checkinguestlist.addressStringAddress of Guest123, abc building, USA
checkinguestlist.roomStringRoom Name101
checkinguestlist.roomtypeStringRoom TypeDelux
checkinguestlist.ratetypeStringRate typeFrequent Traveler
checkinguestlist.bookingdateDatetimeDate of Booking2020-04-11 16:44:47
checkinguestlist.checkindateDatetimeDate of CheckIn2020-04-17 15:44:47
checkinguestlist.checkoutdateDatetimeDate of CheckOut2020-04-20 19:44:47
checkinguestlist.businesssourceIntegerBusiness source unique id123450000000000001
checkinguestlist.marketIntegerMarket unique id123450000000000001
checkinguestlist.travelagentIntegerTravel Agent id123450000000000001
checkinguestlist.companyStringName of CompanyPing Man
checkinguestlist.tavouchernoIntegerTravel agent Voucher number1
checkinguestlist.AdultIntegerNumber of adult2
checkinguestlist.ChildIntegerNumber of child1
checkinguestlist.housekeepingremarks StayoverStringHousekeeping remarksCleaned
checkinguestlist.bookingstatusStringStatus 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.

Click here to Register