Workflow: Retrieving Rooms with Current Housekeeping Status

When you only need the current room status or guest service status for a room at a specific time, use the API operation getHousekeepingOverview. This operation retrieves a list of rooms showing the current housekeeping service status, the guest service status, and additional housekeeping details for the rooms.

Sequence Diagram

Description of Steps

Description

Operation

Use the API operation getHousekeepingOverview to retrieve all details of a room for housekeeping purposes. This includes information about the roomType, housekeeping Room Status (Inspected, Clean, or Dirty), the Front Office Status (room is vacant, occupied, and so on), and the corresponding Housekeeping status. With this operation, you can also retrieve only rooms with a specific Room Status. For example, GET {{HostName}}/hsk/v1/hotels/{{HotelId}}/housekeepingOverview?housekeepingRoomStatus=Dirty or specific Guest Service Status. For example, GET {{HostName}}/hsk/v1/hotels/{{HotelId}}/housekeepingOverview?serviceRequestStatus=MakeUpRoom

Get Housekeeping Overview GET {{HostName}}/hsk/v1/hotels/{{HotelId}}/housekeepingOverview 200 Response: { "housekeepingRoomInfo": { "housekeepingRooms": { "room": [ { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "001", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "002", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "01", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "02", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "1", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "100", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "OutOfOrder", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "101", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 }, "guestServiceRequest": "MakeUpRoom" } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "102", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 }, "guestServiceRequest": "MakeUpRoom" } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "103", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Clean", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 }, "guestServiceRequest": "DoNotDisturb" } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "104", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived", "Departed" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 }, "guestServiceRequest": "DoNotDisturb" } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "105", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "106", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "107", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "108", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 }, "guestServiceRequest": "DoNotDisturb" } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "109", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "110", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrived" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Occupied", "housekeepingStatus": "Occupied" }, "roomPersons": { "frontOfficePersons": 1, "houseKeepingPersons": 1 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "111", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "112", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "113", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "houseKeeping": false, "roomType": "CLASSIC" }, "roomId": "114", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Inspected", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 } } } ], "hotelId": "MBOESEL" }, "totalPages": 3, "offset": 20, "limit": 20, "hasMore": true, "totalResults": 42 }, "links": [] }