This API helps to update housekeeping information on an inhouse room. This 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 |
| 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. "}