Housekeeping

End Point URL

Header

Parameter

Name	Data Type	Description	Example
HotelCode *	INT(11)	Unique Hotel code	XXXX
AuthCode *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
RoomID *	INT(20)	ID of Room	123450000000000004
RoomtypeID *	INT(20)	ID of RoomType	123450000000000006
FromDate *	Date	From date. [Format: yyyy-mm-dd]	2020-05-15
ToDate *	Date	To date. [Format: yyyy-mm-dd]	2020-05-16

Request 

{
"RES_Request": {
"Request_Type": "UnblockRoom",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxx"
},
"Rooms": [
{
"RoomID": "123450000000000004",
"RoomtypeID":"123450000000000006",
"FromDate": "2020-05-15",
"ToDate": "2020-05-16"
},
{
"RoomID": "123450000000000004",
"RoomtypeID": "123450000000000007",
"FromDate": "2020-05-19",
"ToDate": "2020-05-22"
}
]}
}

Response

Name	Data Type	Description	Example
Success.SuccessMsg	–	Generate Success Response Message	Rooms Unblocked Successfully
Errors.ErrorCode	–	Response Error Code	0, 301 etc
Errors.ErrorMessage	–	Generate Response Message	Unauthorized Request. Please check hotel code and authentication code

Success

{
"Errors": {
"ErrorCode": "0",
"ErrorMessage": "Success"
},
"Success": {
"SuccessMsg": "Rooms Unblocked Successfully"
}
}

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
103	Room ID is missing
104	Roomtype ID is missing
105	From Date is missing.
106	From Date is not a valid date
107	To Date 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	(To Date) – To Date is not a valid date
109	From Date (From Date) To Date : (To Date) – Please check From and To date. To Date should be greater than fromdate
110	Unblock is not allowed for past dates. Your property current working date is (Hoteldate)
128	(Room ID) – There is no block on this room, so unblock is not possible.

End Point URL

Header

Parameter

Name	Data Type	Description	Example
HotelCode *	INT(11)	Unique Hotel code	XXXX
AuthCode *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
RoomID *	INT(20)	ID of Room	123450000000000001
RoomtypeID *	INT(20)	ID of RoomType	123450000000000001
FromDate *	Date	From date. [Format: yyyy-mm-dd]	2020-07-12
ToDate *	Date	To date. [Format: yyyy-mm-dd]	2020-07-13
Reason	VARCHAR(300)	Reason for out of order.	Block Room, Maintenance, etc

Request 

{
"RES_Request": {
"Request_Type": "SetoutofOrder",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "xxxxxxxxxxxx"
},
"Rooms": [
{
"RoomID": "123450000000000004",
"RoomtypeID":"123450000000000006",
"FromDate": "2020-05-15",
"ToDate": "2020-05-16",
"Reason": "Block Room"
}
]}
}

Response

Name	Data Type	Description	Example
Success.SuccessMsg	–	Generate Success Response Message	Rooms Blocked Successfully
Errors.ErrorCode	–	Response Error Code	0, 301 etc
Errors.ErrorMessage	–	Generate Response Message	Unauthorized Request. Please check hotel code and authentication code

Success

{
"Errors": {
"ErrorCode": "0",
"ErrorMessage": "Success"
},
"Success": {
"SuccessMsg": "Rooms Blocked Successfully"
}
}

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
103	Room ID is missing
104	Roomtype ID is missing
105	From Date is missing.
106	From Date is not a valid date
107	To Date 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
115	Reason is missing
108	(To Date) – To Date is not a valid date
109	From Date (From Date) To Date : (To Date) – Please check From and To date. To Date should be greater than fromdate
110	From Date is not a valid date, FromDate should be greater than HotelDate
128	Room/s cannot be blocked for selected dates

End Point URL

Header

Parameter

Name	Data Type	Description	Example
HotelCode *	INT(11)	Unique Hotel code	XXXX
AuthCode *	VARCHAR(300)	Unique Authentication code	XXXXXXXXXXXXXXXXX
roomid *	BIGINT(20)	ID of Room	123450000000000001
unitid *	BIGINT(20)	Unit ID	123450000000000001
hkstatus *	VARCHAR(300)	Housekeeping Status	Clean
hkremarks	VARCHAR(300)	Housekeeping Remarks	Cleaned

Request 

 {
"authcode":"xxxxxxxxxxxx",
"hotel_code":"xxxx",
 "updatehkdata": [{
      "hotel_code": "xxxx",
       "roomid": "123450000000000001", 
       "unitid": "1213450000000000001", 
       "hkstatus": "Clean",
       "hkremarks": ""
      },{
       "hotel_code": "xxxx",
       "roomid": "123450000000000002", 
       "unitid": "123450000000000003", 
       "hkstatus": "Dirty",
       "hkremarks": ""
 }]
}

Response

Name	Data Type	Description	Example
status	String	Update status	1
message	String	Message	Success
warning	Integer	Warning	This request will not be process as hotel_code is invalid.

Success

{
    "status": "0",
    "message": "Success"
}

Error Codes

Property Deactivated: {"errorcode":"1","message":"This property has been deactivated."}
OpenAPI Record invalid: {"errorcode":"1","message":" Unauthorized Request. Please check hotel code and authentication code "}
OpenAPI Deactivated: {"errorcode":"1","message":" Auth Code is inactive. "}
OpenAPI Request: {"errorcode":"1","message":"Property is not authorized to access this api. "}

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.