How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Hospitality Housekeeping API

These APIs allows for retrieving and managing a room's housekeeping data and front office status, for example update room 101 to be Out Of Order. Additionally, you can view room discrepancies between housekeeping and front office statuses, view and update task sheets and create a room service request.

Oracle Hospitality Housekeeping API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Housekeeping. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 60 operations across 45 paths, and defines 263 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.

Requests are made against a single base URL, /hsk/v1.

60 operations 45 paths 263 schemas 8 DELETE14 GET9 POST29 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.2.0.0
Server
/hsk/v1
License
Terms of Service
Resource Areas
1

Paths & Operations 60

Across 45 paths, the API surfaces 60 operations — 8 DELETE, 14 GET, 9 POST, 29 PUT. Each is listed below with its method, path, parameters, and response codes.

Housekeeping 60

These APIs allows for retrieving and managing a room's housekeeping data and front office status, for example update room 101 to be Out Of Order. Additionally, you can view room d…

GET
/hotels/{hotelId}/attendants/houseKeepingTasks
Get the housekeeping attendants schedule
getHousekeepingAttendantsSchedule 11 params → 200204400401403404405406
DELETE
/hotels/{hotelId}/attendants/houseKeepingTasks
Delete housekeeping attendant schedule
deleteHousekeepingAttendantSchedule 11 params → 200400401403404405406413
POST
/hotels/{hotelId}/autoTaskSheets
Auto generate the task sheets
autoGenerateTaskSheets 9 params body → 201400401403404405406413
GET
/hotels/{hotelId}/conditions
Get rooms condition
getRoomConditions 27 params → 200204400401403404405406
PUT
/hotels/{hotelId}/conditions
Set rooms condition
setRoomCondition 9 params body → 200400401403404405406413
GET
/hotels/{hotelId}/forecastTaskSchedules
Get facility forecast
getFacilityForecast 15 params → 200204400401403404405406
DELETE
/hotels/{hotelId}/houseKeepingTasks/{taskCodesBreakOutId}
Delete all the hotel task sheets for an existing Task Sheet Set.
deleteHouseKeepingTaskSheets 10 params → 200400401403404405406413
GET
/hotels/{hotelId}/houseKeepingtasks
Get the existing task sheets
getHouseKeepingTasks 34 params → 200204400401403404405406
GET
/hotels/{hotelId}/housekeepingDiscrepancies
Get hotel housekeeping discrepant rooms
getHousekeepingDiscrepancies 17 params → 200204400401403404405406
GET
/hotels/{hotelId}/housekeepingOverview
Get housekeeping rooms overview
getHousekeepingOverview 34 params → 200204400401403404405406
DELETE
/hotels/{hotelId}/maintenances/{mainteananceId}
Delete the maintenances for rooms
deleteRoomMaintenance 10 params → 200400401403404405406413
PUT
/hotels/{hotelId}/maintenances/{mainteananceId}/resolve
Resolve maintenances for rooms
resolveRoomMaintenance 10 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/maintenances/{mainteananceId}/unResolve
unResolve the maintenances for rooms
unResolveRoomMaintenance 10 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/moveTaskRooms
Move the task rooms
moveTaskRooms 9 params body → 200400401403404405406413
GET
/hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes
Get the guest housekeeping instructions
getGuestHousekeepingNotes 14 params → 200204400401403404405406
PUT
/hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes
Set guest housekeeping instructions
setGuestHousekeepingNotes 10 params body → 200400401403404405406413
GET
/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules
Get reservation housekeeping schedule
getReservationHousekeepingSchedule 15 params → 200204400401403404405406
POST
/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules
Create reservation housekeeping tasks
postReservationHousekeepingTasks 10 params body → 201400401403404405406413
PUT
/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules
Update reservation housekeeping tasks
editReservationHousekeepingTasks 10 params body → 200400401403404405406413
DELETE
/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules
Delete reservation housekeeping task
deleteReservationHousekeepingTasks 28 params → 200400401403404405406413
PUT
/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/reset
Reset reservation housekeeping schedule
resetReservationHousekeepingSchedule 10 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/shift
Shift reservation housekeeping schedule
shiftReservationHousekeepingSchedule 10 params body → 200400401403404405406413
DELETE
/hotels/{hotelId}/rooms/cleaningPriority
Delete room cleaning priority
putRoomCleaningPriority 10 params → 200400401403404405406413
POST
/hotels/{hotelId}/rooms/maintenanceCodes/{maintenanceCode}
Create maintenances for rooms
postRoomMaintenance 10 params body → 201400401403404405406413
GET
/hotels/{hotelId}/rooms/maintenances
Get the maintenance rooms
getRoomMaintenance 26 params → 200204400401403404405406
GET
/hotels/{hotelId}/rooms/outOfOrderRooms
Get Out of Order Rooms
getOutOfOrderRooms 14 params → 200204400401403404405406
PUT
/hotels/{hotelId}/rooms/outOfOrderRooms
Complete rooms Out Of Order
completeOutOfOrderRooms 9 params body → 200400401403404405406413
POST
/hotels/{hotelId}/rooms/outOfOrderRooms
Set multiple rooms to Out Of Order
postOutOfOrderRooms 9 params body → 201400401403404405406413
PUT
/hotels/{hotelId}/rooms/outOfServiceRooms
Complete Rooms Out of Service
completeOutOfServiceRooms 9 params body → 200400401403404405406413
GET
/hotels/{hotelId}/rooms/outOfServiceRooms
Get Out of Service Rooms
getOutOfServiceRooms 14 params → 200204400401403404405406
POST
/hotels/{hotelId}/rooms/outOfServiceRooms
Set multiple rooms to Out Of Service
postOutOfServiceRooms 9 params body → 201400401403404405406413
PUT
/hotels/{hotelId}/rooms/status
Update Housekeeping Room Status
putRoomRelatedStatus 9 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/rooms/{roomId}/cleaningPriority
Set the room cleaning priority
setRoomCleaningPriority 10 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/rooms/{roomId}/maintenances/{maintenanceId}
Change maintenances for rooms
putRoomMaintenance 11 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}
Cancel servicing task room
cancelServicingTaskRoom 11 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/complete
Complete servicing task room
completeServicingTaskRoom 11 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/skip
Skip servicing task room
skipServicingTaskRoom 11 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/start
Start servicing task room
startServicingTaskRoom 11 params body → 200400401403404405406413
POST
/hotels/{hotelId}/schedules/houseKeepingTasks
Create housekeeping attendant schedule
postHousekeepingAttendantSchedule 9 params body → 201400401403404405406413
PUT
/hotels/{hotelId}/serviceRequests
Set the Guest housekeeping service requests
setGuestHousekeepingServiceRequest 9 params body → 200400401403404405406413
GET
/hotels/{hotelId}/sheets/{sheetNumber}
Get task companion
getTaskCompanion 22 params → 200204400401403404405406
PUT
/hotels/{hotelId}/taskSheet/{taskSequenceNumber}/complete
Complete a task sheet
completeTaskSheet 10 params → 200400401403404405406413
PUT
/hotels/{hotelId}/taskSheet/{taskSequenceNumber}/reopen
Reopen a task sheet
reopenTaskSheet 10 params → 200400401403404405406413
PUT
/hotels/{hotelId}/taskSheetSet/{taskCodesBreakOutId}/complete
Complete all the hotel's task sheets for an existing Task Sheet Set.
completeTaskSheetSet 10 params → 200400401403404405406413
PUT
/hotels/{hotelId}/taskSheetSet/{taskCodesBreakOutId}/reopen
Reopen all the hotel's task sheets for an existing Task Sheet Set.
reopenTaskSheetSet 10 params → 200400401403404405406413
GET
/hotels/{hotelId}/taskSheetTemplates
Get the task sheet templates
getTaskSheetTemplate 10 params → 200204400401403404405406
PUT
/hotels/{hotelId}/taskSheetTemplates/{taskSheetTemplateCode}
Change the task sheet templates
putTaskSheetTemplate 10 params body → 200400401403404405406413
DELETE
/hotels/{hotelId}/taskSheetTemplates/{taskSheetTemplateCode}
Delete task sheet templates
deleteTaskSheetTemplate 10 params → 200400401403404405406413
POST
/hotels/{hotelId}/taskSheets
Create the task sheet
postTaskSheet 9 params body → 201400401403404405406413
PUT
/hotels/{hotelId}/taskSheets
Change the task sheet
putTaskSheet 9 params body → 200400401403404405406413
DELETE
/hotels/{hotelId}/taskSheets
Delete the task sheet
deleteTaskSheet 12 params → 200400401403404405406413
PUT
/hotels/{hotelId}/taskSheets/rooms
Change the task sheet rooms
putTaskSheetRooms 9 params body → 200400401403404405406413
DELETE
/hotels/{hotelId}/taskSheets/rooms
Delete task sheet rooms
deleteTaskSheetRooms 13 params → 200400401403404405406413
POST
/hotels/{hotelId}/taskSheets/rooms
Create the task sheet rooms
postTaskSheetRooms 9 params body → 201400401403404405406413
PUT
/hotels/{hotelId}/taskSheets/{sheetNumber}/lock
Lock the task sheet
lockTaskSheet 10 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/taskSheets/{sheetNumber}/unlock
Unlock the task sheet
unlockTaskSheet 10 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/taskSheets/{taskSheetNumber}/end
End the service break
endServiceBreak 10 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/taskSheets/{taskSheetNumber}/start
Start the service break
startServiceBreak 10 params body → 200400401403404405406413
POST
/hotels/{hotelId}/taskSheets/{toTaskSequenceNo}/merge
Merge task sheet
mergeTaskSheet 10 params body → 201400401403404405406413
GET
/services/houseKeeping/status
ping the house keeping service
pingHouseKeepingService 8 params → 200204400401403404405406

Schemas 263

The contract defines 263 schemas that model the data the API accepts and returns. The most detailed are reservationInfoType (57 properties), stayInfoType (36 properties), resGuestInfoType (30 properties), autoGenerateTaskSheetsCriteriaType (28 properties). Each schema is shown below with its type and property counts.

reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
unlockedTaskSheet
object
Response Body.
2 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
housekeepingRoomStatusInfo
object
Housekeeping Room Status Info Type
3 properties
resAccompanyGuestInfoType
object
5 properties
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
36 properties
changedRoomMaintenance
object
Response Body.
2 properties
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
taskSheetGenerationStatusTypesType
object
Different status lists which are going to be used in the Task Sheet Generation.
5 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
serviceTime
object
Response type for the start task room service. Can contain errors or warnings.
3 properties
roomMaintenance
object
Request to change room maintenance details.
3 properties
roomIds
array
Collection of room numbers to be process.
scheduleShiftRequest
object
Request with the information needed for the shift of the schedule.
3 properties
roomMaintenanceChangeType
object
Base maintenance type
6 properties
housekeepingRoomsType
object
Type for a list of Housekeeping rooms for a resort. Used as a criteria type for requests.
1 property
reservationFolioWindowsType
array
Collection of reservation folio windows.
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
imageResultType
object
7 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
57 properties
personNameType
object
This provides name information for a person.
12 properties
roomConditionAssigmentType
string
Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.
taskSheet
object
Request of Changing a Task Sheet. The task instructions, total credits, attendant information and room information can be changed on a task sheet. Task Instruc…
3 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
housekeepingCreditsDefinitionType
string
Type for the different kinds of Credits which will be used in Rooms Management.
canceledServicingTaskRoom
object
Response Body.
2 properties
taskSheetTemplate
object
Response for retrieving a task sheet template. It contains all the information of the previously generated tasksheet.
3 properties
housekeepingBoard
object
4 properties
roomCondition
object
Request element for setting room condition.
3 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
housekeepingInstructionsType
string
Simple type for housekeeping instructions that can be used in requests for partial operations.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCashieringType
object
Cashiering Information for the reservation.
14 properties
schedule
object
Return object that contains a list of facility tasks for the reservation specified in RQ.
6 properties
resPaymentCardType
object
Information on a credit card for the customer.
17 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
hotelRoomMaintenanceType
object
Hotel Rooms maintenance information type.
2 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
9 properties
forecastTotalsQuantitiesType
array
Collection of dates and their total quantities.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
indicatorsType
array
Collection of lamp indicators.
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
reservationPaymentMethodType
object
7 properties
roomTypeSuppliesType
object
List of the facility codes.
2 properties
indicatorType
object
Lamp indicator Type.
2 properties
roomsOutOfOrderType
array
Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS).
roomMaintenanceType
object
Base maintenance type
13 properties
completedServicingTaskRoom
object
Response Body.
2 properties
completeRoomRepair
object
3 properties
addressInfoType
object
Provides address information.
3 properties
frontOfficeRoomStatusType
string
Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
warningsType
array
Used in conjunction with the Success element to define a business error.
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
roomRangeType
object
2 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
roomRepairOutOfService
object
3 properties
assignedUserType
object
This contains assignment information for the maintenance request.
6 properties
roomTypeTasksType
array
This is a break-down of the different room types and their tasks count on a date.
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
reservationShortInfoType
object
15 properties
startedServiceBreak
object
Response Body.
2 properties
vIPStatusType
object
VIP status of the customer.
2 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
roomMaintenanceDetails
object
Response for the Fetch Room Maintenance request.
3 properties
guestHousekeepingService
object
Response Body.
2 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
resProfileTypeType
string
scheduledRoomMoveInfoType
object
Holds the scheduled room Move In/Out information.
4 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
moveTaskRooms
object
Request for moving rooms between task sheets.
3 properties
codeListType
array
forecastQuantitiesType
array
Collection of dates and their quantities.
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
roomTypeTaskType
object
This is a room type and its tasks count.
2 properties
facilityHousekeepingTaskType
object
A single facility task type.
10 properties
roomRepairOutOfOrder
object
3 properties
facilityCodesForecastType
array
Collection of facility codes with their forecasts.
hotelInterfaceType
object
8 properties
cardProcessingType
string
scheduledSearch
object
An updated schedule for the reservation after the reset.
5 properties
movedTaskRoomsRS
object
Response Body.
2 properties
endedServiceBreak
object
Response Body.
2 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
status
object
Response Body.
2 properties
authorizerInfoType
object
Authorizer Information
5 properties
resHousekeepingSetType
object
Search Criteria for retrieving guest housekeeping instructions.
5 properties
hotelRoomsType
object
Collection of Room record that contain Housekeeping and Out Of Order information.
2 properties
ratePlanRatingType
string
Possible Rate plan rating values.
guestHousekeepingServiceRequestCriteria
object
Operation to set the Guest Service status of an occupied room. The service status can be Do Not Disturb or Make Up Room.
3 properties
taskSheetToMerge
object
Request for merging task sheets.
3 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
turndownInfoType
object
1 property
roomCleaningPriorityType
object
Type to indicate the cleaning priority for a room.
1 property
facilityHousekeepingTasksType
array
List of the facility tasks.
housekeepingRoomReservationStatusType
string
Room Reservation status types used in housekeeping. These may be different from the actual reservation statuses as these relate to the current reservation for…
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
applicationUserType
object
18 properties
taskSheetType
string
Task Sheet classification.
housekeepingRoomStatus
object
Response Body.
2 properties
payeeInfoType
object
Payee information.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
scheduleSearch
object
Request with basic information reservation needed for the reset of the schedule.
3 properties
basicEmailType
string
Email address
blockIdList
array
Unique Id that references an object uniquely in the system.
resSharedGuestListType
array
Collection of shared guest reservations.
roomTypeShortInfoType
object
Basic information of room type.
12 properties
scheduledShiftRequest
object
An updated schedule for the reservation after the shift.
5 properties
roomCleaningPriority
object
Request to set a list of rooms as priority for cleaning. This will set a flag as priority and a priority number at the bottom of the current priority line.
3 properties
userSessionDefaultsType
object
9 properties
userSessionInfoType
object
11 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
sitePlanSectionType
object
Represents the site plan section record.
5 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
skipedServicingTaskRoom
object
Response Body.
2 properties
housekeepingAttendantsScheduleType
object
Collection of Attendants.
3 properties
reservationHousekeepingScheduleType
object
Criteria type for fetching reservation housekeeping schedule.
5 properties
roomSectionType
object
2 properties
roomFeaturesType
array
A recurring element that identifies the room features.
moveTaskRoomsCriteriaType
object
Type for moving rooms between two task sheets.
6 properties
roomConditionType
object
Condition to be assigned on the room.
3 properties
housekeepingType
object
Identifies the Housekeeping information.
8 properties
surnameType
string
Family name, last name.
housekeepingSectionType
object
Information regarding Housekeeping Sections.
9 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
rooms
object
3 properties
emailInfoType
object
Information on an email for the customer.
3 properties
roomAssignmentStatusType
string
taskCompanion
object
Response for the Fetch Task Room request. The room details for the room requested or for the room which was evaluated to be cleaned will be returned along with…
3 properties
roomMaintenanceRequestType
object
Base maintenance type
5 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties 2 required
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
facilityCodesType
array
List of the facility codes.
resAttachedProfileListType
array
roomConditionRequestStatus
object
Response Body.
2 properties
maintenanceCountType
object
Information regarding Room Maintenance count
1 property
roomType
object
This type represents the primary room attributes.
25 properties
roomRoomType
object
This type represents the primary room attributes.
14 properties
roomPersonsCountType
object
1 property
facilityTotalForecastType
object
The Total of the forecasts.
2 properties
roomDiscrepanciesType
array
Room Discrepancies between front office and housekeeping room status and number of persons in the room.
personNameTypeType
string
Person's name in an external system.
facilityTaskBaseType
object
Facility Housekeeping task code and description.
3 properties
roomPersonsType
object
2 properties
taskSheets
object
Request for generating housekeeping Task Sheets automatically. To generate task sheets automatically the minimum required criteria is the Task Date, Task Code,…
3 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
phoneNumberType
string
Phone number
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
daysOfWeekType
string
Allowed values for the days of week type.
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
givenNameType
string
Given name, first name or names
imageResultsType
array
Collection of image results.
pingRS
object
Response for Ping operation.
3 properties
facilityCodeForecastType
object
A facility code and its forecast.
2 properties
roomMaintenanceRequest
object
Request to create a room maintenance record.
4 properties
taskSheetInstructionsType
object
Instructions which will added to the Task Sheets which are generated.
3 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
attendantType
object
2 properties
guestHousekeepingInstructions
object
Return object that contains guest housekeeping instructions for the reservation/room.
3 properties
unresolvedRoomMaintenance
object
Response Body.
2 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
housekeepingRoomStatusCriteria
object
7 properties
housekeepingCreditsType
object
Information regarding the credits for housekeeping tasks/rooms.
2 properties
departureTaskInfoType
object
Facility task info related to the departure task.
2 properties
forecastQuantityType
object
Quatity data for a single day.
4 properties
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
parametersType
array
Collection of generic Name-Value-Pair parameters.
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
resAttachedProfileType
object
3 properties
housekeepingTaskStayPeriodType
string
Simple type for controlling the fetch operations of the housekeeping schedule request.
roomDiscrepancyType
string
Simple type for discrepant room status instructions to be used in requests for fetching housekeeping and front office room discrepancy. Valid values are Sleep,…
emailType
object
Information on an email for the customer.
11 properties
housekeepingAttendantScheduleType
object
Criteria to manage the attendant schedule.
3 properties
resolvedRoomMaintenance
object
Response Body.
2 properties
operaVersionNumberType
string
Current Opera Version Number
addressType
object
Provides address information.
19 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
housekeepingTaskType
object
23 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
facilityForecast
object
Response element for the fetched facility forecast.
3 properties
taskSheetToUnlock
object
Request for unlocking a task sheet.
3 properties
roomInformationType
object
Room Information needed in updating the status.
2 properties
housekeepingScheduleShiftDayType
object
Day of the week to which schedule of the week is to be shifted to.
1 property
mergeTaskSheetCriteriaType
object
Criteria to merge task sheets.
4 properties
roomStatusType
object
4 properties
roomOutOfOrderType
object
Out Of Order and Out Of Service Room information.
10 properties
translationsTextType
array
Language code for the translation.
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
reservationAllowedActionsType
array
Allowed action.
taskAssignment
object
3 properties
taskSheetLockCriteriaType
object
Criteria to lock or unlock a task sheet.
3 properties
roomHoldType
object
3 properties
vIPType
object
The supplier's ranking of the customer.
2 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
externalReferencesType
array
This type contains unique information of external reference.
housekeepingScheduleShiftRequestType
object
Criteria type for fetching reservation housekeeping schedule.
5 properties
countryNameType
object
Code for a country or a nationality.
2 properties
changedTaskSheetRooms
object
Response Body.
2 properties
guestHousekeepingServiceRequest
object
Operation to get set guest housekeeping instructions for the room.
3 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties 2 required
roomFeatureType
object
Room Feature Information.
4 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
taskSheetToLock
object
Request for locking a task sheet.
3 properties
serviceTaskRoomType
object
Criteria for servicing a task room.
11 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
taskRoom
object
Request to start servicing a task room. When the attendant starts working on a room this request can be called to set the times and the status to WORKING for t…
3 properties
interfaceRightsStatusType
object
4 properties
guestHousekeepingServiceRequestStatus
object
Response Body.
2 properties
roomCleaningPriorityRequestStatus
object
Response Body.
2 properties
roomRoomsType
array
Collection of rooms.
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
setGuestHousekeepingServiceRequestCriteriaType
object
Criteria for changing the guest service status on an occupied room.
3 properties
currentServicingAttendantType
object
The Attendant Name and ID of the attendant servicing the room.
16 properties
lockedTaskSheet
object
Response Body.
2 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
autoGenerateTaskSheetsCriteriaType
object
Criteria Type for generating Housekeeping Task Sheets automatically. Defines the criteria required for automatic generation.
28 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
employeeInfoType
object
9 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
housekeepingTaskAssignmentType
object
Contains information for all the Task Sheets generated for a particular combination of Date and Task Code.
5 properties
reservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
housekeepingTaskAssignmentsType
array
Collection of Assignments
reservationHousekeepingScheduleSearchType
object
Criteria type for fetching reservation housekeeping schedule.
4 properties
anonymizationStatusType
string
Guest has been anonymized.
changedTaskSheetTemplate
object
Response Body.
2 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
appUserOnBreakType
object
Information about on break start time and the application user who goes on break.
2 properties
attendantSchedule
object
Request for creating the attendant schedule.
3 properties
changedTaskSheet
object
Response Body.
2 properties
servicingAttendantStatusType
string
Possible values for the Status of a Servicing Attendant.
stayDateInfoType
object
Room attached with stay detail information
2 properties
resolveRoomMaintenanceType
object
Resolve Room Maintenance Type.
2 properties
parameterType
object
Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.
2 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
facilityTaskForecastType
object
A facility task and its forecast.
3 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
externalReferenceType
object
This type contains unique information of external reference.
3 properties
links
array
setRoomConditionType
object
5 properties
completeRoomRepairStatus
object
Response Body.
2 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
commissionPayoutToType
string
hotelInterfaceTypeType
string
XML Posting Interface
forecastTotalsQuantityType
object
Quatity data for a single day.
5 properties
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-hospitality-housekeeping-api-openapi.yml Raw ↑

Other APIs Oracle Hospitality publishes across the network.

OPERA Cloud RnA Activities GraphQL API
OPERA Cloud RnA ARAccountsReceivable GraphQL API
OPERA Cloud RnA ARAgingReport GraphQL API
OPERA Cloud RnA ARLedger GraphQL API
OPERA Cloud RnA BookingReservationExtended GraphQL API
OPERA Cloud RnA BookingsBlockProductionChanges GraphQL API
OPERA Cloud RnA BookingsBlockStatusChanges GraphQL API
OPERA Cloud RnA BookingsBlock GraphQL API
OPERA Cloud RnA BookingsReservation GraphQL API
OPERA Cloud RnA CateringEventForecast GraphQL API
OPERA Cloud RnA CateringEventPostings GraphQL API
OPERA Cloud RnA CateringEventStatusChanges GraphQL API
Where this information came from

This is an independent, third-party profile of Oracle Hospitality Housekeeping API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.