get HouseKeeping Tasks

GET {{HostName}}/hsk/v1/hotels/{{HotelId}}/houseKeepingtasks?includeTaskSheetDetails=true&generateCleaningSequence=false&attendantInRoomOnly=false&housekeepingRoomStatus=Clean&housekeepingRoomStatus=Inspected&housekeepingRoomStatus=OutOfService&housekeepingRoomStatus=OutOfOrder&housekeepingRoomStatus=Dirty&housekeepingRoomStatus=Pickup&includeTaskSheetsSummary=true&taskDate=2016-07-10&sortByCleaningSequence=false&taskSheetNumber=1&taskCodesBreakOutIdType=TaskCodesBreakOutId&roomStatusToChange=OutOfOrder&roomStatusToChange=OutOfService&roomStatusToChange=Clean&roomStatusToChange=Pickup&roomStatusToChange=Dirty&roomStatusToChange=Inspected&includeReservationInfo=true

Request Params

KeyDatatypeRequiredDescription
includeTaskSheetDetailsbooleanThis will include room details for the Task Sheets. If summary information is only required, then this could be set to false. If a Task Sheet Number is included in the Search and this flag is set to true, then the details for that particular Task Sheet will be returned. For all other task sheets, the IncludeTaskSheetsSummary will determine if Summary details are required or not.
generateCleaningSequencebooleanSetting this to true will generate a sequence based on the current condition of the room for cleaning. This sequence would be the same sequence with which the Task Companion works.
attendantInRoomOnlybooleanQuery only rooms with attendant working in them.
housekeepingRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
housekeepingRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
housekeepingRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
housekeepingRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
housekeepingRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
housekeepingRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
includeTaskSheetsSummarybooleanSetting this to true, will return Summary information for the task sheets required. If a Task Sheet Number is included in the Search and IncludeTaskSheetDetails is set to false and IncludeTaskSheetsSummary is false, then only the Summary information for that particular task sheet will be returned. IncludeTaskSheetDetails = True, IncludeTaskSheetsSummary = True : includes all task sheets details and summary IncludeTaskSheetDetails = false, IncludeTaskSheetsSummary = True : includes only summary IncludeTaskSheetDetails = false, IncludeTaskSheetsSummary = false, Task Sheet No =null : no task sheet detail or summary for any of the tasksheets. Returns the Task Assignnment header. IncludeTaskSheetDetails = True, IncludeTaskSheetsSummary = True, Task Sheet No = XX : includes task sheets detail for XX and summary for others. IncludeTaskSheetDetails = false, IncludeTaskSheetsSummary = True, Task Sheet No = XX : includes summary for all including XX. IncludeTaskSheetDetails = false, IncludeTaskSheetsSummary = false, Task Sheet No = XX : includes summary for XX. No information for others.
taskDatestringDate for which the Task Assignment information is required.
sortByCleaningSequencebooleanThe rooms in the task sheet would be sorted with the cleaning sequence. The normal sort would be done based on the Default Sequence.
taskCodesBreakOutIdnumberA unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
taskSheetNumbernumberSpecific Task Sheet number for which the information is required.
taskCodesBreakOutIdTypestringA reference to the type of object defined by the UniqueID element.
roomStatusToChangestringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusToChangestringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusToChangestringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusToChangestringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusToChangestringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusToChangestringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
includeReservationInfobooleanSetting this to true will include reservation information associated to the room.
templateCodenull

HEADERS

KeyDatatypeRequiredDescription
x-hotelidstring
x-app-keystring