{ "swagger": "2.0", "info": { "title": "OPERA Cloud Housekeeping Service API", "description": "APIs to cater for Housekeeping functionality in OPERA Cloud.

Housekeeping enables you to schedule daily room cleaning, maintenance, and housekeeping staff activities. It provides information on room status, out of order/out of service rooms, and forecasting.

Compatible with OPERA Cloud release 26.2.0.0.

This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.

", "version": "26.2.0.0", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" }, "license": { "name": "UPL", "url": "https://opensource.org/licenses/upl" } }, "schemes": [ "https" ], "basePath": "/hsk/v1", "produces": [ "application/json" ], "paths": { "/hotels/{hotelId}/attendants/houseKeepingTasks": { "get": { "summary": "Get the housekeeping attendants schedule", "description": "This API will allow you to get the housekeeping attendants schedule.

OperationId:getHousekeepingAttendantsSchedule

This API allows a time span of 30 days.

", "operationId": "getHousekeepingAttendantsSchedule", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "scheduleStartDate", "in": "query", "required": true, "description": "The starting value of the date range.", "type": "string", "format": "date" }, { "name": "scheduleEndDate", "in": "query", "required": false, "description": "The ending value of the date range.", "type": "string", "format": "date" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetching the attendants schedule.", "schema": { "$ref": "#/definitions/attendantSchedule" } }, "204": { "description": "HousekeepingAttendantsSchedule not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "delete": { "summary": "Delete housekeeping attendant schedule", "description": "This API will allow you to delete housekeeping attendant schedule.

OperationId:deleteHousekeepingAttendantSchedule

", "operationId": "deleteHousekeepingAttendantSchedule", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "scheduleDate", "in": "query", "required": true, "description": "Schedule date of attendants' assignment. Used when attendants to scheduled are of the same date.", "type": "string", "format": "date" }, { "name": "attendantId", "in": "query", "type": "array", "collectionFormat": "multi", "description": "ID of the attendant.", "items": { "type": "string" }, "required": true }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/autoTaskSheets": { "post": { "summary": "Auto generate the task sheets", "description": "This API will allow you to Auto generate the task sheets.

OperationId:autoGenerateTaskSheets

", "operationId": "autoGenerateTaskSheets", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheets", "in": "body", "required": true, "description": "Request for generating housekeeping Task Sheets automatically. To generate task sheets automatically the minimum required criteria is the Task Date, Task Code, Number of Attendants/Tasksheets required and the Room Statuses. Based on the criteria defined, task sheets will be created and the rooms will be assigned to the Tasksheets. Example: if the criteria defines that Dirty room status to be used to generate 5 sheets, then only those rooms which have the status = Dirty will be used and will be assigned to the 5 sheets.", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheets" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/conditions": { "get": { "summary": "Get rooms condition", "description": "This API will allow you to get a list of rooms that have a condition set.

OperationId:getRoomConditions

", "operationId": "getRoomConditions", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomConditionsOnly", "in": "query", "required": false, "description": "Include rooms with conditions only.", "type": "boolean" }, { "name": "roomWithoutConditionsOnly", "in": "query", "required": false, "description": "Include rooms without conditions only.", "type": "boolean" }, { "name": "room", "in": "query", "required": false, "description": "Identifier of the room.", "type": "string" }, { "name": "fromRoomNumber", "in": "query", "required": false, "type": "string" }, { "name": "toRoomNumber", "in": "query", "required": false, "type": "string" }, { "name": "roomConditions", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomTypes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomClasses", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "frontOfficeRoomStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Vacant", "Occupied" ] }, "required": false }, { "name": "reservationStatuses", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomAssignmentStatus", "in": "query", "type": "array", "collectionFormat": "multi", "uniqueItems": true, "items": { "type": "string", "enum": [ "Assigned", "Unassigned" ] }, "required": false }, { "name": "floors", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomFeatures", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "amSections", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "pmSections", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "buildings", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "housekeepingRoomStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Clean", "Dirty", "Pickup", "Inspected", "OutOfOrder", "OutOfService" ] }, "required": false }, { "name": "roomParityStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for room parity instructions to be used in requests for fetching housekeeping rooms. Valid status values are Odd and Even.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Odd", "Even" ] }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response element for fetching room conditions.", "schema": { "$ref": "#/definitions/rooms" } }, "204": { "description": "RoomConditions not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "put": { "summary": "Set rooms condition", "description": "This API will allow you to set, change, or delete a condition on rooms. A condition is used to designate rooms that are available for show, set aside for special housekeeping attention, or are to be treated differently for any other reason.

OperationId:setRoomCondition

", "operationId": "setRoomCondition", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomCondition", "in": "body", "required": true, "description": "Request element for setting room condition.", "schema": { "allOf": [ { "$ref": "#/definitions/roomCondition" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/roomConditionRequestStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/forecastTaskSchedules": { "get": { "summary": "Get facility forecast", "description": "This API will allow you to get facility forecast for Housekeeping attendants and tasks for a current or future start date .

OperationId:getFacilityForecast

This API allows a time span of 30 days.

", "operationId": "getFacilityForecast", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "duration", "in": "query", "required": false, "type": "string" }, { "name": "Codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "usePriority", "in": "query", "required": false, "description": ".", "type": "boolean" }, { "name": "includeCreditRules", "in": "query", "required": false, "description": "Selecting to Include Credit Rules will include Item inventory and Specials credits on reservations to the Estimated Total Credits calculation.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response element for the fetched facility forecast.", "schema": { "$ref": "#/definitions/facilityForecast" } }, "204": { "description": "FacilityForecast not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/houseKeepingTasks/{taskCodesBreakOutId}": { "delete": { "summary": "Delete all the hotel task sheets for an existing Task Sheet Set.", "description": "Use this API to delete all task sheets for an existing task sheet set for a specific property. Task Sheet Sets can be used to break out the rooms to be cleaned by the housekeeping attendants.

OperationId:deleteHouseKeepingTaskSheets

", "operationId": "deleteHouseKeepingTaskSheets", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates Unique Hotel Code for which the task sheets will be deleted." }, { "name": "taskCodesBreakOutId", "in": "path", "required": true, "description": "Indicates Unique breakout ID for which the task sheets will be deleted.", "type": "string", "minLength": 1, "maxLength": 2000 }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of deleted resource" } }, "description": "Additional warnings about the operation.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/houseKeepingtasks": { "get": { "summary": "Get the existing task sheets", "description": "This API will allow you to get the existing task sheets.

OperationId:getHouseKeepingTasks

", "operationId": "getHouseKeepingTasks", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskDate", "in": "query", "required": true, "description": "Date for which the Task Assignment information is required.", "type": "string", "format": "date" }, { "name": "attendantInRoomOnly", "in": "query", "required": false, "description": "Query only rooms with attendant working in them.", "type": "boolean" }, { "name": "generateCleaningSequence", "in": "query", "required": false, "description": "Setting 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.", "type": "boolean" }, { "name": "includeReservationInfo", "in": "query", "required": false, "description": "Setting this to true will include reservation information associated to the room.", "type": "boolean" }, { "name": "includeComponentRoomsInfo", "in": "query", "required": false, "description": "Setting this to true will include component rooms information associated to the room.", "type": "boolean" }, { "name": "includeTaskSheetDetails", "in": "query", "required": false, "description": "This 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.", "type": "boolean" }, { "name": "includeScheduledRoomDetails", "in": "query", "required": false, "description": "Set this to true to include reservation information associated with any scheduled room moves. Available when the Advanced Daily Details OPERA Control is active. Note: IncludeReservationInfo must also be set to true to fetch reservation details.", "type": "boolean" }, { "name": "includeTaskSheetsSummary", "in": "query", "required": false, "description": "Setting 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.", "type": "boolean" }, { "name": "sortByCleaningSequence", "in": "query", "required": false, "description": "The rooms in the task sheet would be sorted with the cleaning sequence. The normal sort would be done based on the Default Sequence.", "type": "boolean" }, { "name": "taskCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "The Code for the task.", "items": { "type": "string" }, "required": false }, { "name": "taskHotelCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Property for which the Task Assignment information is required.", "items": { "type": "string" }, "required": false }, { "name": "taskSequences", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Ordering sequence for display.", "items": { "type": "integer" }, "required": false }, { "name": "taskDescriptions", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Description of the Task Code.", "items": { "type": "string" }, "required": false }, { "name": "taskInstructions", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Instructions for this Task Code.", "items": { "type": "string" }, "required": false }, { "name": "facilityDepartureTask", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Indicates if this task code is the Departure Room Default Task to be scheduled on the departure date of the reservations. Defining a Departure Room Default Task is available when the 'Housekeeping Task Scheduling' OPERA Control is active.", "items": { "type": "boolean" }, "required": false }, { "name": "linenChange", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Indicates if a linen change is necessary.", "items": { "type": "boolean" }, "required": false }, { "name": "taskCodesBreakOutId", "in": "query", "required": false, "description": "A 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.", "type": "string" }, { "name": "taskCodesBreakOutIdContext", "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string" }, { "name": "taskCodesBreakOutIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "attendantId", "in": "query", "required": false, "description": "Attendant ID for which the Task Sheets are assigned.", "type": "string" }, { "name": "taskSheetNumber", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Specific Task Sheet number for which the information is required.", "items": { "type": "integer" }, "required": false }, { "name": "housekeepingRoomStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Clean", "Dirty", "Pickup", "Inspected", "OutOfOrder", "OutOfService" ] }, "required": false }, { "name": "guestService", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Possible values for the Guest Service Status.", "uniqueItems": true, "items": { "type": "string", "enum": [ "DoNotDisturb", "MakeUpRoom", "NoStatusSelected", "ServiceDeclined" ] }, "required": false }, { "name": "roomStatusToChange", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Clean", "Dirty", "Pickup", "Inspected", "OutOfOrder", "OutOfService" ] }, "required": false }, { "name": "includeTaskSupplies", "in": "query", "required": false, "description": "Setting this to true, will return task supplies information for the task sheets if Facility Management control is active. If IncludeReservationInfo is set to true supplies information will always be returned.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "", "schema": { "$ref": "#/definitions/taskAssignment" }, "examples": { "application/json": { "taskAssignmentInfo": [ { "taskCodes": [ { "description": "string", "instructions": "string", "facilityDepartureTask": true, "linenChange": true, "hotelId": "string", "code": "string", "sequence": 0 } ], "taskSheets": [ { "taskCodes": [ { "description": "string", "instructions": "string", "facilityDepartureTask": true, "linenChange": true, "hotelId": "string", "code": "string", "sequence": 0 } ], "departureTaskInfo": { "roomType": [ { "facilityCode": [ { "description": "string", "quantity": 0, "code": "string" } ], "type": "string" } ], "code": "string" }, "totalSupplies": [ { "description": "string", "quantity": 0, "code": "string" } ], "credits": [ { "type": "Departure", "numberOfCredits": 0 } ], "attendant": { "section": { "hotelId": "string", "code": "string", "description": "string", "sectionGroup": "string", "targetCredits": 0, "rooms": 0, "roomCredits": 0, "sequence": 0, "inactive": true }, "floor": "string", "attendantId": "string", "attendantName": "string", "hotelId": "string", "activeFlag": "string", "sunday": true, "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": true, "attendantInstructions": "string" }, "appUserOnBreak": { "appUser": { "hotel": { "code": "string", "description": "string" }, "appUser": "string", "lDAPUser": "string", "actAs": "string", "actAt": "string", "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", "salesRepCode": "string", "expiryDate": "2020-08-24", "disabledUntil": "2020-08-24", "passwordChangeDate": "2020-08-24", "userInfo": { "personName": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "profileId": { "id": "string", "type": "string" }, "addressInfo": { "address": { "addressLine": [ "string" ], "cityName": "string", "postalCode": "string", "cityExtension": "string", "county": "string", "state": "string", "country": { "value": "string", "code": "string" }, "language": "string", "type": "string", "typeDescription": "string", "primaryInd": true, "updateReservations": true, "barCode": "string", "createDateTime": "2020-08-24T12:55:55.600Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.600Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "emailInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.600Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.600Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "phoneInfo": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.600Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.600Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "department": { "code": "string", "description": "string" }, "gender": "Male", "birthDate": "2020-08-24", "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-08-24", "systemDate": "2020-08-24", "terminal": "string", "runningApp": "string", "shareProfiles": true, "hotel": { "code": "string", "description": "string" }, "cro": { "code": "string", "description": "string" }, "chain": "string", "cROCountryCode": "string", "sessionDefaults": { "dbDateFormat": "string", "oracleDateFormat": "string", "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", "currencyCode": "string", "currencyFormat": "string", "defaultLanguage": "string", "baseLanguage": "string" }, "parameters": [ { "parameterName": "string", "parameterValue": "string" } ] }, "attendantInfo": { "attendantId": "string", "hotelId": "string" } }, "startTime": "2020-08-24T12:55:55.600Z" }, "rooms": [ { "roomType": { "pseudoRoom": true, "isSuiteRoom": true, "roomClass": "string", "shortDescription": "string", "houseKeeping": true, "smokingPreference": "string", "minimumOccupancy": 0, "maximumOccupancy": 0, "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "isAccessible": true, "roomType": "string", "meetingRoom": true }, "floor": "string", "floorDescription": "string", "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "roomDescription": "string", "description": { "defaultText": "string", "translatedTexts": [ { "value": "string", "language": "string" } ] }, "smokingPreference": "string", "smokingPreferenceDescription": "string", "building": "string", "roomAssignmentRating": "MostImportant", "isAccessible": true, "roomId": "string", "meetingRoom": true, "roomSection": { "daySectionCode": "string", "eveningSectionCode": "string" }, "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrival" ], "housekeepingRoomStatus": "Clean", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 }, "guestServiceRequest": "DoNotDisturb", "cleaningPriority": { "prioritySequence": 0 }, "roomCondition": { "roomCondition": { "code": "string", "description": "string" }, "assignmentType": "Available", "remarks": "string" }, "linenChange": true, "facilityTaskCode": [ "string" ] }, "outOfOrder": [ { "repairRemarks": "string", "returnStatus": "Clean", "reasonCode": "string", "reasonDescription": "string", "newDateRange": { "start": "2020-08-24", "end": "2020-08-24" }, "housekeepingRoomStatus": "Clean", "start": "2020-08-24", "end": "2020-08-24" } ], "discrepancy": [ "Sleep" ], "sitePlanSection": { "sectionCode": "string", "sectionType": "string", "linkCode": "string", "coordinates": "string", "description": "string" }, "componentRoomNumber": "string", "connectingRooms": [ { "roomType": { "pseudoRoom": true, "isSuiteRoom": true, "roomClass": "string", "shortDescription": "string", "houseKeeping": true, "smokingPreference": "string", "minimumOccupancy": 0, "maximumOccupancy": 0, "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "isAccessible": true, "roomType": "string", "meetingRoom": true }, "floor": "string", "floorDescription": "string", "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "roomDescription": "string", "description": { "defaultText": "string", "translatedTexts": [ { "value": "string", "language": "string" } ] }, "smokingPreference": "string", "smokingPreferenceDescription": "string", "building": "string", "roomAssignmentRating": "MostImportant", "isAccessible": true, "roomId": "string", "meetingRoom": true, "roomCondition": { "code": "string", "description": "string" } } ], "componentRooms": [ { "roomType": { "pseudoRoom": true, "isSuiteRoom": true, "roomClass": "string", "shortDescription": "string", "houseKeeping": true, "smokingPreference": "string", "minimumOccupancy": 0, "maximumOccupancy": 0, "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "isAccessible": true, "roomType": "string", "meetingRoom": true }, "floor": "string", "floorDescription": "string", "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "roomDescription": "string", "description": { "defaultText": "string", "translatedTexts": [ { "value": "string", "language": "string" } ] }, "smokingPreference": "string", "smokingPreferenceDescription": "string", "building": "string", "roomAssignmentRating": "MostImportant", "isAccessible": true, "roomId": "string", "meetingRoom": true, "roomCondition": { "code": "string", "description": "string" } } ], "attendant": [ { "section": { "hotelId": "string", "code": "string", "description": "string", "sectionGroup": "string", "targetCredits": 0, "rooms": 0, "roomCredits": 0, "sequence": 0, "inactive": true }, "floor": "string", "attendantId": "string", "attendantName": "string", "hotelId": "string", "activeFlag": "string", "sunday": true, "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": true, "appUser": { "hotel": { "code": "string", "description": "string" }, "appUser": "string", "lDAPUser": "string", "actAs": "string", "actAt": "string", "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", "salesRepCode": "string", "expiryDate": "2020-08-24", "disabledUntil": "2020-08-24", "passwordChangeDate": "2020-08-24", "userInfo": { "personName": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "profileId": { "id": "string", "type": "string" }, "addressInfo": { "address": { "addressLine": [ "string" ], "cityName": "string", "postalCode": "string", "cityExtension": "string", "county": "string", "state": "string", "country": { "value": "string", "code": "string" }, "language": "string", "type": "string", "typeDescription": "string", "primaryInd": true, "updateReservations": true, "barCode": "string", "createDateTime": "2020-08-24T12:55:55.601Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.601Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "emailInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.601Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.601Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "phoneInfo": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.601Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.601Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "department": { "code": "string", "description": "string" }, "gender": "Male", "birthDate": "2020-08-24", "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-08-24", "systemDate": "2020-08-24", "terminal": "string", "runningApp": "string", "shareProfiles": true, "hotel": { "code": "string", "description": "string" }, "cro": { "code": "string", "description": "string" }, "chain": "string", "cROCountryCode": "string", "sessionDefaults": { "dbDateFormat": "string", "oracleDateFormat": "string", "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", "currencyCode": "string", "currencyFormat": "string", "defaultLanguage": "string", "baseLanguage": "string" }, "parameters": [ { "parameterName": "string", "parameterValue": "string" } ] }, "attendantInfo": { "attendantId": "string", "hotelId": "string" } }, "startTime": "2020-08-24T12:55:55.601Z", "status": "Standby" } ], "hold": { "holdUntil": "2020-08-24T12:55:55.601Z", "holdUser": "string", "comments": "string" }, "turndownInfo": { "turndownStatusInfo": "Required" }, "resvInfo": [ { "guestName": "string", "reservationId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "reservationStatusInfo": "Arrival", "stayDateInfo": { "timeSpan": { "startDate": "2020-08-24", "endDate": "2020-08-24", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-08-24T12:55:55.601Z", "reservationExpectedDepartureTime": "2020-08-24T12:55:55.601Z" } }, "vipStatus": { "value": "string", "code": "string" }, "profileId": { "id": "string", "type": "string" } } ], "componentRoomNumbers": [ "string" ], "reservationInfo": [ { "reservationIdList": [ { "id": "string", "type": "string" } ], "roomStay": { "arrivalDate": "2020-08-24", "departureDate": "2020-08-24", "originalTimeSpan": { "startDate": "2020-08-24", "endDate": "2020-08-24", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-08-24T12:55:55.601Z", "reservationExpectedDepartureTime": "2020-08-24T12:55:55.601Z" }, "adultCount": 0, "childCount": 0, "roomClass": "string", "roomType": "string", "numberOfRooms": 0, "roomNumber": "string", "ratePlanCode": "string", "rateAmount": { "amount": 0, "currencyCode": "string" }, "points": { "awardsType": "string", "points": 0 }, "rateSuppressed": true, "reservationBlock": { "blockIdList": [ { "id": "string", "type": "string" } ], "blockName": "string", "hotelId": "string" }, "bookingChannelCode": "string", "partyCode": "string", "fixedRate": true, "totalAmount": { "amount": 0, "currencyCode": "string" }, "guarantee": { "guaranteeCode": "string", "shortDescription": "string", "onHold": true }, "promotion": { "promotionCode": "string", "promotionName": "string", "couponCode": "string" }, "marketCode": "string", "sourceOfBusiness": "string", "sourceOfBusinessDescription": "string", "balance": { "amount": 0, "currencyCode": "string" }, "compBalance": { "amount": 0, "currencyCode": "string" }, "roomTypeCharged": "string", "depositPayments": { "amount": 0, "currencyCode": "string" }, "guestServiceStatus": "DoNotDisturb", "scheduledCheckoutTime": "2020-08-24", "roomNumberLocked": true, "pseudoRoom": true }, "reservationGuest": { "membership": { "membershipId": 0, "programCode": "string", "bonusCode": "string", "membershipTypeDesc": "string", "membershipLevelDesc": "string", "accountId": "string", "membershipLevel": "string", "playerRanking": 0 }, "namePrefix": "string", "givenName": "string", "alternateGivenName": "string", "middleName": "string", "surnamePrefix": "string", "surname": "string", "alternateSurname": "string", "nameSuffix": "string", "nameTitle": "string", "fullName": "string", "alternateFullName": "string", "phoneNumber": "string", "email": "string", "birthDate": "2020-08-24", "language": "string", "nationality": { "value": "string", "code": "string" }, "vip": { "vipCode": "string", "vipDescription": "string" }, "address": { "cityName": "string", "postalCode": "string", "state": "string", "country": { "value": "string", "code": "string" }, "streetAddress": "string", "excludeNoCity": true }, "anonymization": { "anonymizationStatus": "Requested", "anonymizationDate": "2020-08-24T12:55:55.601Z" }, "accompanyGuests": [ { "firstName": "string", "lastName": "string", "fullName": "string", "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } ] } ], "externalInfo": { "givenName": "string", "surname": "string" }, "guestLastStayInfo": { "lastStayDate": "2020-08-24", "lastStayRoom": "string", "lastStayRate": { "amount": 0, "currencyCode": "string" }, "totalStay": 0 }, "guestRestrictedCode": "string", "guestRestrictedReasonDesc": "string", "guestRestricted": true, "registrationCardNo": "string", "nameType": "Guest", "id": "string", "type": "string" }, "sharedGuests": [ { "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "firstName": "string", "lastName": "string", "fullName": "string" } ], "attachedProfiles": [ { "name": "string", "profileIdList": [ { "id": "string", "type": "string" } ], "reservationProfileType": "Company" } ], "reservationPaymentMethod": { "paymentCard": { "cardId": { "id": "string", "type": "string" }, "currentAuthorizedAmount": { "amount": 0, "currencyCode": "string" }, "approvalAmountNeeded": { "amount": 0, "currencyCode": "string" }, "cardType": "Ab", "userDefinedCardType": "string", "cardNumber": "string", "cardNumberMasked": "string", "cardNumberLast4Digits": "string", "expirationDate": "2020-08-24", "expirationDateMasked": "string", "expirationDateExpired": true, "cardHolderName": "string", "attachCreditCardToProfile": true, "processing": "Eft", "swiped": true, "cardOrToken": "CardNumber" }, "balance": { "amount": 0, "currencyCode": "string" }, "authorizationRule": { "code": 0, "amount": { "amount": 0, "currencyCode": "string" }, "percent": 0 }, "emailFolioInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.601Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.601Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "emailFolio": true, "id": "string", "type": "string" }, "paymentMethod": "string", "description": "string", "folioView": 0 }, "reservationFolioWindows": [ { "payeeInfo": { "payeeId": { "id": "string", "type": "string" }, "payeeName": "string", "payeeAddress": { "address": { "addressLine": [ "string" ], "cityName": "string", "postalCode": "string", "cityExtension": "string", "county": "string", "state": "string", "country": { "value": "string", "code": "string" }, "language": "string", "type": "string", "typeDescription": "string", "primaryInd": true, "updateReservations": true, "barCode": "string", "createDateTime": "2020-08-24T12:55:55.601Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.601Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "payeeAddressCount": 0, "payeeReferenceCurrency": "string", "payeeAccountInfo": { "accountName": "string", "accountId": { "id": "string", "type": "string" }, "accountNo": "string", "status": { "restriction": "string", "description": "string", "restricted": true } }, "payeeTaxNumber": "string" }, "balance": { "amount": 0, "currencyCode": "string" }, "paymentMethod": "string", "folioWindowNo": 0 } ], "specials": "string", "lastPrivacyPromptDate": "2020-08-24", "displayColor": "string", "reservationIndicators": [ { "indicatorName": "string", "count": 0 } ], "housekeepingRoomStatus": "Clean", "searchMatches": [ { "attribute": "string", "value": "string" } ], "sourceOfSale": { "sourceType": "string", "sourceCode": "string" }, "waitlist": { "reasonDescription": "string", "priorityDescription": "string", "description": "string", "reasonCode": "string", "priorityCode": "string", "telephone": "string" }, "queue": { "timeSpan": { "startDate": "2020-08-24", "endDate": "2020-08-24", "duration": "string", "durationInSeconds": 0 }, "guestTextInfo": { "sentTime": "2020-08-24T12:55:55.601Z", "sentBy": "string" }, "priority": 0, "averageQueueTimeToCheckIn": 0, "averageQueueTimeCurrentReservations": 0, "queueDate": "2020-08-24" }, "housekeeping": { "instructions": "string", "facilityTaskInfo": { "task": { "description": "string", "instructions": "string", "facilityDepartureTask": true, "linenChange": true, "hotelId": "string", "code": "string", "sequence": 0 }, "supplies": [ { "description": "string", "quantity": 0, "code": "string" } ], "date": "2020-08-24" }, "linenChange": true, "turndownRequested": true, "serviceTime": "2020-08-24", "expectedServiceTime": "string", "housekeepingRoomStatus": "Clean" }, "cashiering": { "revenuesAndBalances": { "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, "totalPayment": { "amount": 0, "currencyCode": "string" }, "roomRevenue": { "amount": 0, "currencyCode": "string" }, "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, "otherRevenue": { "amount": 0, "currencyCode": "string" }, "nonRevenue": { "amount": 0, "currencyCode": "string" }, "totalRevenue": { "amount": 0, "currencyCode": "string" }, "balance": { "amount": 0, "currencyCode": "string" } }, "billingPrivileges": { "postingRestriction": true, "preStayCharging": true, "postStayCharging": true, "folioCloseDate": "2020-08-24", "scheduledCheckout": true, "scheduledCheckoutTime": "2020-08-24", "directBillAuthorized": true, "videoCheckout": true, "allowAutoCheckin": true, "autoSettlement": true, "autoSettlementType": "string", "autoSettlementFreq": 0, "creditLimitAutoPay": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0, "taxExemptNo": "string" }, "bedTaxReporting": { "taxRegistrationNo": 0, "visaNumber": "string", "visaIssueDate": "2020-08-24", "visaExpiryDate": "2020-08-24", "taxableDays": 0 }, "folioTexts": [ { "text": "string", "row": 0 } ], "periodicFolio": { "lastSettlementDate": "2020-08-24", "lastFolioDate": "2020-08-24", "frequency": 0 }, "compAccounting": { "compType": "string", "authorizer": "string", "compPostings": "string" }, "reservationPreConfiguredRoutingInstruction": { "authorizerInfo": { "authorizerId": { "id": "string", "type": "string" }, "authorizerUserName": "string", "authorizerName": "string", "authorizerRateCode": "string", "inheritAuthorizerRateCode": true }, "ratePlanCode": "string", "profileType": "Company", "promotionCode": "string" }, "financiallyResponsible": true, "proratedBilling": true, "lastRoomAndTaxPostedDate": "2020-08-24", "reverseCheckInAllowed": true, "reverseAdvanceCheckInAllowed": true, "transactionsPosted": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0 }, "deposit": { "amountRequired": 0, "amountPaid": 0, "amountOwed": 0, "dueDate": "2020-08-24", "postingDate": "2020-08-24", "hasPaid": true, "hasOutstanding": true }, "allowedActions": [ "Cancel" ], "revenuesAndBalances": { "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, "totalPayment": { "amount": 0, "currencyCode": "string" }, "roomRevenue": { "amount": 0, "currencyCode": "string" }, "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, "otherRevenue": { "amount": 0, "currencyCode": "string" }, "nonRevenue": { "amount": 0, "currencyCode": "string" }, "totalRevenue": { "amount": 0, "currencyCode": "string" }, "balance": { "amount": 0, "currencyCode": "string" } }, "hotelInterfaceStatusList": [ { "roomExtension": "string", "hotelInterface": { "interfaceId": { "id": "string", "type": "string" }, "hotelId": "string", "interfaceName": "string", "interfaceType": "Bms", "logo": "string", "machineName": "string", "status": "Stopped", "activeFlag": true }, "interfaceRights": [ { "right": 0, "statusCode": "string", "description": "string", "category": "string" } ] } ], "guestPreferredCurrency": "string", "turndownInfo": { "allowed": true, "status": "Required" }, "mobileNotifications": { "roomReady": "Pending", "keyReady": "Pending", "checkoutMessageReceived": true, "requiresAction": true, "errorMessage": "string" }, "reservationCommunication": { "telephones": { "telephoneInfo": [ { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.602Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.602Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "emails": { "emailInfo": [ { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.602Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.602Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 } }, "advanceCheckIn": { "advanceCheckedIn": true, "expectedReturnTime": "2020-08-24T12:55:55.602Z", "eTRComments": "string" }, "welcomeOffer": true, "cancellationInfo": { "description": "string", "code": "string", "date": "2020-08-24" }, "keyCount": 0, "hotelId": "string", "hotelName": "string", "expectedServiceTime": "string", "roomStayReservation": true, "createDateTime": "2020-08-24T12:55:55.602Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.602Z", "lastModifierId": "string", "purgeDate": "2020-08-24", "reservationStatus": "Reserved", "computedReservationStatus": "Reserved", "walkInIndicator": true, "accessRestriction": "Change", "commissionPayoutTo": "TravelAgent", "paymentMethod": "string", "preRegistered": true, "openFolio": true, "allowMobileCheckout": true, "allowMobileViewFolio": true, "optedForCommunication": true } ], "servicingInfo": [ { "section": { "hotelId": "string", "code": "string", "description": "string", "sectionGroup": "string", "targetCredits": 0, "rooms": 0, "roomCredits": 0, "sequence": 0, "inactive": true }, "floor": "string", "attendantId": "string", "attendantName": "string", "hotelId": "string", "activeFlag": "string", "sunday": true, "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": true, "appUser": { "hotel": { "code": "string", "description": "string" }, "appUser": "string", "lDAPUser": "string", "actAs": "string", "actAt": "string", "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", "salesRepCode": "string", "expiryDate": "2020-08-24", "disabledUntil": "2020-08-24", "passwordChangeDate": "2020-08-24", "userInfo": { "personName": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "profileId": { "id": "string", "type": "string" }, "addressInfo": { "address": { "addressLine": [ "string" ], "cityName": "string", "postalCode": "string", "cityExtension": "string", "county": "string", "state": "string", "country": { "value": "string", "code": "string" }, "language": "string", "type": "string", "typeDescription": "string", "primaryInd": true, "updateReservations": true, "barCode": "string", "createDateTime": "2020-08-24T12:55:55.602Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.602Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "emailInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.602Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.602Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "phoneInfo": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:55:55.602Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:55:55.602Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "department": { "code": "string", "description": "string" }, "gender": "Male", "birthDate": "2020-08-24", "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-08-24", "systemDate": "2020-08-24", "terminal": "string", "runningApp": "string", "shareProfiles": true, "hotel": { "code": "string", "description": "string" }, "cro": { "code": "string", "description": "string" }, "chain": "string", "cROCountryCode": "string", "sessionDefaults": { "dbDateFormat": "string", "oracleDateFormat": "string", "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", "currencyCode": "string", "currencyFormat": "string", "defaultLanguage": "string", "baseLanguage": "string" }, "parameters": [ { "parameterName": "string", "parameterValue": "string" } ] }, "attendantInfo": { "attendantId": "string", "hotelId": "string" } }, "startTime": "2020-08-24T12:55:55.602Z", "status": "Standby" } ], "instructions": "string", "totalCredits": 0, "wakeUpTime": "2020-08-24", "cleaningSequence": 0, "defaultSequence": 0, "hasPriority": true, "maintenanceAllowed": true } ], "roomCounts": [ { "housekeepingRoomStatusType": "Clean", "totalCount": 0 } ], "linenChangeCount": 0, "sheetNumber": 0, "date": "2020-08-24", "nextDay": true, "autoGenerated": true, "lockTaskSheet": true, "taskSeqNo": 0, "roomCount": 0, "taskInstructions": "string", "completedDate": "2020-08-24", "hotelId": "string", "sheetType": "NoServiceRequired", "attendantStatus": "Standby", "breakOutId": 0 } ], "hotelId": "string", "taskDate": "2020-08-24", "taskSheetsCount": 0 } ], "links": [ { "href": "string", "rel": "string", "templated": false, "method": "GET", "targetSchema": "string", "operationId": "string", "title": "string" } ] } } }, "204": { "description": "HouseKeepingTasks not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/housekeepingDiscrepancies": { "get": { "summary": "Get hotel housekeeping discrepant rooms", "description": "Use this API to return the current housekeeping discrepant rooms for a specific property based on search parameters such as roomDiscrepancyStatus, roomClass, floor, dueOut, etc. These are rooms where the housekeeping status does not match the front office status.

OperationId:getHousekeepingDiscrepancies

", "operationId": "getHousekeepingDiscrepancies", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomDiscrepancyStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for discrepant room status instructions to be used in requests for fetching housekeeping and front office room discrepancy. Valid values are Sleep, Skip, Person Discrepancy, Due Out Only.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Sleep", "Skip", "PersonDiscrepancy" ] }, "required": false }, { "name": "fromRoomNumber", "in": "query", "required": false, "type": "string" }, { "name": "toRoomNumber", "in": "query", "required": false, "type": "string" }, { "name": "roomClass", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Room Class of the Room.", "items": { "type": "string" }, "required": false }, { "name": "housekeepingEndDate", "in": "query", "required": false, "description": "The ending value of the date range.", "type": "string", "format": "date" }, { "name": "housekeepingStartDate", "in": "query", "required": false, "description": "The starting value of the date range.", "type": "string", "format": "date" }, { "name": "floor", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "The floor of room to be fetched.", "items": { "type": "string" }, "required": false }, { "name": "dueOut", "in": "query", "required": false, "description": "List the rooms based on the flag DUE OUT for departure only.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "", "schema": { "$ref": "#/definitions/rooms" } }, "204": { "description": "HousekeepingDiscrepancies not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/housekeepingOverview": { "get": { "summary": "Get housekeeping rooms overview", "description": "Use this API to return the status of rooms for a specific property based on search criteria such as hotelId, limit, housekeepingRoomStatus, frontOfficeRoomStatus, roomAssignmentStatus, roomType, roomFeatures. The results will give you a list of rooms, and their current housekeeping details. You could then go ahead and update any of these rooms by using postOutOfOrderRoom for example.

OperationId:getHousekeepingOverview

", "operationId": "getHousekeepingOverview", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code for which Housekeeping overview needs to be fetched" }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "offset", "in": "query", "default": 0, "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "housekeepingRoomStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Clean", "Dirty", "Pickup", "Inspected", "OutOfOrder", "OutOfService" ] }, "required": false }, { "name": "frontOfficeRoomStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Vacant", "Occupied" ] }, "required": false }, { "name": "turndownStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Required", "NotRequired", "Compeleted" ] }, "required": false }, { "name": "roomParityStatus", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for room parity instructions to be used in requests for fetching housekeeping rooms. Valid status values are Odd and Even.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Odd", "Even" ] }, "required": false }, { "name": "serviceRequestStatus", "in": "query", "type": "array", "collectionFormat": "multi", "uniqueItems": true, "items": { "type": "string", "enum": [ "Open", "PendingFollowUp", "Closed", "DoNotDisturb", "MakeUpRoom" ] }, "required": false }, { "name": "roomAssignmentStatus", "in": "query", "type": "array", "collectionFormat": "multi", "uniqueItems": true, "items": { "type": "string", "enum": [ "Assigned", "Unassigned" ] }, "required": false }, { "name": "fetchInstructions", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for housekeeping instructions that can be used in requests for partial operations. When ScheduedRoomMoveInfo instruction is set to true, get only the rooms with a scheduled room move, along with the associated reservation information. When false, scheduled room move information is not included in the response. The scheduled room move information will assist housekeeping associates to prioritize rooms for cleaning.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Summary", "ResvInfo", "TurndownInfo", "ScheduedRoomMoveInfo", "ResvQueueInfo", "AttendantInRoomInfo" ] }, "required": false }, { "name": "fromRoomNumber", "in": "query", "required": false, "type": "string" }, { "name": "toRoomNumber", "in": "query", "required": false, "type": "string" }, { "name": "floor", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "The floor of room to be fetched.", "items": { "type": "string" }, "required": false }, { "name": "roomType", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Room Type of the Room.", "items": { "type": "string" }, "required": false }, { "name": "roomClass", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Room Class of the Room.", "items": { "type": "string" }, "required": false }, { "name": "building", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Building of the Room.", "items": { "type": "string" }, "required": false }, { "name": "roomFeatures", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Features of the Room.", "items": { "type": "string" }, "required": false }, { "name": "daySection", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "AM Sections of the Room.", "items": { "type": "string" }, "required": false }, { "name": "eveningSection", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "PM Sections of the Room.", "items": { "type": "string" }, "required": false }, { "name": "reservationStatus", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "The status of the reservation to which this Room is assigned.", "items": { "type": "string" }, "required": false }, { "name": "guestServiceRequest", "in": "query", "required": false, "type": "string", "description": "Possible values for the Guest Service Status.", "uniqueItems": true, "enum": [ "DoNotDisturb", "MakeUpRoom", "NoStatusSelected", "ServiceDeclined" ] }, { "name": "roomIdText", "in": "query", "required": false, "description": "Wild Card entry for Room numbers to be Fetched.", "type": "string" }, { "name": "excludeCombo", "in": "query", "required": false, "description": "Indicates we need to exclude the combo rooms while fetching the housekeeping details.", "type": "boolean" }, { "name": "cleaningPriorityOnly", "in": "query", "required": false, "description": "Determines whether fetching cleaning priority rooms only.", "type": "boolean" }, { "name": "scheduledRoomMovesOnly", "in": "query", "required": false, "description": "This flag indicates true or false. When it is set to true, get only the rooms with a scheduled room move, along with the associated reservation information. When false, scheduled room move information is not included in the response. The scheduled room move information will assist housekeeping associates to prioritize rooms for cleaning.", "type": "boolean" }, { "name": "attendantInRoomOnly", "in": "query", "required": false, "description": "Query only rooms with attendant working in them.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "", "schema": { "$ref": "#/definitions/housekeepingBoard" }, "examples": { "application/json": { "housekeepingRoomInfo": { "housekeepingRooms": { "room": [ { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDK" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" }, { "code": "OCVIEW" } ], "roomId": "112", "roomSection": { "daySectionCode": "101", "eveningSectionCode": "101" }, "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDQ" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" } ], "roomId": "114", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDQ" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" } ], "roomId": "115", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDQ" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" } ], "roomId": "116", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDQ" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" } ], "roomId": "117", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDQ" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" } ], "roomId": "118", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDQ" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" } ], "roomId": "119", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDQ" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" } ], "roomId": "120", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STDQ" }, "floor": "01,LF", "roomFeatures": [ { "code": "FTV" } ], "roomId": "121", "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "NotReserved" ], "housekeepingRoomStatus": "Dirty", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": "0", "houseKeepingPersons": "0" } } } ], "hotelId": "HOTEL1" }, "totalPages": "1", "offset": "20", "limit": "20", "hasMore": true, "totalResults": "9" } } } }, "204": { "description": "HousekeepingOverview not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/maintenances/{mainteananceId}": { "delete": { "summary": "Delete the maintenances for rooms", "description": "Use this API to delete maintenances from rooms.

OperationId:deleteRoomMaintenance

", "operationId": "deleteRoomMaintenance", "parameters": [ { "name": "mainteananceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/maintenances/{mainteananceId}/resolve": { "put": { "summary": "Resolve maintenances for rooms", "description": "Use this API to Resolve maintenances for rooms.

OperationId:resolveRoomMaintenance

", "operationId": "resolveRoomMaintenance", "parameters": [ { "name": "mainteananceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomMaintenance", "in": "body", "required": true, "description": "Request to resolve a room maintenance request.", "schema": { "allOf": [ { "$ref": "#/definitions/roomMaintenance" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/resolvedRoomMaintenance" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/maintenances/{mainteananceId}/unResolve": { "put": { "summary": "unResolve the maintenances for rooms", "description": "Use this API to unResolve maintenances for rooms.

OperationId:unResolveRoomMaintenance

", "operationId": "unResolveRoomMaintenance", "parameters": [ { "name": "mainteananceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomMaintenance", "in": "body", "required": true, "description": "Request to set unresolved status for room maintenance request.", "schema": { "allOf": [ { "$ref": "#/definitions/roomMaintenance" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/unresolvedRoomMaintenance" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/moveTaskRooms": { "put": { "summary": "Move the task rooms", "description": "This API will allow you to Move the tasksheet rooms.

OperationId:moveTaskRooms

", "operationId": "moveTaskRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "moveTaskRooms", "in": "body", "required": true, "description": "Request for moving rooms between task sheets.", "schema": { "allOf": [ { "$ref": "#/definitions/moveTaskRooms" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/movedTaskRoomsRS" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes": { "get": { "summary": "Get the guest housekeeping instructions", "description": "This API will allow you to get the guest housekeeping instructions.

OperationId:getGuestHousekeepingNotes

", "operationId": "getGuestHousekeepingNotes", "parameters": [ { "name": "reservationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "reservationIdContext", "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string" }, { "name": "reservationIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "room", "in": "query", "required": false, "description": "Room to which housekeeping record belongs.", "type": "string" }, { "name": "housekeepingInstruction", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for housekeeping instructions that can be used in requests for partial operations.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Turndown", "CleaningPriority", "ServiceRequest" ] }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Return object that contains guest housekeeping instructions for the reservation/room.", "schema": { "$ref": "#/definitions/guestHousekeepingInstructions" } }, "204": { "description": "GuestHousekeepingNotes not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "put": { "summary": "Set guest housekeeping instructions", "description": "This API will allow you to Set guest housekeeping instructions.

OperationId:setGuestHousekeepingNotes

", "operationId": "setGuestHousekeepingNotes", "parameters": [ { "name": "reservationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "guestHousekeepingServiceRequest", "in": "body", "required": true, "description": "Operation to get set guest housekeeping instructions for the room.", "schema": { "allOf": [ { "$ref": "#/definitions/guestHousekeepingServiceRequest" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/guestHousekeepingService" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules": { "get": { "summary": "Get reservation housekeeping schedule", "description": "This API will allow you to get reservation housekeeping schedule.

OperationId:getReservationHousekeepingSchedule

", "operationId": "getReservationHousekeepingSchedule", "parameters": [ { "name": "reservationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "reservationIdContext", "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string" }, { "name": "reservationIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "beginDate", "in": "query", "required": false, "description": "Begin date from which to start fetching facility tasks.", "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "description": "End date for facility task schedule request.", "type": "string", "format": "date" }, { "name": "fetchInstructions", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for controlling the fetch operations of the housekeeping schedule request.", "uniqueItems": true, "items": { "type": "string", "enum": [ "HousekeepingInstructions", "FacilitySchedule" ] }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Return object that contains a list of facility tasks for the reservation specified in RQ.", "schema": { "$ref": "#/definitions/schedule" } }, "204": { "description": "ReservationHousekeepingSchedule not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "post": { "summary": "Create reservation housekeeping tasks", "description": "This API will allow you to create reservation housekeeping tasks.

OperationId:postReservationHousekeepingTasks

", "operationId": "postReservationHousekeepingTasks", "parameters": [ { "name": "reservationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "schedule", "in": "body", "required": true, "description": "A schedule with task(s) to be created for the given reservation.", "schema": { "allOf": [ { "$ref": "#/definitions/schedule" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "put": { "summary": "Update reservation housekeeping tasks", "description": "This API will allow you to update reservation housekeeping tasks.

OperationId:editReservationHousekeepingTasks

", "operationId": "editReservationHousekeepingTasks", "parameters": [ { "name": "reservationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "schedule", "in": "body", "required": true, "description": "A schedule with task(s) to be edited for the given reservation.", "schema": { "allOf": [ { "$ref": "#/definitions/schedule" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "An updated schedule for the reservation after the edit.", "schema": { "$ref": "#/definitions/schedule" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "delete": { "summary": "Delete reservation housekeeping task", "description": "This API will allow you to delete reservation housekeeping task.

OperationId:deleteReservationHousekeepingTasks

", "operationId": "deleteReservationHousekeepingTasks", "parameters": [ { "name": "reservationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "customized", "in": "query", "required": false, "description": "Signifies whether task has been customized or not.", "type": "boolean" }, { "name": "cycleStartDay", "in": "query", "required": false, "description": "Signifies the shift of the housekeeping schedule.", "type": "integer" }, { "name": "endDate", "in": "query", "required": false, "description": "Date at which facility tasks stopped being retrieved.", "type": "string", "format": "date" }, { "name": "startDate", "in": "query", "required": false, "description": "Date at which facility tasks started being retrieved.", "type": "string", "format": "date" }, { "name": "facilityTaskCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Code of the housekeeping task.", "items": { "type": "string" }, "required": false }, { "name": "facilityTaskDescription", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Description of the housekeeping task code.", "items": { "type": "string" }, "required": false }, { "name": "facilityTaskPriority", "in": "query", "required": false, "description": "Signifies the priority of the task.", "type": "integer" }, { "name": "taskDate", "in": "query", "type": "array", "collectionFormat": "multi", "description": "A reservation date on which task must occur.", "items": { "type": "string", "format": "date" }, "required": false }, { "name": "taskStartDate", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Date on which the task needs to start being performed.", "items": { "type": "string", "format": "date" }, "required": false }, { "name": "taskEndDate", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Date on which task will stop being performed.", "items": { "type": "string", "format": "date" }, "required": false }, { "name": "stayPeriod", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for controlling the fetch operations of the housekeeping schedule request.", "uniqueItems": true, "items": { "type": "string", "enum": [ "EntireStay", "SpecificDates" ] }, "required": false }, { "name": "frequency", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Signifies frequency(i.e. every 2 days) with which task is to be performed.", "items": { "type": "integer" }, "required": false }, { "name": "taskCycleStartDay", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Signifies offset(in days) i.e. start on 3rd day from arrival.", "items": { "type": "integer" }, "required": false }, { "name": "roomType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Signifies the room type for which task is being performed .", "items": { "type": "string" }, "required": false }, { "name": "roomId", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Room number at which task is to be performed.", "items": { "type": "string" }, "required": false }, { "name": "facilityCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Facility code value.", "items": { "type": "string" }, "required": false }, { "name": "facilityCodesDescription", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Facility Code.", "items": { "type": "string" }, "required": false }, { "name": "facilityCodesQuantity", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Signifies the quantity.", "items": { "type": "integer" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/reset": { "put": { "summary": "Reset reservation housekeeping schedule", "description": "This API will allow you to reset reservation housekeeping schedule.

OperationId:resetReservationHousekeepingSchedule

", "operationId": "resetReservationHousekeepingSchedule", "parameters": [ { "name": "reservationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "scheduleSearch", "in": "body", "required": true, "description": "Request with basic information reservation needed for the reset of the schedule.", "schema": { "allOf": [ { "$ref": "#/definitions/scheduleSearch" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "An updated schedule for the reservation after the reset.", "schema": { "$ref": "#/definitions/scheduledSearch" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/shift": { "put": { "summary": "Shift reservation housekeeping schedule", "description": "This API will allow you to shift reservation housekeeping schedule.

OperationId:shiftReservationHousekeepingSchedule

", "operationId": "shiftReservationHousekeepingSchedule", "parameters": [ { "name": "reservationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "scheduleShiftRequest", "in": "body", "required": true, "description": "Request with the information needed for the shift of the schedule.", "schema": { "allOf": [ { "$ref": "#/definitions/scheduleShiftRequest" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "An updated schedule for the reservation after the shift.", "schema": { "$ref": "#/definitions/scheduledShiftRequest" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/cleaningPriority": { "delete": { "summary": "Delete room cleaning priority", "description": "This API will allow you to delete room cleaning priority.

OperationId:putRoomCleaningPriority

", "operationId": "putRoomCleaningPriority", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomId", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Collection of room numbers.", "items": { "type": "string" }, "required": true }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/maintenanceCodes/{maintenanceCode}": { "post": { "summary": "Create maintenances for rooms", "description": "Use this API to create maintenances for rooms.

OperationId:postRoomMaintenance

", "operationId": "postRoomMaintenance", "parameters": [ { "name": "maintenanceCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomMaintenanceRequest", "in": "body", "required": true, "description": "Request to create a room maintenance record.", "schema": { "allOf": [ { "$ref": "#/definitions/roomMaintenanceRequest" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/maintenances": { "get": { "summary": "Get the maintenance rooms", "description": "Use this API to get a list of rooms with maintenances.

OperationId:getRoomMaintenance

This API allows a time span of 90 days.

", "operationId": "getRoomMaintenance", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomIdText", "in": "query", "required": false, "description": "Wildcard Room filter.", "type": "string" }, { "name": "roomId", "in": "query", "required": false, "description": "Room Number filter.", "type": "string" }, { "name": "roomClasses", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomTypes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "maintenanceCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomMaintenanceStatus", "in": "query", "required": false, "type": "string", "description": "Room Maintenance Status.", "uniqueItems": true, "enum": [ "All", "UnResolved", "Resolved" ] }, { "name": "assignedUserId", "in": "query", "type": "array", "collectionFormat": "multi", "description": "A 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.", "items": { "type": "string" }, "required": false }, { "name": "assignedUserIdContext", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, "required": false }, { "name": "assignedUserIdType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, "required": false }, { "name": "maintenanceId", "in": "query", "required": false, "description": "A 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.", "type": "string" }, { "name": "maintenanceIdContext", "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string" }, { "name": "maintenanceIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "resolvedEndDate", "in": "query", "required": false, "description": "The ending value of the date range.", "type": "string", "format": "date" }, { "name": "resolvedStartDate", "in": "query", "required": false, "description": "The starting value of the date range.", "type": "string", "format": "date" }, { "name": "includeImages", "in": "query", "required": false, "description": "Indicator that tells whether to include Images in search results.", "type": "boolean" }, { "name": "frontOfficeRoomStatus", "in": "query", "description": "Simple type for front office room status instructions to be used in requests for fetching room maintenance records. Valid values are Vacant and Occupied.", "uniqueItems": true, "type": "string", "required": false, "enum": [ "Vacant", "Occupied" ] }, { "name": "expectedByDate", "in": "query", "required": false, "description": "The date the room maintenance record is expected to be resolved.", "type": "string", "format": "date" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for the Fetch Room Maintenance request.", "schema": { "$ref": "#/definitions/roomMaintenanceDetails" } }, "204": { "description": "RoomMaintenance not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/outOfOrderRooms": { "get": { "summary": "Get Out of Order Rooms", "description": "Use this API to get a list of rooms for a hotel that are Out of Order. You can narrow down your results with search criteria such as Room class, Room Type, date range.

OperationId:getOutOfOrderRooms

This API allows a time span of 90 days.

", "operationId": "getOutOfOrderRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code for which Out Of Order rooms needs to be fetched." }, { "name": "startDate", "in": "query", "required": true, "description": "The start date for which the out of order / out of service rooms are to be fetched.", "type": "string", "format": "date" }, { "name": "roomId", "in": "query", "required": false, "description": "Room number to be Fetched.", "type": "string" }, { "name": "endDate", "in": "query", "required": false, "description": "The end date for which the out of order / out of service rooms are to be fetched.", "type": "string", "format": "date" }, { "name": "roomTypes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "The room type of out of order / out of service rooms to be fetched.", "items": { "type": "string" }, "required": false }, { "name": "roomClasses", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false, "description": "The room class of out of order / out of service rooms to be fetched." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "", "schema": { "$ref": "#/definitions/rooms" }, "examples": { "application/json": { "housekeepingRooms": { "room": [ { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "DLX" }, "roomId": "1016", "housekeeping": { "housekeepingRoomStatus": { "housekeepingRoomStatus": "OutOfOrder", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" } }, "outOfOrder": [ { "returnStatus": "Inspected", "reasonCode": "WIN", "reasonDescription": "Window Cleaning", "newDateRange": { "start": "2020-07-15", "end": "2020-07-15" }, "housekeepingRoomStatus": "OutOfOrder", "start": "2020-07-15", "end": "2020-07-15" } ] }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "DLX" }, "roomId": "1185", "housekeeping": { "housekeepingRoomStatus": { "housekeepingRoomStatus": "OutOfOrder", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" } }, "outOfOrder": [ { "returnStatus": "Inspected", "reasonCode": "AC", "reasonDescription": "Air Conditioning Issue", "newDateRange": { "start": "2020-07-15", "end": "2020-07-15" }, "housekeepingRoomStatus": "OutOfOrder", "start": "2020-07-15", "end": "2020-07-15" } ] }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STD" }, "roomId": "2004", "housekeeping": { "housekeepingRoomStatus": { "housekeepingRoomStatus": "OutOfOrder", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" } }, "outOfOrder": [ { "returnStatus": "Inspected", "reasonCode": "AC", "reasonDescription": "Air Conditioning Issue", "newDateRange": { "start": "2020-07-15", "end": "2020-07-15" }, "housekeepingRoomStatus": "OutOfOrder", "start": "2020-07-15", "end": "2020-07-15" } ] } ], "hotelId": "HOTEL1" } } } }, "204": { "description": "OutOfOrderRooms not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "put": { "summary": "Complete rooms Out Of Order", "description": "Use this API when one or more rooms are no longer Out Of Order, and can now be available for a guest to stay in. Specify in the request what status the room(s) should be returned to, such as clean, Inspected, dirty or Pickup.

OperationId:completeOutOfOrderRooms

", "operationId": "completeOutOfOrderRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code for which Out Of Order rooms needs to be returned to Clean, Inspected, Dirty or Pickup status." }, { "name": "completeRoomRepair", "in": "body", "required": true, "schema": { "allOf": [ { "$ref": "#/definitions/completeRoomRepair" }, { "example": { "criteria": { "roomRepairByRoomNumber": [ { "roomId": "001", "roomOutOfOrder": { "repairRemarks": "Fixed issue in shower", "returnStatus": "Clean", "reasonCode": "SHOWER", "reasonDescription": "Shower not working well", "newDateRange": { "start": "2020-10-01", "end": "2020-10-01" }, "start": "2020-10-01", "end": "2020-12-31" } } ], "roomRangeList": { "roomIds": [ "001" ], "range": { "roomRange": { "fromRoomNumber": "001", "toRoomNumber": "001" } }, "roomOutOfOrder": { "repairRemarks": "Fixed issue in shower", "returnStatus": "OutOfOrder", "reasonCode": "SHOWER", "reasonDescription": "Shower not working well", "newDateRange": { "start": "2020-10-01", "end": "2020-10-01" }, "start": "2020-10-01", "end": "2020-12-31" } } } } } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/completeRoomRepairStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "post": { "summary": "Set multiple rooms to Out Of Order", "description": "This API allows you to initially set rooms to 'Out Of Order' housekeeping status and update existing outOfOrderRooms.

OperationId:postOutOfOrderRooms

", "operationId": "postOutOfOrderRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code of Room(s) which is to be set as Out Of Order." }, { "name": "roomRepairOutOfOrder", "in": "body", "required": true, "schema": { "allOf": [ { "$ref": "#/definitions/roomRepairOutOfOrder" }, { "example": { "criteria": { "roomRangeList": { "roomIds": [ "1011", "1015" ], "roomOutOfOrder": { "repairRemarks": "Windows now fixed By John", "returnStatus": "PickUP", "reasonCode": "WIN", "reasonDescription": "Resolved", "newDateRange": { "start": "2020-11-30", "end": "2020-11-30" }, "start": "2020-11-30", "end": "2020-11-30" } } } } } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/outOfServiceRooms": { "put": { "summary": "Complete Rooms Out of Service", "description": "Use this API when one or more rooms are no longer Out Of Service, and can now be available for a guest to stay in. Specify in the request what status the room(s) should be returned to, such as clean, Inspected, dirty or Pickup.

OperationId:completeOutOfServiceRooms

", "operationId": "completeOutOfServiceRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code for which Out Of Service rooms needs to be returned to Clean, Inspected, Dirty or Pickup status." }, { "name": "completeRoomRepair", "in": "body", "required": true, "schema": { "allOf": [ { "$ref": "#/definitions/completeRoomRepair" }, { "example": { "criteria": { "roomRepairByRoomNumber": [ { "roomId": "2011", "roomOutOfOrder": { "repairRemarks": "test", "returnStatus": "Clean", "reasonCode": "PLUMB", "reasonDescription": "Plumbing Issue", "newDateRange": { "start": "2020-12-05", "end": "2020-12-05" }, "start": "2020-12-05", "end": "2020-12-10" } }, { "roomId": "2012", "roomOutOfOrder": { "repairRemarks": "test", "returnStatus": "Clean", "reasonCode": "PLUMB", "reasonDescription": "Plumbing Issue", "newDateRange": { "start": "2020-12-05", "end": "2020-12-05" }, "start": "2020-12-05", "end": "2020-12-10" } } ], "roomRangeList": { "roomIds": [ "2011", "2012" ], "range": { "roomRange": { "fromRoomNumber": "2011", "toRoomNumber": "2012" } }, "roomOutOfOrder": { "repairRemarks": "test", "returnStatus": "OutOfOrder", "reasonCode": "PLUMB", "reasonDescription": "Plumbing Issue", "newDateRange": { "start": "2020-12-05", "end": "2020-12-05" }, "start": "2020-12-05", "end": "2020-12-10" } } } } } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/completeRoomRepairStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "get": { "summary": "Get Out of Service Rooms", "description": "Use this API to get a list of rooms for a hotel that are Out of Service. You can narrow down your results with search criteria such as Room class, Room Type, date range.

OperationId:getOutOfServiceRooms

This API allows a time span of 90 days.

", "operationId": "getOutOfServiceRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code for which Out Of Service rooms needs to be fetched." }, { "name": "startDate", "in": "query", "required": true, "description": "The start date for which the out of order / out of service rooms are to be fetched.", "type": "string", "format": "date" }, { "name": "roomId", "in": "query", "required": false, "description": "Room number to be Fetched.", "type": "string" }, { "name": "endDate", "in": "query", "required": false, "description": "The end date for which the out of order / out of service rooms are to be fetched.", "type": "string", "format": "date" }, { "name": "roomTypes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "The room type of out of order / out of service rooms to be fetched.", "items": { "type": "string" }, "required": false }, { "name": "roomClasses", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false, "description": "The room class of out of order / out of service rooms to be fetched." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "", "schema": { "$ref": "#/definitions/rooms" }, "examples": { "application/json": { "housekeepingRooms": { "room": [ { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "DLX" }, "roomId": "1017", "housekeeping": { "housekeepingRoomStatus": { "housekeepingRoomStatus": "OutOfService", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" } }, "outOfOrder": [ { "returnStatus": "Inspected", "reasonCode": "PLUMB", "reasonDescription": "Plumbing Issue", "newDateRange": { "start": "2020-07-15", "end": "2020-07-15" }, "housekeepingRoomStatus": "OutOfService", "start": "2020-07-15", "end": "2020-07-17" } ] }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "DLX" }, "roomId": "1033", "housekeeping": { "housekeepingRoomStatus": { "housekeepingRoomStatus": "OutOfService", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" } }, "outOfOrder": [ { "returnStatus": "Inspected", "reasonCode": "WIN", "reasonDescription": "Window Cleaning", "newDateRange": { "start": "2020-07-15", "end": "2020-07-15" }, "housekeepingRoomStatus": "OutOfService", "start": "2020-07-15", "end": "2020-07-15" } ] }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "DLX" }, "roomId": "1039", "housekeeping": { "housekeepingRoomStatus": { "housekeepingRoomStatus": "OutOfService", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" } }, "outOfOrder": [ { "returnStatus": "Inspected", "reasonCode": "WIN", "reasonDescription": "Window Cleaning", "newDateRange": { "start": "2020-07-15", "end": "2020-07-15" }, "housekeepingRoomStatus": "OutOfService", "start": "2020-07-15", "end": "2020-07-15" } ] }, { "roomType": { "pseudoRoom": false, "roomClass": "ALL", "roomType": "STD" }, "roomId": "2001", "housekeeping": { "housekeepingRoomStatus": { "housekeepingRoomStatus": "OutOfService", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" } }, "outOfOrder": [ { "returnStatus": "Inspected", "reasonCode": "WIN", "reasonDescription": "Window Cleaning", "newDateRange": { "start": "2020-07-15", "end": "2020-07-15" }, "housekeepingRoomStatus": "OutOfService", "start": "2020-07-15", "end": "2020-07-16" } ] } ], "hotelId": "HOTEL1" } } } }, "204": { "description": "OutOfServiceRooms not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "post": { "summary": "Set multiple rooms to Out Of Service", "description": "This API allows you to initially set rooms to 'Out Of Service' housekeeping status and update existing outOfServiceRooms.

OperationId:postOutOfServiceRooms

", "operationId": "postOutOfServiceRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code of Room(s) which is to be set as Out Of Service." }, { "name": "roomRepairOutOfService", "in": "body", "required": true, "schema": { "allOf": [ { "$ref": "#/definitions/roomRepairOutOfService" }, { "example": { "criteria": { "roomRangeList": { "roomIds": [ "1008", "1017" ], "roomOutOfOrder": { "repairRemarks": "HHPRT5665", "returnStatus": "Clean", "reasonCode": "WIN", "reasonDescription": "clean", "newDateRange": { "start": "2020-07-27", "end": "2020-07-27" }, "start": "2020-07-27", "end": "2020-07-27" } } } } } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/status": { "put": { "summary": "Update Housekeeping Room Status", "description": "Use this API to update the housekeeping room status for multiple rooms. Statuses typically include Inspected, Clean, Pickup or Dirty.

OperationId:putRoomRelatedStatus

", "operationId": "putRoomRelatedStatus", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code for which housekeeping room status, housekeeping status or turndown status have to be modified" }, { "name": "housekeepingRoomStatusCriteria", "in": "body", "required": true, "schema": { "allOf": [ { "$ref": "#/definitions/housekeepingRoomStatusCriteria" }, { "example": { "roomList": [ { "roomId": "112" }, { "roomId": "114" } ], "housekeepingStatus": "Vacant", "housekeepingRoomStatus": "Clean" } } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/housekeepingRoomStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/{roomId}/cleaningPriority": { "put": { "summary": "Set the room cleaning priority", "description": "This API will allow you to set the room cleaning priority.

OperationId:setRoomCleaningPriority

", "operationId": "setRoomCleaningPriority", "parameters": [ { "name": "roomId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomCleaningPriority", "in": "body", "required": true, "description": "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.", "schema": { "allOf": [ { "$ref": "#/definitions/roomCleaningPriority" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/roomCleaningPriorityRequestStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/{roomId}/maintenances/{maintenanceId}": { "put": { "summary": "Change maintenances for rooms", "description": "Use this API to change the maintenances for rooms.

OperationId:putRoomMaintenance

", "operationId": "putRoomMaintenance", "parameters": [ { "name": "maintenanceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomMaintenance", "in": "body", "required": true, "description": "Request to change room maintenance details.", "schema": { "allOf": [ { "$ref": "#/definitions/roomMaintenance" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/changedRoomMaintenance" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}": { "put": { "summary": "Cancel servicing task room", "description": "This API will allow you to cancel servicing task room.

OperationId:cancelServicingTaskRoom

", "operationId": "cancelServicingTaskRoom", "parameters": [ { "name": "sheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskRoom", "in": "body", "required": true, "description": "Request to cancel the servicing of a task room.", "schema": { "allOf": [ { "$ref": "#/definitions/taskRoom" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/canceledServicingTaskRoom" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/complete": { "put": { "summary": "Complete servicing task room", "description": "This API will allow you to complete servicing task room.

OperationId:completeServicingTaskRoom

", "operationId": "completeServicingTaskRoom", "parameters": [ { "name": "sheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskRoom", "in": "body", "required": true, "description": "Request to complete servicing of a task room. This will complete the servicing and set the end time and status to COMPLETED.", "schema": { "allOf": [ { "$ref": "#/definitions/taskRoom" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/completedServicingTaskRoom" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/skip": { "put": { "summary": "Skip servicing task room", "description": "This API will allow you to Skip servicing task room.

OperationId:skipServicingTaskRoom

", "operationId": "skipServicingTaskRoom", "parameters": [ { "name": "sheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskRoom", "in": "body", "required": true, "description": "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 the room.", "schema": { "allOf": [ { "$ref": "#/definitions/taskRoom" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/skipedServicingTaskRoom" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/start": { "put": { "summary": "Start servicing task room", "description": "This API will allow you to start servicing task room.

OperationId:startServicingTaskRoom

", "operationId": "startServicingTaskRoom", "parameters": [ { "name": "sheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "roomId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskRoom", "in": "body", "required": true, "description": "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 the room.", "schema": { "allOf": [ { "$ref": "#/definitions/taskRoom" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response type for the start task room service. Can contain errors or warnings.", "schema": { "$ref": "#/definitions/serviceTime" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/schedules/houseKeepingTasks": { "post": { "summary": "Create housekeeping attendant schedule", "description": "This API will allow you to create housekeeping attendant schedule.

OperationId:postHousekeepingAttendantSchedule

", "operationId": "postHousekeepingAttendantSchedule", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "attendantSchedule", "in": "body", "required": true, "description": "Request for creating the attendant schedule.", "schema": { "allOf": [ { "$ref": "#/definitions/attendantSchedule" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/serviceRequests": { "put": { "summary": "Set the Guest housekeeping service requests", "description": "This API allows you to Set the guest housekeeping service requests

OperationId:setGuestHousekeepingServiceRequest

", "operationId": "setGuestHousekeepingServiceRequest", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "guestHousekeepingServiceRequestCriteria", "in": "body", "required": true, "description": "Operation to set the Guest Service status of an occupied room. The service status can be Do Not Disturb or Make Up Room.", "schema": { "allOf": [ { "$ref": "#/definitions/guestHousekeepingServiceRequestCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/guestHousekeepingServiceRequestStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/sheets/{sheetNumber}": { "get": { "summary": "Get task companion", "description": "This API allows you to get task companion.

OperationId:getTaskCompanion

", "operationId": "getTaskCompanion", "parameters": [ { "name": "sheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": true }, { "name": "taskDate", "in": "query", "required": false, "description": "Date for which the task sheet was created. By default this would be the current business date.", "type": "string", "format": "date" }, { "name": "roomId", "in": "query", "required": false, "description": "Choice to search by a room number if a particular room is required.", "type": "string" }, { "name": "skipRoomNumbers", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Room number that should be skipped.", "items": { "type": "string" }, "required": false }, { "name": "roomStatusToChange", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Clean", "Dirty", "Pickup", "Inspected", "OutOfOrder", "OutOfService" ] }, "required": false }, { "name": "includeScheduledRoomDetails", "in": "query", "required": false, "description": "Set this to true to include reservation information associated with any scheduled room moves. Available when the Advanced Daily Details OPERA Control is active.", "type": "boolean" }, { "name": "includeRoomMaintenanceDetails", "in": "query", "required": false, "description": "Set this to true to include maintenance details associated with a room. Available when the Maintenance OPERA Control is active.", "type": "boolean" }, { "name": "includeQueueDetails", "in": "query", "required": false, "description": "Set this to true to include Queue details associated with any reservations assigned to the room. Available when the Queue OPERA Control is active.", "type": "boolean" }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "offset", "in": "query", "default": 0, "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "taskSheetRoomsOnly", "in": "query", "default": 0, "required": false, "description": "Flag to indicate whether to include only tasksheet rooms only in the response.", "type": "boolean" }, { "name": "includeCompletedRooms", "in": "query", "required": false, "description": "If true, the list of rooms returned will include rooms that have been completed and have the highest cleaning status. If false, only rooms that have not yet reached the highest cleaning status will be returned.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "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 details of the rooms current status and reservations for the room, if any.", "schema": { "$ref": "#/definitions/taskCompanion" }, "examples": { "application/json": { "taskRoom": { "taskCodes": [ { "description": "string", "instructions": "string", "facilityDepartureTask": true, "linenChange": true, "hotelId": "string", "code": "string", "sequence": 0 } ], "departureTaskInfo": { "roomType": [ { "facilityCode": [ { "description": "string", "quantity": 0, "code": "string" } ], "type": "string" } ], "code": "string" }, "totalSupplies": [ { "description": "string", "quantity": 0, "code": "string" } ], "credits": [ { "type": "Departure", "numberOfCredits": 0 } ], "attendant": { "section": { "hotelId": "string", "code": "string", "description": "string", "sectionGroup": "string", "targetCredits": 0, "rooms": 0, "roomCredits": 0, "sequence": 0, "inactive": true }, "floor": "string", "attendantId": "string", "attendantName": "string", "hotelId": "string", "activeFlag": "string", "sunday": true, "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": true, "attendantInstructions": "string" }, "appUserOnBreak": { "appUser": { "hotel": { "code": "string", "description": "string" }, "appUser": "string", "lDAPUser": "string", "actAs": "string", "actAt": "string", "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", "salesRepCode": "string", "expiryDate": "2020-08-24", "disabledUntil": "2020-08-24", "passwordChangeDate": "2020-08-24", "userInfo": { "personName": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "profileId": { "id": "string", "type": "string" }, "addressInfo": { "address": { "addressLine": [ "string" ], "cityName": "string", "postalCode": "string", "cityExtension": "string", "county": "string", "state": "string", "country": { "value": "string", "code": "string" }, "language": "string", "type": "string", "typeDescription": "string", "primaryInd": true, "updateReservations": true, "barCode": "string", "createDateTime": "2020-08-24T12:59:04.823Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.823Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "emailInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.824Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.824Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "phoneInfo": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.824Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.824Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "department": { "code": "string", "description": "string" }, "gender": "Male", "birthDate": "2020-08-24", "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-08-24", "systemDate": "2020-08-24", "terminal": "string", "runningApp": "string", "shareProfiles": true, "hotel": { "code": "string", "description": "string" }, "cro": { "code": "string", "description": "string" }, "chain": "string", "cROCountryCode": "string", "sessionDefaults": { "dbDateFormat": "string", "oracleDateFormat": "string", "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", "currencyCode": "string", "currencyFormat": "string", "defaultLanguage": "string", "baseLanguage": "string" }, "parameters": [ { "parameterName": "string", "parameterValue": "string" } ] }, "attendantInfo": { "attendantId": "string", "hotelId": "string" } }, "startTime": "2020-08-24T12:59:04.824Z" }, "rooms": [ { "roomType": { "pseudoRoom": true, "isSuiteRoom": true, "roomClass": "string", "shortDescription": "string", "houseKeeping": true, "smokingPreference": "string", "minimumOccupancy": 0, "maximumOccupancy": 0, "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "isAccessible": true, "roomType": "string", "meetingRoom": true }, "floor": "string", "floorDescription": "string", "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "roomDescription": "string", "description": { "defaultText": "string", "translatedTexts": [ { "value": "string", "language": "string" } ] }, "smokingPreference": "string", "smokingPreferenceDescription": "string", "building": "string", "roomAssignmentRating": "MostImportant", "roomNumber": "string", "roomSection": { "daySectionCode": "string", "eveningSectionCode": "string" }, "housekeeping": { "housekeepingRoomStatus": { "reservationStatusList": [ "Arrival" ], "housekeepingRoomStatus": "Clean", "frontOfficeStatus": "Vacant", "housekeepingStatus": "Vacant" }, "roomPersons": { "frontOfficePersons": 0, "houseKeepingPersons": 0 }, "guestServiceRequest": "DoNotDisturb", "cleaningPriority": { "prioritySequence": 0 }, "roomCondition": { "roomCondition": { "code": "string", "description": "string" }, "assignmentType": "Available", "remarks": "string" }, "linenChange": true, "facilityTaskCode": [ "string" ] }, "outOfOrder": [ { "repairRemarks": "string", "returnStatus": "Clean", "reasonCode": "string", "reasonDescription": "string", "newDateRange": { "start": "2020-08-24", "end": "2020-08-24" }, "housekeepingRoomStatus": "Clean", "start": "2020-08-24", "end": "2020-08-24" } ], "discrepancy": [ "Sleep" ], "sitePlanSection": { "sectionCode": "string", "sectionType": "string", "linkCode": "string", "coordinates": "string", "description": "string" }, "componentRoomNumber": "string", "connectingRooms": [ { "roomType": { "pseudoRoom": true, "isSuiteRoom": true, "roomClass": "string", "shortDescription": "string", "houseKeeping": true, "smokingPreference": "string", "minimumOccupancy": 0, "maximumOccupancy": 0, "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "isAccessible": true, "roomType": "string", "meetingRoom": true }, "floor": "string", "floorDescription": "string", "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "roomDescription": "string", "description": { "defaultText": "string", "translatedTexts": [ { "value": "string", "language": "string" } ] }, "smokingPreference": "string", "smokingPreferenceDescription": "string", "building": "string", "roomAssignmentRating": "MostImportant", "isAccessible": true, "roomId": "string", "meetingRoom": true, "roomCondition": { "code": "string", "description": "string" } } ], "componentRooms": [ { "roomType": { "pseudoRoom": true, "isSuiteRoom": true, "roomClass": "string", "shortDescription": "string", "houseKeeping": true, "smokingPreference": "string", "minimumOccupancy": 0, "maximumOccupancy": 0, "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "isAccessible": true, "roomType": "string", "meetingRoom": true }, "floor": "string", "floorDescription": "string", "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "roomDescription": "string", "description": { "defaultText": "string", "translatedTexts": [ { "value": "string", "language": "string" } ] }, "smokingPreference": "string", "smokingPreferenceDescription": "string", "building": "string", "roomAssignmentRating": "MostImportant", "isAccessible": true, "roomId": "string", "meetingRoom": true, "roomCondition": { "code": "string", "description": "string" } } ], "attendant": [ { "section": { "hotelId": "string", "code": "string", "description": "string", "sectionGroup": "string", "targetCredits": 0, "rooms": 0, "roomCredits": 0, "sequence": 0, "inactive": true }, "floor": "string", "attendantId": "string", "attendantName": "string", "hotelId": "string", "activeFlag": "string", "sunday": true, "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": true, "appUser": { "hotel": { "code": "string", "description": "string" }, "appUser": "string", "lDAPUser": "string", "actAs": "string", "actAt": "string", "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", "salesRepCode": "string", "expiryDate": "2020-08-24", "disabledUntil": "2020-08-24", "passwordChangeDate": "2020-08-24", "userInfo": { "personName": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "profileId": { "id": "string", "type": "string" }, "addressInfo": { "address": { "addressLine": [ "string" ], "cityName": "string", "postalCode": "string", "cityExtension": "string", "county": "string", "state": "string", "country": { "value": "string", "code": "string" }, "language": "string", "type": "string", "typeDescription": "string", "primaryInd": true, "updateReservations": true, "barCode": "string", "createDateTime": "2020-08-24T12:59:04.825Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.825Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "emailInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.825Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.825Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "phoneInfo": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.825Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.825Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "department": { "code": "string", "description": "string" }, "gender": "Male", "birthDate": "2020-08-24", "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-08-24", "systemDate": "2020-08-24", "terminal": "string", "runningApp": "string", "shareProfiles": true, "hotel": { "code": "string", "description": "string" }, "cro": { "code": "string", "description": "string" }, "chain": "string", "cROCountryCode": "string", "sessionDefaults": { "dbDateFormat": "string", "oracleDateFormat": "string", "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", "currencyCode": "string", "currencyFormat": "string", "defaultLanguage": "string", "baseLanguage": "string" }, "parameters": [ { "parameterName": "string", "parameterValue": "string" } ] }, "attendantInfo": { "attendantId": "string", "hotelId": "string" } }, "startTime": "2020-08-24T12:59:04.825Z", "status": "Standby" } ], "hold": { "holdUntil": "2020-08-24T12:59:04.825Z", "holdUser": "string", "comments": "string" }, "turndownInfo": { "turndownStatusInfo": "Required" }, "resvInfo": [ { "guestName": "string", "reservationId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "reservationStatusInfo": "Arrival", "stayDateInfo": { "timeSpan": { "startDate": "2020-08-24", "endDate": "2020-08-24", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-08-24T12:59:04.825Z", "reservationExpectedDepartureTime": "2020-08-24T12:59:04.825Z" } }, "vipStatus": { "value": "string", "code": "string" }, "profileId": { "id": "string", "type": "string" } } ], "reservationInfo": [ { "reservationIdList": [ { "id": "string", "type": "string" } ], "roomStay": { "arrivalDate": "2020-08-24", "departureDate": "2020-08-24", "originalTimeSpan": { "startDate": "2020-08-24", "endDate": "2020-08-24", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-08-24T12:59:04.825Z", "reservationExpectedDepartureTime": "2020-08-24T12:59:04.825Z" }, "adultCount": 0, "childCount": 0, "roomClass": "string", "roomType": "string", "numberOfRooms": 0, "roomNumber": "string", "ratePlanCode": "string", "rateAmount": { "amount": 0, "currencyCode": "string" }, "points": { "awardsType": "string", "points": 0 }, "rateSuppressed": true, "reservationBlock": { "blockIdList": [ { "id": "string", "type": "string" } ], "blockName": "string", "hotelId": "string" }, "bookingChannelCode": "string", "partyCode": "string", "fixedRate": true, "totalAmount": { "amount": 0, "currencyCode": "string" }, "guarantee": { "guaranteeCode": "string", "shortDescription": "string", "onHold": true }, "promotion": { "promotionCode": "string", "promotionName": "string", "couponCode": "string" }, "marketCode": "string", "sourceOfBusiness": "string", "sourceOfBusinessDescription": "string", "balance": { "amount": 0, "currencyCode": "string" }, "compBalance": { "amount": 0, "currencyCode": "string" }, "roomTypeCharged": "string", "depositPayments": { "amount": 0, "currencyCode": "string" }, "guestServiceStatus": "DoNotDisturb", "scheduledCheckoutTime": "2020-08-24", "roomNumberLocked": true, "pseudoRoom": true }, "reservationGuest": { "membership": { "membershipId": 0, "programCode": "string", "bonusCode": "string", "membershipTypeDesc": "string", "membershipLevelDesc": "string", "accountId": "string", "membershipLevel": "string", "playerRanking": 0 }, "namePrefix": "string", "givenName": "string", "alternateGivenName": "string", "middleName": "string", "surnamePrefix": "string", "surname": "string", "alternateSurname": "string", "nameSuffix": "string", "nameTitle": "string", "fullName": "string", "alternateFullName": "string", "phoneNumber": "string", "email": "string", "birthDate": "2020-08-24", "language": "string", "nationality": { "value": "string", "code": "string" }, "vip": { "vipCode": "string", "vipDescription": "string" }, "address": { "cityName": "string", "postalCode": "string", "state": "string", "country": { "value": "string", "code": "string" }, "streetAddress": "string", "excludeNoCity": true }, "anonymization": { "anonymizationStatus": "Requested", "anonymizationDate": "2020-08-24T12:59:04.826Z" }, "accompanyGuests": [ { "firstName": "string", "lastName": "string", "fullName": "string", "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } ] } ], "externalInfo": { "givenName": "string", "surname": "string" }, "guestLastStayInfo": { "lastStayDate": "2020-08-24", "lastStayRoom": "string", "lastStayRate": { "amount": 0, "currencyCode": "string" }, "totalStay": 0 }, "guestRestrictedCode": "string", "guestRestrictedReasonDesc": "string", "guestRestricted": true, "registrationCardNo": "string", "nameType": "Guest", "id": "string", "type": "string" }, "sharedGuests": [ { "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "firstName": "string", "lastName": "string", "fullName": "string" } ], "attachedProfiles": [ { "name": "string", "profileIdList": [ { "id": "string", "type": "string" } ], "reservationProfileType": "Company" } ], "reservationPaymentMethod": { "paymentCard": { "cardId": { "id": "string", "type": "string" }, "currentAuthorizedAmount": { "amount": 0, "currencyCode": "string" }, "approvalAmountNeeded": { "amount": 0, "currencyCode": "string" }, "cardType": "Ab", "userDefinedCardType": "string", "cardNumber": "string", "cardNumberMasked": "string", "cardNumberLast4Digits": "string", "expirationDate": "2020-08-24", "expirationDateMasked": "string", "expirationDateExpired": true, "cardHolderName": "string", "attachCreditCardToProfile": true, "processing": "Eft", "swiped": true, "cardOrToken": "CardNumber" }, "balance": { "amount": 0, "currencyCode": "string" }, "authorizationRule": { "code": 0, "amount": { "amount": 0, "currencyCode": "string" }, "percent": 0 }, "emailFolioInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.826Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.826Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "emailFolio": true, "id": "string", "type": "string" }, "paymentMethod": "string", "description": "string", "folioView": 0 }, "reservationFolioWindows": [ { "payeeInfo": { "payeeId": { "id": "string", "type": "string" }, "payeeName": "string", "payeeAddress": { "address": { "addressLine": [ "string" ], "cityName": "string", "postalCode": "string", "cityExtension": "string", "county": "string", "state": "string", "country": { "value": "string", "code": "string" }, "language": "string", "type": "string", "typeDescription": "string", "primaryInd": true, "updateReservations": true, "barCode": "string", "createDateTime": "2020-08-24T12:59:04.826Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.826Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "payeeAddressCount": 0, "payeeReferenceCurrency": "string", "payeeAccountInfo": { "accountName": "string", "accountId": { "id": "string", "type": "string" }, "accountNo": "string", "status": { "restriction": "string", "description": "string", "restricted": true } }, "payeeTaxNumber": "string" }, "balance": { "amount": 0, "currencyCode": "string" }, "paymentMethod": "string", "folioWindowNo": 0 } ], "specials": "string", "lastPrivacyPromptDate": "2020-08-24", "displayColor": "string", "reservationIndicators": [ { "indicatorName": "string", "count": 0 } ], "housekeepingRoomStatus": "Clean", "searchMatches": [ { "attribute": "string", "value": "string" } ], "sourceOfSale": { "sourceType": "string", "sourceCode": "string" }, "waitlist": { "reasonDescription": "string", "priorityDescription": "string", "description": "string", "reasonCode": "string", "priorityCode": "string", "telephone": "string" }, "queue": { "timeSpan": { "startDate": "2020-08-24", "endDate": "2020-08-24", "duration": "string", "durationInSeconds": 0 }, "guestTextInfo": { "sentTime": "2020-08-24T12:59:04.826Z", "sentBy": "string" }, "priority": 0, "averageQueueTimeToCheckIn": 0, "averageQueueTimeCurrentReservations": 0, "queueDate": "2020-08-24" }, "housekeeping": { "instructions": "string", "facilityTaskInfo": { "task": { "description": "string", "instructions": "string", "facilityDepartureTask": true, "linenChange": true, "hotelId": "string", "code": "string", "sequence": 0 }, "supplies": [ { "description": "string", "quantity": 0, "code": "string" } ], "date": "2020-08-24" }, "linenChange": true, "turndownRequested": true, "serviceTime": "2020-08-24", "expectedServiceTime": "string", "housekeepingRoomStatus": "Clean" }, "cashiering": { "revenuesAndBalances": { "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, "totalPayment": { "amount": 0, "currencyCode": "string" }, "roomRevenue": { "amount": 0, "currencyCode": "string" }, "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, "otherRevenue": { "amount": 0, "currencyCode": "string" }, "nonRevenue": { "amount": 0, "currencyCode": "string" }, "totalRevenue": { "amount": 0, "currencyCode": "string" }, "balance": { "amount": 0, "currencyCode": "string" } }, "billingPrivileges": { "postingRestriction": true, "preStayCharging": true, "postStayCharging": true, "folioCloseDate": "2020-08-24", "scheduledCheckout": true, "scheduledCheckoutTime": "2020-08-24", "directBillAuthorized": true, "videoCheckout": true, "allowAutoCheckin": true, "autoSettlement": true, "autoSettlementType": "string", "autoSettlementFreq": 0, "creditLimitAutoPay": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0, "taxExemptNo": "string" }, "bedTaxReporting": { "taxRegistrationNo": 0, "visaNumber": "string", "visaIssueDate": "2020-08-24", "visaExpiryDate": "2020-08-24", "taxableDays": 0 }, "folioTexts": [ { "text": "string", "row": 0 } ], "periodicFolio": { "lastSettlementDate": "2020-08-24", "lastFolioDate": "2020-08-24", "frequency": 0 }, "compAccounting": { "compType": "string", "authorizer": "string", "compPostings": "string" }, "reservationPreConfiguredRoutingInstruction": { "authorizerInfo": { "authorizerId": { "id": "string", "type": "string" }, "authorizerUserName": "string", "authorizerName": "string", "authorizerRateCode": "string", "inheritAuthorizerRateCode": true }, "ratePlanCode": "string", "profileType": "Company", "promotionCode": "string" }, "financiallyResponsible": true, "proratedBilling": true, "lastRoomAndTaxPostedDate": "2020-08-24", "reverseCheckInAllowed": true, "reverseAdvanceCheckInAllowed": true, "transactionsPosted": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0 }, "deposit": { "amountRequired": 0, "amountPaid": 0, "amountOwed": 0, "dueDate": "2020-08-24", "postingDate": "2020-08-24", "hasPaid": true, "hasOutstanding": true }, "allowedActions": [ "Cancel" ], "revenuesAndBalances": { "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, "totalPayment": { "amount": 0, "currencyCode": "string" }, "roomRevenue": { "amount": 0, "currencyCode": "string" }, "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, "otherRevenue": { "amount": 0, "currencyCode": "string" }, "nonRevenue": { "amount": 0, "currencyCode": "string" }, "totalRevenue": { "amount": 0, "currencyCode": "string" }, "balance": { "amount": 0, "currencyCode": "string" } }, "hotelInterfaceStatusList": [ { "roomExtension": "string", "hotelInterface": { "interfaceId": { "id": "string", "type": "string" }, "hotelId": "string", "interfaceName": "string", "interfaceType": "Bms", "logo": "string", "machineName": "string", "status": "Stopped", "activeFlag": true }, "interfaceRights": [ { "right": 0, "statusCode": "string", "description": "string", "category": "string" } ] } ], "guestPreferredCurrency": "string", "turndownInfo": { "allowed": true, "status": "Required" }, "mobileNotifications": { "roomReady": "Pending", "keyReady": "Pending", "checkoutMessageReceived": true, "requiresAction": true, "errorMessage": "string" }, "reservationCommunication": { "telephones": { "telephoneInfo": [ { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.829Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.829Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "emails": { "emailInfo": [ { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.829Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.829Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 } }, "advanceCheckIn": { "advanceCheckedIn": true, "expectedReturnTime": "2020-08-24T12:59:04.829Z", "eTRComments": "string" }, "welcomeOffer": true, "cancellationInfo": { "description": "string", "code": "string", "date": "2020-08-24" }, "keyCount": 0, "hotelId": "string", "hotelName": "string", "expectedServiceTime": "string", "roomStayReservation": true, "createDateTime": "2020-08-24T12:59:04.829Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.829Z", "lastModifierId": "string", "purgeDate": "2020-08-24", "reservationStatus": "Reserved", "computedReservationStatus": "Reserved", "walkInIndicator": true, "accessRestriction": "Change", "commissionPayoutTo": "TravelAgent", "paymentMethod": "string", "preRegistered": true, "openFolio": true, "allowMobileCheckout": true, "allowMobileViewFolio": true, "optedForCommunication": true } ], "servicingInfo": [ { "section": { "hotelId": "string", "code": "string", "description": "string", "sectionGroup": "string", "targetCredits": 0, "rooms": 0, "roomCredits": 0, "sequence": 0, "inactive": true }, "floor": "string", "attendantId": "string", "attendantName": "string", "hotelId": "string", "activeFlag": "string", "sunday": true, "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": true, "appUser": { "hotel": { "code": "string", "description": "string" }, "appUser": "string", "lDAPUser": "string", "actAs": "string", "actAt": "string", "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", "salesRepCode": "string", "expiryDate": "2020-08-24", "disabledUntil": "2020-08-24", "passwordChangeDate": "2020-08-24", "userInfo": { "personName": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "profileId": { "id": "string", "type": "string" }, "addressInfo": { "address": { "addressLine": [ "string" ], "cityName": "string", "postalCode": "string", "cityExtension": "string", "county": "string", "state": "string", "country": { "value": "string", "code": "string" }, "language": "string", "type": "string", "typeDescription": "string", "primaryInd": true, "updateReservations": true, "barCode": "string", "createDateTime": "2020-08-24T12:59:04.829Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.829Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "emailInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.829Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.829Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "phoneInfo": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-08-24T12:59:04.829Z", "creatorId": "string", "lastModifyDateTime": "2020-08-24T12:59:04.829Z", "lastModifierId": "string", "purgeDate": "2020-08-24" }, "id": "string", "type": "string" }, "department": { "code": "string", "description": "string" }, "gender": "Male", "birthDate": "2020-08-24", "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-08-24", "systemDate": "2020-08-24", "terminal": "string", "runningApp": "string", "shareProfiles": true, "hotel": { "code": "string", "description": "string" }, "cro": { "code": "string", "description": "string" }, "chain": "string", "cROCountryCode": "string", "sessionDefaults": { "dbDateFormat": "string", "oracleDateFormat": "string", "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", "currencyCode": "string", "currencyFormat": "string", "defaultLanguage": "string", "baseLanguage": "string" }, "parameters": [ { "parameterName": "string", "parameterValue": "string" } ] }, "attendantInfo": { "attendantId": "string", "hotelId": "string" } }, "startTime": "2020-08-24T12:59:04.829Z", "status": "Standby" } ], "maintenance": { "unresolvedMaintenanceCount": 0 }, "instructions": "string", "totalCredits": 0, "wakeUpTime": "2020-08-24", "cleaningSequence": 0, "defaultSequence": 0, "hasPriority": true, "maintenanceAllowed": true } ], "roomCounts": [ { "housekeepingRoomStatusType": "CLEAN", "totalCount": 0 } ], "linenChangeCount": 0, "sheetNumber": 0, "date": "2020-08-24", "nextDay": true, "autoGenerated": true, "lockTaskSheet": true, "taskSeqNo": 0, "roomCount": 0, "taskInstructions": "string", "completedDate": "2020-08-24", "hotelId": "string", "sheetType": "NoServiceRequired", "attendantStatus": "Standby", "breakOutId": 0, "allEvaluatedRoomsSkipped": true, "emptyTaskSheet": true, "taskSheetCompleted": true }, "links": [ { "href": "string", "rel": "string", "templated": false, "method": "GET", "targetSchema": "string", "operationId": "string", "title": "string" } ] } } }, "204": { "description": "TaskCompanion not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheet/{taskSequenceNumber}/complete": { "put": { "summary": "Complete a task sheet", "description": "This API allows you to complete a task sheet. Task Sheet Completion functionality is available when the Task Sheet Completion OPERA Control is ON.

OperationId:completeTaskSheet

", "operationId": "completeTaskSheet", "parameters": [ { "name": "taskSequenceNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates unique Task sequence number for which the task sheet will be completed." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates Unique Hotel Code for which the task sheet will be completed." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of completed resource" } }, "description": "Additional warnings about the operation.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheet/{taskSequenceNumber}/reopen": { "put": { "summary": "Reopen a task sheet", "description": "This API allows you to reopen a task sheet. Task Sheet Completion functionality is available when the Task Sheet Completion OPERA Control is ON.

OperationId:reopenTaskSheet

", "operationId": "reopenTaskSheet", "parameters": [ { "name": "taskSequenceNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates unique Task sequence number for which the task sheet will be reopened." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates Unique Hotel Code for which the task sheet will be reopened." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of reopened resource" } }, "description": "Additional warnings about the operation.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheetSet/{taskCodesBreakOutId}/complete": { "put": { "summary": "Complete all the hotel's task sheets for an existing Task Sheet Set.", "description": "Use this API to complete all task sheets for an existing task sheet set for a specific property. Task Sheet Completion functionality is available when the Task Sheet Completion OPERA Control is ON.

OperationId:completeTaskSheetSet

", "operationId": "completeTaskSheetSet", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates Unique Hotel Code for which the task sheets will be completed." }, { "name": "taskCodesBreakOutId", "in": "path", "required": true, "description": "Indicates Unique breakout ID for which the task sheets will be completed.", "type": "string", "minLength": 1, "maxLength": 2000 }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of completed resource" } }, "description": "Additional warnings about the operation.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheetSet/{taskCodesBreakOutId}/reopen": { "put": { "summary": "Reopen all the hotel's task sheets for an existing Task Sheet Set.", "description": "Use this API to Reopen all task sheets for an existing task sheet set for a specific property. Task Sheet Completion functionality is available when the Task Sheet Completion OPERA Control is ON.

OperationId:reopenTaskSheetSet

", "operationId": "reopenTaskSheetSet", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates Unique Hotel Code for which the task sheets will be reopened." }, { "name": "taskCodesBreakOutId", "in": "path", "required": true, "description": "Indicates Unique Breakout ID for which the task sheets will be reopened.", "type": "string", "minLength": 1, "maxLength": 2000 }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of reopened resource" } }, "description": "Additional warnings about the operation.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheetTemplates": { "get": { "summary": "Get the task sheet templates", "description": "This API allows you to get the task sheet templates.

OperationId:getTaskSheetTemplate

", "operationId": "getTaskSheetTemplate", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Hotel Code for which task sheet templates needs to be fetched" }, { "name": "templateCode", "in": "query", "required": false, "description": "Template name for the task sheet.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for retrieving a task sheet template. It contains all the information of the previously generated tasksheet.", "schema": { "$ref": "#/definitions/taskSheetTemplate" } }, "204": { "description": "TaskSheetTemplate not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheetTemplates/{taskSheetTemplateCode}": { "put": { "summary": "Change the task sheet templates", "description": "This API allows you to change the task sheet templates.

OperationId:putTaskSheetTemplate

", "operationId": "putTaskSheetTemplate", "parameters": [ { "name": "taskSheetTemplateCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheetTemplate", "in": "body", "required": true, "description": "Request for changing task sheet template.", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheetTemplate" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/changedTaskSheetTemplate" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "delete": { "summary": "Delete task sheet templates", "description": "This API allows you to delete task sheet templates.

OperationId:deleteTaskSheetTemplate

", "operationId": "deleteTaskSheetTemplate", "parameters": [ { "name": "taskSheetTemplateCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheets": { "post": { "summary": "Create the task sheet", "description": "This API allows you to create the task sheet.

OperationId:postTaskSheet

", "operationId": "postTaskSheet", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheet", "in": "body", "required": true, "description": "Request to create a new task sheet. Details for the task sheet required are the Task Code, Task Date and Resort. Task Instructions and total credits if not provided will be retrieved from the task code setup. If room and attendant information is sent, this will be added to the task sheet created.", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheet" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "put": { "summary": "Change the task sheet", "description": "This API allows you to change the task sheet.

OperationId:putTaskSheet

", "operationId": "putTaskSheet", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheet", "in": "body", "required": true, "description": "Request of Changing a Task Sheet. The task instructions, total credits, attendant information and room information can be changed on a task sheet. Task Instructions , Total Credits and Attendants will be replaced with what is sent in this request. Example: If the task instructions is null in the request, the task instructions on the task sheet will be updated to null. If rooms are sent as part of this request, this will replace the existing rooms on the task sheet. If rooms are not sent, then the original rooms will remain. The task date, hotel code, task sheet number and task code is required to search for the task sheet which has to be changed", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheet" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/changedTaskSheet" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "delete": { "summary": "Delete the task sheet", "description": "This API allows you to delete the task sheet.

OperationId:deleteTaskSheet

", "operationId": "deleteTaskSheet", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "sheetNumber", "in": "query", "required": true, "description": "The Task Sheet number. This will be a sequential number for the task sheets generated for a particular Task Code.", "type": "integer" }, { "name": "taskCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "The Code for the task.", "items": { "type": "string" }, "required": true }, { "name": "date", "in": "query", "required": false, "description": "The date for which the task sheet applies.", "type": "string", "format": "date" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheets/rooms": { "put": { "summary": "Change the task sheet rooms", "description": "This API allows you to change the task sheet rooms.

OperationId:putTaskSheetRooms

", "operationId": "putTaskSheetRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheet", "in": "body", "required": true, "description": "Request to change a room on a task sheet. The information that can be changed are the room instructions and credits. The instructions and credits for a room will be updated based on the information sent in this request. The criteria required to search for the particular task sheet to update requires the HotelCode, Task Sheet Number, Task Code and Task Date.", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheet" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/changedTaskSheetRooms" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "delete": { "summary": "Delete task sheet rooms", "description": "This API allows you to delete task sheet rooms.

OperationId:deleteTaskSheetRooms

", "operationId": "deleteTaskSheetRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "sheetNumber", "in": "query", "required": true, "description": "The Task Sheet number. This will be a sequential number for the task sheets generated for a particular Task Code.", "type": "integer" }, { "name": "taskCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "The Code for the task.", "items": { "type": "string" }, "required": true }, { "name": "date", "in": "query", "required": false, "description": "The date for which the task sheet applies.", "type": "string", "format": "date" }, { "name": "roomId", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Code of the room.", "items": { "type": "string" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] }, "post": { "summary": "Create the task sheet rooms", "description": "This API allows you to create the task sheet rooms.

OperationId:postTaskSheetRooms

", "operationId": "postTaskSheetRooms", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheet", "in": "body", "required": true, "description": "Request to create(add) a room in a task sheet. Details for the task sheet required are the Task Code, Task Date and Resort. The room element will contain the list of rooms that are to be added to the task sheet. These rooms will be added to the existing rooms on the task sheet. Room instructions and credits will be updated for each room.", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheet" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheets/{sheetNumber}/lock": { "put": { "summary": "Lock the task sheet", "description": "This API allows you to Lock the task sheet.

OperationId:lockTaskSheet

", "operationId": "lockTaskSheet", "parameters": [ { "name": "sheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheetToLock", "in": "body", "required": true, "description": "Request for locking a task sheet.", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheetToLock" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/lockedTaskSheet" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheets/{sheetNumber}/unlock": { "put": { "summary": "Unlock the task sheet", "description": "This API allows you to Unlock the task sheet.

OperationId:unlockTaskSheet

", "operationId": "unlockTaskSheet", "parameters": [ { "name": "sheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheetToUnlock", "in": "body", "required": true, "description": "Request for unlocking a task sheet.", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheetToUnlock" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/unlockedTaskSheet" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheets/{taskSheetNumber}/end": { "put": { "summary": "End the service break", "description": "This API allows you to end the Attendant's service break.

OperationId:endServiceBreak

", "operationId": "endServiceBreak", "parameters": [ { "name": "taskSheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskRoom", "in": "body", "required": true, "description": "Request to end service break.", "schema": { "allOf": [ { "$ref": "#/definitions/taskRoom" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/endedServiceBreak" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheets/{taskSheetNumber}/start": { "put": { "summary": "Start the service break", "description": "This API allows you to Start the Attendant's service break.

OperationId:startServiceBreak

", "operationId": "startServiceBreak", "parameters": [ { "name": "taskSheetNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskRoom", "in": "body", "required": true, "description": "Request to start service break.", "schema": { "allOf": [ { "$ref": "#/definitions/taskRoom" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/startedServiceBreak" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/hotels/{hotelId}/taskSheets/{toTaskSequenceNo}/merge": { "post": { "summary": "Merge task sheet", "description": "This API allows you to merge task sheet.

OperationId:mergeTaskSheet

", "operationId": "mergeTaskSheet", "parameters": [ { "name": "toTaskSequenceNo", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "taskSheetToMerge", "in": "body", "required": true, "description": "Request for merging task sheets.", "schema": { "allOf": [ { "$ref": "#/definitions/taskSheetToMerge" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } }, "/services/houseKeeping/status": { "get": { "summary": " ping the house keeping service", "description": "This API allows you to ping the house keeping service.

OperationId:pingHouseKeepingService

", "operationId": "pingHouseKeepingService", "parameters": [ { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for Ping operation.", "schema": { "$ref": "#/definitions/pingRS" } }, "204": { "description": "pingHouseKeepingService not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Housekeeping" ] } } }, "parameters": { "externalData": { "name": "externalData", "type": "string", "description": "Pass this header as true, if payload needs DVM", "in": "header" }, "authKey": { "name": "authorization", "description": "Bearer token that needs to be passed which is generated post user authentication", "type": "string", "in": "header", "required": true }, "x-app-key": { "name": "x-app-key", "description": "Client or Partner's Application Key", "type": "string", "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", "in": "header", "required": true }, "x-request-id": { "name": "x-request-id", "type": "string", "pattern": "~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "description": "Request Id of an incoming request", "in": "header" }, "x-originating-application": { "name": "x-originating-application", "type": "string", "description": "Customer's Integration Application Id", "in": "header" }, "x-hotelid": { "name": "x-hotelid", "type": "string", "description": "Mandatory parameter to identify the hotel code where the end user is logged in", "in": "header", "required": true }, "x-externalsystem": { "name": "x-externalsystem", "type": "string", "maxLength": 40, "description": "External system code.", "in": "header", "x-example": "EXTERNALSYSTEMCODE" }, "Accept-Language": { "name": "Accept-Language", "type": "string", "description": "Language code", "in": "header" }, "x-hubid": { "name": "x-hubid", "type": "string", "description": "x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid", "in": "header" } }, "responses": { "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "405": { "description": "Method not allowed" }, "406": { "description": "Not acceptable." }, "413": { "description": "Request Entity Too Large" }, "414": { "description": "Request URI Too Large" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "System Error", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "definitions": { "attendantSchedule": { "type": "object", "description": "Request for creating the attendant schedule.", "properties": { "attendantsScheduleInfo": { "description": "Criteria for the attendants to be assigned to a particular day.", "$ref": "#/definitions/housekeepingAttendantsScheduleType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "housekeepingAttendantsScheduleType": { "type": "object", "description": "Collection of Attendants.", "properties": { "hotelId": { "description": "Property code the Housekeeping Attendant belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "scheduleDate": { "description": "Schedule date of attendants' assignment. Used when attendants to scheduled are of the same date.", "type": "string", "format": "date", "maxLength": 8 }, "attendantsSchedule": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingAttendantScheduleType" } } } }, "housekeepingAttendantScheduleType": { "type": "object", "description": "Criteria to manage the attendant schedule.", "properties": { "name": { "description": "Partial name of an attendant.", "type": "string" }, "attendantId": { "description": "ID of the attendant.", "type": "string", "minLength": 0, "maxLength": 20 }, "date": { "description": "Date the attendant will be assigned.", "type": "string", "format": "date", "maxLength": 8 } } }, "links": { "type": "array", "items": { "$ref": "#/definitions/instanceLink" } }, "instanceLink": { "type": "object", "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", "properties": { "href": { "description": "URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.", "type": "string" }, "rel": { "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.", "type": "string" }, "templated": { "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.", "type": "boolean", "default": false }, "method": { "description": "HTTP method for requesting the target of the link.", "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD" ] }, "targetSchema": { "description": "Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..", "type": "string" }, "operationId": { "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.", "type": "string" }, "title": { "description": "Exact copy of the \"summary\" field on the linked operation.", "type": "string" } } }, "warningsType": { "type": "array", "description": "Used in conjunction with the Success element to define a business error.", "maxItems": 4000, "items": { "$ref": "#/definitions/warningType" } }, "warningType": { "type": "object", "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", "properties": { "value": { "type": "string", "description": "Property Value" }, "shortText": { "description": "An abbreviated version of the error in textual format.", "type": "string", "maxLength": 2000 }, "code": { "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", "type": "string", "minLength": 0, "maxLength": 20 }, "docURL": { "description": "If present, this URL refers to an online description of the error that occurred.", "type": "string", "maxLength": 2000 }, "status": { "description": "If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.", "type": "string", "maxLength": 2000 }, "tag": { "description": "If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].", "type": "string", "maxLength": 2000 }, "recordId": { "description": "If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.", "type": "string", "maxLength": 2000 }, "type": { "description": "The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".", "type": "string", "minLength": 0, "maxLength": 20 }, "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "rph": { "description": "Reference Place Holder used as an index for this warning.", "type": "string", "minLength": 1, "maxLength": 8 } } }, "exceptionDetailType": { "title": "Error Detail", "description": "Complex type that contains error details for a REST call.", "type": "object", "properties": { "type": { "type": "string", "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." }, "title": { "type": "string", "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, "detail": { "type": "string", "description": "Human-readable description specific to this occurrence of the problem." }, "instance": { "type": "string", "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, "o:errorCode": { "type": "string", "description": "Application error code, which is different from HTTP error code." }, "o:errorPath": { "type": "string", "description": "Path to the problem at the resource or property level." }, "o:errorDetails": { "description": "Details of the error message, consisting of a hierarchical tree structure.", "type": "array", "items": { "$ref": "#/definitions/errorInstance" } }, "links": { "$ref": "#/definitions/links" } }, "required": [ "type", "title" ] }, "errorInstance": { "title": "Error Instance Details", "description": "Complex type that contains error instance details for a REST call.", "type": "object", "properties": { "type": { "type": "string", "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." }, "title": { "type": "string", "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, "detail": { "type": "string", "description": "Human-readable description specific to this occurrence of the problem." }, "instance": { "type": "string", "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, "o:errorCode": { "type": "string", "description": "Application error code, which is different from HTTP error code." }, "o:errorPath": { "type": "string", "description": "Path to the problem at the resource or property level." } }, "required": [ "type", "title" ] }, "status": { "type": "object", "description": "Response Body.", "properties": { "warnings": { "$ref": "#/definitions/warningsType" }, "links": { "$ref": "#/definitions/links" } } }, "taskSheets": { "type": "object", "description": "Request for generating housekeeping Task Sheets automatically. To generate task sheets automatically the minimum required criteria is the Task Date, Task Code, Number of Attendants/Tasksheets required and the Room Statuses. Based on the criteria defined, task sheets will be created and the rooms will be assigned to the Tasksheets. Example: if the criteria defines that Dirty room status to be used to generate 5 sheets, then only those rooms which have the status = Dirty will be used and will be assigned to the 5 sheets.", "properties": { "criteria": { "description": "The criteria for automatically generating the task sheets", "$ref": "#/definitions/autoGenerateTaskSheetsCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoGenerateTaskSheetsCriteriaType": { "type": "object", "description": "Criteria Type for generating Housekeeping Task Sheets automatically. Defines the criteria required for automatic generation.", "properties": { "taskCodes": { "description": "Task Code for which the task sheets should be generated.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "attendants": { "description": "The Attendant who will be assigned to the Task Sheets. Each attendant will be assigned to one task sheet. The number of attendants should be equal to the number of Attendants attached, otheriwise the attendants defined will be used.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "roomClassList": { "description": "Room Class of the Room.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "status": { "description": "The Room Status, FO Status and Housekeeping Room Reservation status which are to be used to generate the task sheet.", "$ref": "#/definitions/taskSheetGenerationStatusTypesType" }, "instructions": { "description": "The Room Instructions, Task Instructions and Attendant Instructions which will be added to the Task Sheets.", "$ref": "#/definitions/taskSheetInstructionsType" }, "excludeVIPCodes": { "description": "VIP codes to be excluded.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "taskDate": { "description": "Task Date for which the tasks are to be generated. Date cannot be earlier than business date.", "type": "string", "format": "date", "maxLength": 8 }, "hotelId": { "description": "Property for which the tasks are to be generated.", "type": "string", "minLength": 0, "maxLength": 20 }, "numberOfAttendants": { "description": "The number of attendants for whom the task sheets are to be generated. Number of Attendants or Maximum Credits Per Task Sheet should be defined in order to generate task sheets.", "type": "integer" }, "sheetOrderBy": { "description": "The order of the rooms when assigning to the task sheets. Default order is by Room Number. If task sheets are to be ordered by Section or Floor, a new task sheet will be generated for Section/Floor.", "type": "string", "enum": [ "Room", "Floor", "Section", "SectionGroups", "Building", "BuildingGroups" ] }, "maximumCreditsPerSheet": { "description": "The maximum credits that can assigned to a task sheet based on the credits defined on the room.", "type": "integer" }, "returnTaskSheets": { "description": "Return the details of the task sheets which were generated. Setting this to true will return the TaskAssignment element with details of task sheets which were generated.", "type": "boolean" }, "turndown": { "description": "Return whether the sheet to be generated is of type turndown or not.", "type": "boolean" }, "vIPOnly": { "description": "Return whether the sheet to be generated is VIP only or not.", "type": "boolean" }, "separateNSRRooms": { "description": "Separate No Service rooms if there are any.", "type": "boolean" }, "separateDNDRooms": { "description": "Separate Do not Disturb rooms if there are any.", "type": "boolean" }, "showAllScheduledTasks": { "description": "If ShowAllScheduledTasks is true then all housekeeping tasks scheduled for the day for the reservation will be shown, otherwise only the task with the highest priority will be shown.", "type": "boolean" }, "sectionTypeToUse": { "description": "If the task sheets have to sorted by Section, then the type of section to use should be indicated here. The types are 'Day' or 'Evening'.", "type": "string", "enum": [ "Day", "Evening" ] }, "overrideTaskTemplate": { "description": "Overrides the existing task template.", "type": "boolean" }, "templateCode": { "description": "Template code of the task sheet.", "type": "string", "minLength": 0, "maxLength": 20 }, "templateDescription": { "description": "Short description of the task sheet.", "type": "string", "minLength": 0, "maxLength": 50 }, "rateCode": { "description": "Rate codes needed for task sheet break out.", "type": "string", "minLength": 0, "maxLength": 100 }, "room": { "description": "Rooms needed for task sheet break out.", "type": "string", "minLength": 0, "maxLength": 100 }, "stayOverFirst": { "description": "Stay over first for the task sheet.", "type": "boolean" }, "defaultTemplate": { "description": "Indicates if the template code of the task sheet is set as default.", "type": "boolean" }, "excludeRoomsExclusiveToOwner": { "description": "It indicates exclude all the rooms that are configured as exclusive to owners.", "type": "boolean" }, "excludeRoomsOccupiedByOwner": { "description": "It exclude any rooms that are occupied by their owner and/or an unthorized user of the room.", "type": "boolean" }, "ruleCodes": { "description": "The credits configured for the different rules that apply for the current generation of task sheets process, it is available only when Housekeeping Credits is set to Room Task Rule.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } } } }, "taskSheetGenerationStatusTypesType": { "type": "object", "description": "Different status lists which are going to be used in the Task Sheet Generation.", "properties": { "housekeepingRoomStatusList": { "description": "Housekeeping room status(example Dirty, Clean etc.) which will be used in for the generation of task sheets. This is required element for the generation of task sheets. Rooms of these statuses will be used and assigned to the task sheets.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingRoomStatusType" } }, "frontOfficeRoomStatusList": { "description": "Front office statuses to be used in requests for generating task sheets. Example: Vacant or Occupied.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/frontOfficeRoomStatusType" } }, "reservationStatusList": { "description": "List of Reservation Statuses. Rooms which have these reservation statuses will be included in the task sheets. Example: If Arrival rooms are required, then Arrival will be one of the statuses defined in this element.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingRoomReservationStatusType" } }, "turndownStatusList": { "description": "List of Turndown Statuses. Rooms which have these statuses will be included in the task sheets.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/turndownStatusType" } }, "roomAssignmentStatusList": { "description": "Room assignment status to be used in requests for fetching housekeeping rooms.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomAssignmentStatusType" } } } }, "housekeepingRoomStatusType": { "type": "string", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "enum": [ "Clean", "Dirty", "Pickup", "Inspected", "OutOfOrder", "OutOfService" ] }, "frontOfficeRoomStatusType": { "type": "string", "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.", "enum": [ "Vacant", "Occupied" ] }, "housekeepingRoomReservationStatusType": { "type": "string", "description": "Room Reservation status types used in housekeeping. These may be different from the actual reservation statuses as these relate to the current reservation for the room.", "enum": [ "Arrival", "Arrived", "DayUse", "DueOut", "Departed", "NotReserved", "StayOver" ] }, "turndownStatusType": { "type": "string", "description": "Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.", "enum": [ "Required", "NotRequired", "Compeleted" ] }, "roomAssignmentStatusType": { "type": "string", "enum": [ "Assigned", "Unassigned" ] }, "taskSheetInstructionsType": { "type": "object", "description": "Instructions which will added to the Task Sheets which are generated.", "properties": { "taskInstructions": { "description": "Instructions for the task sheets.", "type": "string", "minLength": 0, "maxLength": 2000 }, "roomInstructions": { "description": "Instructions at the room level i.e for each room.", "type": "string", "minLength": 0, "maxLength": 2000 }, "attendantInstructions": { "description": "Instructions for the attendant i.e for each attendant.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "rooms": { "type": "object", "properties": { "housekeepingRooms": { "description": "List of rooms and the room status.", "$ref": "#/definitions/hotelRoomsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "hotelRoomsType": { "type": "object", "description": "Collection of Room record that contain Housekeeping and Out Of Order information.", "properties": { "room": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomType" } }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "roomType": { "type": "object", "description": "This type represents the primary room attributes.", "properties": { "roomType": { "description": "Room type basic information of the room.", "$ref": "#/definitions/roomTypeShortInfoType" }, "floor": { "description": "Floor of the Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "floorDescription": { "description": "Description for the Floor of the Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomFeatures": { "description": "Room Features for the room.", "$ref": "#/definitions/roomFeaturesType" }, "roomDescription": { "description": "Detail Long Description Of The Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the room.", "$ref": "#/definitions/translationTextType2000" }, "smokingPreference": { "description": "This indicates room smoking preference.", "type": "string", "minLength": 0, "maxLength": 20 }, "smokingPreferenceDescription": { "description": "This indicates the description of the room smoking preference.", "type": "string", "minLength": 0, "maxLength": 20 }, "building": { "description": "Building associated with the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomAssignmentRating": { "description": "Assignment Rating associated with the room.", "$ref": "#/definitions/ratePlanRatingType" }, "isAccessible": { "description": "Indicates whether the room is accessibility compliant.", "type": "boolean" }, "roomId": { "description": "Code of the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "meetingRoom": { "description": "Indicates whether the room is a Meeting Room", "type": "boolean" }, "roomSection": { "description": "Room sections of the room.", "$ref": "#/definitions/roomSectionType" }, "housekeeping": { "description": "Identifies the Housekeeping information..", "$ref": "#/definitions/housekeepingType" }, "outOfOrder": { "description": "Identifies the room Out of Order/Out of Service information.", "$ref": "#/definitions/roomsOutOfOrderType" }, "discrepancy": { "description": "Identifies the room discrepancy information.", "$ref": "#/definitions/roomDiscrepanciesType" }, "componentRoomNumber": { "description": "This flag indicates component room.", "type": "string", "minLength": 0, "maxLength": 20 }, "connectingRooms": { "description": "This flag indicates connecting rooms.", "$ref": "#/definitions/roomRoomsType" }, "componentRooms": { "description": "This flag indicates component rooms.", "$ref": "#/definitions/roomRoomsType" }, "attendant": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/currentServicingAttendantType" } }, "hold": { "description": "Hold attributes if any.", "$ref": "#/definitions/roomHoldType" }, "turndownInfo": { "$ref": "#/definitions/turndownInfoType" }, "resvInfo": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/reservationShortInfoType" } }, "componentRoomNumbers": { "description": "List of component room numbers.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } } } }, "roomTypeShortInfoType": { "type": "object", "description": "Basic information of room type.", "properties": { "pseudoRoom": { "description": "Indicates if room is a pseudoRoom. This is read-only.", "type": "boolean" }, "isSuiteRoom": { "description": "Indicates if room is a isSuiteRoom. This is read-only.", "type": "boolean" }, "roomClass": { "description": "Room Class of the room. This is read-only.", "type": "string", "minLength": 0, "maxLength": 20 }, "shortDescription": { "description": "Short Description of room type.", "type": "string", "minLength": 0, "maxLength": 200 }, "houseKeeping": { "description": "Indicates if room type of the room is flagged as housekeeping. This is read-only.", "type": "boolean" }, "smokingPreference": { "description": "Specifies the smoking preference for room type of the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "minimumOccupancy": { "description": "Minimum occupancy for the room type.", "type": "integer" }, "maximumOccupancy": { "description": "Maximum occupancy for the room type.", "type": "integer" }, "roomFeatures": { "description": "Room Features for the room.", "$ref": "#/definitions/roomFeaturesType" }, "isAccessible": { "description": "Indicates if room type is isAccessible.", "type": "boolean" }, "roomType": { "description": "Room type of the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "meetingRoom": { "description": "Indicates whether function space can be meeting room.", "type": "boolean" } } }, "roomFeaturesType": { "type": "array", "description": "A recurring element that identifies the room features.", "maxItems": 4000, "items": { "$ref": "#/definitions/roomFeatureType" } }, "roomFeatureType": { "type": "object", "description": "Room Feature Information.", "properties": { "code": { "description": "A code representing a room feature.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "A code representing a room feature.", "type": "string", "minLength": 0, "maxLength": 2000 }, "orderSequence": { "description": "Display Order sequence.", "type": "number" }, "quantity": { "description": "Indicates quantity.", "type": "integer" } } }, "translationTextType2000": { "type": "object", "description": "Contains Multiple translated texts and language codes.", "properties": { "defaultText": { "description": "Default text with Character length from 0 to 2000.", "type": "string", "minLength": 0, "maxLength": 2000 }, "translatedTexts": { "description": "List of translated text and language codes.", "$ref": "#/definitions/translationsTextType" } } }, "translationsTextType": { "type": "array", "description": "Language code for the translation.", "maxItems": 4000, "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Used for Character Strings, length 0 to 2000.", "minLength": 0, "maxLength": 2000 }, "language": { "description": "Language identification.", "type": "string", "minLength": 0, "maxLength": 20 } }, "description": "Language code for the translation." } }, "ratePlanRatingType": { "type": "string", "description": "Possible Rate plan rating values.", "enum": [ "MostImportant", "Important", "SomewhatImportant", "LessImportant", "LeastImportant", "NoValueSet" ] }, "roomSectionType": { "type": "object", "properties": { "daySectionCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "eveningSectionCode": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "housekeepingType": { "type": "object", "description": "Identifies the Housekeeping information.", "properties": { "housekeepingRoomStatus": { "description": "The Room status information per the reservation and housekeeping.", "$ref": "#/definitions/roomStatusType" }, "roomPersons": { "description": "The Room person information per the reservation and housekeeping.", "$ref": "#/definitions/roomPersonsType" }, "guestServiceRequest": { "$ref": "#/definitions/guestHousekeepingServiceRequestType" }, "cleaningPriority": { "description": "Cleaning priority for the room, if a priority was set.", "$ref": "#/definitions/roomCleaningPriorityType" }, "roomCondition": { "description": "Condition of the room, if a condition was set.", "$ref": "#/definitions/roomConditionType" }, "linenChange": { "description": "Indicates if a linen change is necessary.", "type": "boolean" }, "facilityTaskCode": { "description": "Facility task Code/ Task Code assigned to the room for the day.", "$ref": "#/definitions/codeListType" }, "roomCompleted": { "description": "Indicates if this room has been completed. A room is complete when it reaches the highest available Room Status.", "type": "boolean" } } }, "roomStatusType": { "type": "object", "properties": { "reservationStatusList": { "description": "List of status of the reservation to which this Room is assigned..", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingRoomReservationStatusType" } }, "housekeepingRoomStatus": { "description": "Status of the room (Dirty/Clean/Inspected/Pickup).", "$ref": "#/definitions/housekeepingRoomStatusType" }, "frontOfficeStatus": { "description": "Front office status ( Occupied/Vacant ).", "$ref": "#/definitions/frontOfficeRoomStatusType" }, "housekeepingStatus": { "description": "Housekeeping status ( Occupied/Vacant ).", "$ref": "#/definitions/frontOfficeRoomStatusType" } } }, "roomPersonsType": { "type": "object", "properties": { "frontOfficePersons": { "type": "integer" }, "houseKeepingPersons": { "type": "integer" } } }, "guestHousekeepingServiceRequestType": { "type": "string", "description": "Possible values for the Guest Service Status.", "enum": [ "DoNotDisturb", "MakeUpRoom", "NoStatusSelected", "ServiceDeclined" ] }, "roomCleaningPriorityType": { "type": "object", "description": "Type to indicate the cleaning priority for a room.", "properties": { "prioritySequence": { "description": "Priority sequence of the room for cleaning.", "type": "integer" } } }, "roomConditionType": { "type": "object", "description": "Condition to be assigned on the room.", "properties": { "roomCondition": { "description": "Code and Decription of Condition to be assigned on the room.", "$ref": "#/definitions/codeDescriptionType" }, "assignmentType": { "description": "Determine if room, after applying condition, is available or not in Room Assignment listing.", "$ref": "#/definitions/roomConditionAssigmentType" }, "remarks": { "description": "Remarks on room condition assignment.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "codeDescriptionType": { "type": "object", "description": "This contains a generic code and description information.", "properties": { "code": { "description": "Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "description.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "roomConditionAssigmentType": { "type": "string", "description": "Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.", "enum": [ "Available", "NotAvailable" ] }, "codeListType": { "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "roomsOutOfOrderType": { "type": "array", "description": "Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS).", "maxItems": 4000, "items": { "$ref": "#/definitions/roomOutOfOrderType" } }, "roomOutOfOrderType": { "type": "object", "description": "Out Of Order and Out Of Service Room information.", "properties": { "repairRemarks": { "description": "Notes or Remarks on the OO/OS room", "type": "string", "minLength": 0, "maxLength": 2000 }, "returnStatus": { "description": "Room Status which will be used on completion of OO/OS.", "$ref": "#/definitions/housekeepingRoomStatusType" }, "reasonCode": { "description": "Reason Code why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 20 }, "reasonDescription": { "description": "Reason Description why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 80 }, "newDateRange": { "description": "The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms.", "$ref": "#/definitions/dateRangeType" }, "housekeepingRoomStatus": { "description": "The out of order or out of service room status OO/OS.", "$ref": "#/definitions/housekeepingRoomStatusType" }, "start": { "description": "The starting value of the date range.", "type": "string", "format": "date", "maxLength": 8 }, "end": { "description": "The ending value of the date range.", "type": "string", "format": "date", "maxLength": 8 }, "endTime": { "description": "The date and time until which the room is marked as OO/OS.", "type": "string", "format": "date-time" }, "roomRepairId": { "description": "Unique id that identifies the OO/OS record", "$ref": "#/definitions/uniqueID_Type" } } }, "dateRangeType": { "type": "object", "description": "Date Range with Start and End dates.", "properties": { "start": { "description": "The starting value of the date range.", "type": "string", "format": "date", "maxLength": 8 }, "end": { "description": "The ending value of the date range.", "type": "string", "format": "date", "maxLength": 8 } } }, "roomDiscrepanciesType": { "type": "array", "description": "Room Discrepancies between front office and housekeeping room status and number of persons in the room.", "maxItems": 4000, "items": { "$ref": "#/definitions/roomDiscrepancyType" } }, "roomDiscrepancyType": { "type": "string", "description": "Simple type for discrepant room status instructions to be used in requests for fetching housekeeping and front office room discrepancy. Valid values are Sleep, Skip, Person Discrepancy, Due Out Only.", "enum": [ "Sleep", "Skip", "PersonDiscrepancy" ] }, "roomRoomsType": { "type": "array", "description": "Collection of rooms.", "maxItems": 4000, "items": { "$ref": "#/definitions/roomRoomType" } }, "roomRoomType": { "type": "object", "description": "This type represents the primary room attributes.", "properties": { "roomType": { "description": "Room type basic information of the room.", "$ref": "#/definitions/roomTypeShortInfoType" }, "floor": { "description": "Floor of the Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "floorDescription": { "description": "Description for the Floor of the Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomFeatures": { "description": "Room Features for the room.", "$ref": "#/definitions/roomFeaturesType" }, "roomDescription": { "description": "Detail Long Description Of The Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the room.", "$ref": "#/definitions/translationTextType2000" }, "smokingPreference": { "description": "This indicates room smoking preference.", "type": "string", "minLength": 0, "maxLength": 20 }, "smokingPreferenceDescription": { "description": "This indicates the description of the room smoking preference.", "type": "string", "minLength": 0, "maxLength": 20 }, "building": { "description": "Building associated with the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomAssignmentRating": { "description": "Assignment Rating associated with the room.", "$ref": "#/definitions/ratePlanRatingType" }, "isAccessible": { "description": "Indicates whether the room is accessibility compliant.", "type": "boolean" }, "roomId": { "description": "Code of the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "meetingRoom": { "description": "Indicates whether the room is a Meeting Room", "type": "boolean" }, "roomCondition": { "description": "Code and description of condition assigned on the room.", "$ref": "#/definitions/codeDescriptionType" } } }, "currentServicingAttendantType": { "type": "object", "description": "The Attendant Name and ID of the attendant servicing the room.", "properties": { "section": { "description": "Section Code the attendant has been assigned.", "$ref": "#/definitions/housekeepingSectionType" }, "floor": { "description": "The Floor which is assigned to the attendant.", "type": "string", "minLength": 0, "maxLength": 20 }, "attendantId": { "description": "Attendant's unique identifier.", "type": "string", "minLength": 0, "maxLength": 20 }, "attendantName": { "description": "Attendant's name.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelId": { "description": "Property where the attendant belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "activeFlag": { "description": "Indicates if the Attendant is active.", "type": "string", "minLength": 0, "maxLength": 1 }, "sunday": { "type": "boolean" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "appUser": { "description": "The App User Name and ID of the user who started the service.", "$ref": "#/definitions/applicationUserType" }, "startTime": { "description": "The start time of the service.", "type": "string", "format": "date-time" }, "status": { "description": "Status of the respective Housekeeping Attendant.", "$ref": "#/definitions/servicingAttendantStatusType" } } }, "housekeepingSectionType": { "type": "object", "description": "Information regarding Housekeeping Sections.", "properties": { "hotelId": { "description": "Property where this section is defined.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "The Housekeeping Section Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Section.", "type": "string", "minLength": 0, "maxLength": 80 }, "sectionGroup": { "description": "Housekeeping Section Group.", "type": "string", "minLength": 0, "maxLength": 20 }, "targetCredits": { "description": "Target Credit for each task sheet created for this section when auto task assignment is broken out by section.", "type": "integer" }, "rooms": { "description": "Rooms count for this section code. This is auto populated while creating/fetching record.", "type": "integer" }, "roomCredits": { "description": "Number of housekeeping credits. This is auto populated while creating/fetching record.", "type": "integer" }, "sequence": { "description": "Display sequence when task assignment is automatically broken out by Section Group.", "type": "integer" }, "inactive": { "description": "Indicates if the Section Code is active.", "type": "boolean" } } }, "applicationUserType": { "type": "object", "properties": { "hotel": { "description": "Hotel where user belongs.", "$ref": "#/definitions/codeDescriptionType" }, "appUser": { "type": "string", "minLength": 0, "maxLength": 250 }, "lDAPUser": { "type": "string", "minLength": 0, "maxLength": 250 }, "actAs": { "type": "string", "minLength": 0, "maxLength": 20 }, "actAt": { "type": "string", "minLength": 0, "maxLength": 20 }, "userDefaultLanguage": { "type": "string", "minLength": 0, "maxLength": 20 }, "appUserId": { "$ref": "#/definitions/uniqueID_Type" }, "cashierId": { "type": "integer" }, "cashierTitle": { "description": "Cashier title.", "type": "string", "minLength": 0, "maxLength": 2000 }, "department": { "type": "string", "minLength": 0, "maxLength": 60 }, "departmentLocation": { "type": "string", "minLength": 0, "maxLength": 60 }, "salesRepCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "expiryDate": { "type": "string", "format": "date", "maxLength": 8 }, "disabledUntil": { "type": "string", "format": "date", "maxLength": 8 }, "passwordChangeDate": { "type": "string", "format": "date", "maxLength": 8 }, "userInfo": { "$ref": "#/definitions/employeeInfoType" }, "userSessionInfo": { "description": "This is only used during log-in.", "$ref": "#/definitions/userSessionInfoType" }, "attendantInfo": { "$ref": "#/definitions/attendantType" } } }, "uniqueID_Type": { "type": "object", "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).", "properties": { "id": { "description": "A 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.", "type": "string", "minLength": 0, "maxLength": 80 }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "employeeInfoType": { "type": "object", "properties": { "personName": { "$ref": "#/definitions/personNameType" }, "profileId": { "$ref": "#/definitions/uniqueID_Type" }, "addressInfo": { "$ref": "#/definitions/addressInfoType" }, "emailInfo": { "$ref": "#/definitions/emailInfoType" }, "phoneInfo": { "$ref": "#/definitions/telephoneInfoType" }, "department": { "$ref": "#/definitions/codeDescriptionType" }, "gender": { "description": "Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.", "type": "string", "minLength": 0, "maxLength": 20 }, "birthDate": { "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", "type": "string", "format": "date", "maxLength": 8 }, "birthDateMasked": { "description": "Indicates the date of birth as masked.", "type": "string" } } }, "personNameType": { "type": "object", "description": "This provides name information for a person.", "properties": { "namePrefix": { "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", "type": "string", "minLength": 0, "maxLength": 40 }, "givenName": { "description": "Given name, first name or names.", "type": "string", "minLength": 0, "maxLength": 40 }, "middleName": { "description": "The middle name of the person name.", "type": "string", "minLength": 0, "maxLength": 40 }, "surname": { "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.", "type": "string", "minLength": 0, "maxLength": 40 }, "nameSuffix": { "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", "type": "string", "minLength": 0, "maxLength": 40 }, "nameTitle": { "description": "Degree or honors (e.g., Ph.D., M.D.)", "type": "string", "minLength": 0, "maxLength": 80 }, "nameTitleSuffix": { "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on.", "type": "integer" }, "envelopeGreeting": { "description": "Envelope Greeting of the profile", "type": "string" }, "salutation": { "description": "Salutation of the profile", "type": "string" }, "nameType": { "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", "$ref": "#/definitions/personNameTypeType" }, "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "externalSystem": { "description": "When name type is external, indicates the external system the name belongs to.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "personNameTypeType": { "type": "string", "description": "Person's name in an external system.", "enum": [ "Primary", "Alternate", "Incognito", "External", "Phonetic" ] }, "addressInfoType": { "type": "object", "description": "Provides address information.", "properties": { "address": { "description": "Address details for the profile.", "$ref": "#/definitions/addressType" }, "id": { "description": "A 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.", "type": "string", "minLength": 0, "maxLength": 80 }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "addressType": { "type": "object", "description": "Provides address information.", "properties": { "isValidated": { "description": "Indicator to define if the Address is validated by the Address Validation System.", "type": "boolean" }, "addressLine": { "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", "type": "array", "maxItems": 4, "items": { "type": "string", "minLength": 0, "maxLength": 80 } }, "cityName": { "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", "type": "string", "minLength": 0, "maxLength": 40 }, "postalCode": { "description": "Post Office Code number.", "type": "string", "minLength": 0, "maxLength": 15 }, "cityExtension": { "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.", "type": "string", "minLength": 0, "maxLength": 20 }, "county": { "description": "County or District Name (e.g., Fairfax). This is read only.", "type": "string", "minLength": 0, "maxLength": 20 }, "state": { "description": "State or Province name (e.g., Texas).", "type": "string", "minLength": 0, "maxLength": 20 }, "country": { "description": "Country name (e.g., Ireland).", "$ref": "#/definitions/countryNameType" }, "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "type": { "description": "Defines the type of address (e.g. home, business, other).", "type": "string", "minLength": 0, "maxLength": 20 }, "typeDescription": { "description": "Describes the type code", "type": "string" }, "primaryInd": { "description": "When true, indicates a primary information.", "type": "boolean" }, "updateReservations": { "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.", "type": "boolean" }, "barCode": { "description": "The postal barcode for the address.", "type": "string", "minLength": 0, "maxLength": 100 }, "createDateTime": { "description": "Time stamp of the creation. Uses database time zone.", "type": "string", "format": "date-time" }, "creatorId": { "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.", "type": "string", "minLength": 0, "maxLength": 200 }, "lastModifyDateTime": { "description": "Time stamp of last modification. Uses database time zone.", "type": "string", "format": "date-time" }, "lastModifierId": { "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, "maxLength": 200 }, "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", "format": "date", "maxLength": 8 } } }, "countryNameType": { "type": "object", "description": "Code for a country or a nationality.", "properties": { "value": { "type": "string", "description": "Used for Character Strings, length 0 to 200.", "minLength": 0, "maxLength": 200 }, "code": { "description": "Code for a country or a nationality.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "emailInfoType": { "type": "object", "description": "Information on an email for the customer.", "properties": { "email": { "description": "eMail deatils for the profile.", "$ref": "#/definitions/emailType" }, "id": { "description": "A 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.", "type": "string", "minLength": 0, "maxLength": 80 }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "emailType": { "type": "object", "description": "Information on an email for the customer.", "properties": { "emailAddress": { "description": "Defines the e-mail address.", "type": "string", "minLength": 0, "maxLength": 2000 }, "type": { "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve).", "type": "string", "minLength": 0, "maxLength": 20 }, "typeDescription": { "description": "Describes the Type code", "type": "string", "minLength": 0, "maxLength": 2000 }, "emailFormat": { "description": "Supported Email format.", "type": "string", "enum": [ "Html", "Text" ] }, "primaryInd": { "description": "When true, indicates a primary information.", "type": "boolean" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" }, "createDateTime": { "description": "Time stamp of the creation. Uses database time zone.", "type": "string", "format": "date-time" }, "creatorId": { "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.", "type": "string", "minLength": 0, "maxLength": 200 }, "lastModifyDateTime": { "description": "Time stamp of last modification. Uses database time zone.", "type": "string", "format": "date-time" }, "lastModifierId": { "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, "maxLength": 200 }, "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", "format": "date", "maxLength": 8 } } }, "telephoneInfoType": { "type": "object", "description": "Information on a telephone number for the customer.", "properties": { "telephone": { "description": "Phone details for the profile.", "$ref": "#/definitions/telephoneType" }, "id": { "description": "A 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.", "type": "string", "minLength": 0, "maxLength": 80 }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "telephoneType": { "type": "object", "description": "Information on a telephone number for the customer.", "properties": { "phoneTechType": { "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.", "type": "string", "minLength": 0, "maxLength": 20 }, "phoneUseType": { "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).", "type": "string", "minLength": 0, "maxLength": 20 }, "phoneUseTypeDescription": { "description": "Description of the PhoneUseType code", "type": "string", "minLength": 0, "maxLength": 2000 }, "phoneNumber": { "description": "Telephone number assigned to a single location.", "type": "string", "minLength": 0, "maxLength": 40 }, "extension": { "description": "Extension to reach a specific party at the phone number.", "type": "string", "minLength": 0, "maxLength": 20 }, "primaryInd": { "description": "When true, indicates a primary information.", "type": "boolean" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" }, "createDateTime": { "description": "Time stamp of the creation. Uses database time zone.", "type": "string", "format": "date-time" }, "creatorId": { "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.", "type": "string", "minLength": 0, "maxLength": 200 }, "lastModifyDateTime": { "description": "Time stamp of last modification. Uses database time zone.", "type": "string", "format": "date-time" }, "lastModifierId": { "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, "maxLength": 200 }, "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", "format": "date", "maxLength": 8 } } }, "userSessionInfoType": { "type": "object", "properties": { "businessDate": { "type": "string", "format": "date", "maxLength": 8 }, "systemDate": { "type": "string", "format": "date", "maxLength": 8 }, "terminal": { "type": "string" }, "runningApp": { "type": "string" }, "shareProfiles": { "type": "boolean" }, "hotel": { "$ref": "#/definitions/codeDescriptionType" }, "cro": { "$ref": "#/definitions/codeDescriptionType" }, "chain": { "type": "string", "minLength": 0, "maxLength": 20 }, "cROCountryCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "sessionDefaults": { "$ref": "#/definitions/userSessionDefaultsType" }, "parameters": { "$ref": "#/definitions/parametersType" } } }, "userSessionDefaultsType": { "type": "object", "properties": { "dbDateFormat": { "type": "string" }, "oracleDateFormat": { "type": "string" }, "oracleTimeFormat": { "type": "string" }, "javaDateFormat": { "type": "string" }, "javaTimeFormat": { "type": "string" }, "currencyCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "currencyFormat": { "type": "string" }, "defaultLanguage": { "type": "string" }, "baseLanguage": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "parametersType": { "type": "array", "description": "Collection of generic Name-Value-Pair parameters.", "maxItems": 4000, "items": { "$ref": "#/definitions/parameterType" } }, "parameterType": { "type": "object", "description": "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.", "properties": { "parameterName": { "description": "Name of the parameter.", "type": "string" }, "parameterValue": { "description": "Value of the parameter.", "type": "string" } } }, "attendantType": { "type": "object", "properties": { "attendantId": { "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "servicingAttendantStatusType": { "type": "string", "description": "Possible values for the Status of a Servicing Attendant.", "enum": [ "Standby", "Break", "Working", "Completed" ] }, "roomHoldType": { "type": "object", "properties": { "holdUntil": { "description": "The date and time when hold will expire.", "type": "string", "format": "date-time" }, "holdUser": { "description": "User who placed room on hold.", "type": "string", "minLength": 0, "maxLength": 80 }, "comments": { "description": "Comments of the room hold.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "turndownInfoType": { "type": "object", "properties": { "turndownStatusInfo": { "$ref": "#/definitions/turndownStatusType" } } }, "reservationShortInfoType": { "type": "object", "properties": { "guestName": { "description": "Guest name that is registered for the reservation.", "type": "string", "minLength": 0, "maxLength": 80 }, "reservationId": { "$ref": "#/definitions/reservationId" }, "reservationStatusInfo": { "$ref": "#/definitions/housekeepingRoomReservationStatusType" }, "stayDateInfo": { "$ref": "#/definitions/stayDateInfoType" }, "vipStatus": { "description": "VIP status of the guest.", "$ref": "#/definitions/vIPStatusType" }, "profileId": { "description": "ProfileId of the guest.", "$ref": "#/definitions/uniqueID_Type" }, "roomId": { "description": "Indicates room number of the reservation.", "type": "string", "minLength": 0, "maxLength": 20 }, "adultCount": { "description": "Number of adults on the reservation.", "type": "integer", "minimum": 0 }, "childCount": { "description": "Number of children on the reservation.", "type": "integer", "minimum": 0 }, "scheduledRoomMoveInfo": { "description": "Indicates Scheduled Room Move In/Out information.", "$ref": "#/definitions/scheduledRoomMoveInfoType" }, "scheduledMoveInRoomId": { "description": "Indicates the scheduled Move-In Room Number.", "type": "string", "minLength": 0, "maxLength": 20 }, "scheduledMoveOutRoomId": { "description": "Indicates the scheduled Move-Out Room Number.", "type": "string", "minLength": 0, "maxLength": 20 }, "nationality": { "description": "Nationality code identification.", "type": "string", "minLength": 0, "maxLength": 20 }, "alternateGivenName": { "description": "Guest alternate given name, first name or any other names.", "type": "string", "minLength": 0, "maxLength": 40 }, "queue": { "description": "Information about the time and duration this reservation was on Queue for Checkin.", "$ref": "#/definitions/reservationQueueInformationType" } } }, "reservationId": { "type": "object", "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).", "properties": { "url": { "description": "URL that identifies the location associated with the record identified by the UniqueID.", "type": "string" }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 20 }, "instance": { "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", "type": "string", "minLength": 0, "maxLength": 80 }, "idContext": { "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string", "minLength": 0, "maxLength": 80 }, "id": { "description": "A 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.", "type": "string", "minLength": 0, "maxLength": 80 }, "idExtension": { "description": "Additional identifying value assigned by the creating system.", "type": "integer" } } }, "stayDateInfoType": { "type": "object", "description": "Room attached with stay detail information", "properties": { "timeSpan": { "$ref": "#/definitions/timeSpanType" }, "expectedTimes": { "$ref": "#/definitions/resExpectedTimesType" } } }, "timeSpanType": { "type": "object", "description": "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 add to the StartDate to yield end date.", "properties": { "startDate": { "type": "string", "format": "date", "maxLength": 8 }, "endDate": { "type": "string", "format": "date", "maxLength": 8 }, "duration": { "type": "string" } } }, "resExpectedTimesType": { "type": "object", "description": "Holds the Arrival and Departure Time Information", "properties": { "reservationExpectedArrivalTime": { "description": "Arrival Time. Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "reservationExpectedDepartureTime": { "description": "Departure Time. Uses the hotel's time zone.", "type": "string", "format": "date-time" } } }, "vIPStatusType": { "type": "object", "description": "VIP status of the customer.", "properties": { "value": { "type": "string", "description": "Used for Character Strings, length 0 to 2000.", "minLength": 0, "maxLength": 2000 }, "code": { "description": "VIP status of the customer.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "roomCondition": { "type": "object", "description": "Request element for setting room condition.", "properties": { "criteria": { "description": "Criteria to set the condition of a room.", "$ref": "#/definitions/setRoomConditionType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "setRoomConditionType": { "type": "object", "properties": { "hotelId": { "description": "The hotel code of the room on where the condition is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomNumberList": { "description": "List of room number at which condition is to be applied.", "$ref": "#/definitions/codeListType" }, "roomCondition": { "description": "Condition to be assigned on the room.", "$ref": "#/definitions/roomConditionType" }, "includeOccupiedRooms": { "description": "If set to true, condition is applied even if the room is occupied.", "type": "boolean" }, "overrideHoldRooms": { "description": "If set to true and the room is help by another user, then this lets the user override the room status.", "type": "boolean" } } }, "roomConditionRequestStatus": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "facilityForecast": { "type": "object", "description": "Response element for the fetched facility forecast.", "properties": { "facilityForecastDetails": { "type": "object", "description": "Facility Forecase type", "properties": { "tasks": { "description": "The facility forecast information.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/facilityTaskForecastType" } }, "totals": { "description": "Totals", "$ref": "#/definitions/facilityTotalForecastType" } } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "facilityTaskForecastType": { "type": "object", "description": "A facility task and its forecast.", "properties": { "taskForecast": { "description": "Forecast of quantities for this facility task.", "$ref": "#/definitions/forecastQuantitiesType" }, "facilityCodes": { "description": "Forecast of Facility codes belonging to this facility task.", "$ref": "#/definitions/facilityCodesForecastType" }, "task": { "description": "Facility Task.", "$ref": "#/definitions/codeDescriptionType" } } }, "forecastQuantitiesType": { "type": "array", "description": "Collection of dates and their quantities.", "maxItems": 4000, "items": { "$ref": "#/definitions/forecastQuantityType" } }, "forecastQuantityType": { "type": "object", "description": "Quatity data for a single day.", "properties": { "date": { "description": "Date of the statistic.", "type": "string", "format": "date", "maxLength": 8 }, "isWeekend": { "description": "Indicates whether the day is a weekend day or not.", "type": "boolean" }, "quantity": { "description": "The actual quantity", "type": "integer" }, "roomTypeBreakDown": { "description": "Collection of room types that have the task on this date.", "$ref": "#/definitions/roomTypeTasksType" } } }, "roomTypeTasksType": { "type": "array", "description": "This is a break-down of the different room types and their tasks count on a date.", "maxItems": 4000, "items": { "$ref": "#/definitions/roomTypeTaskType" } }, "roomTypeTaskType": { "type": "object", "description": "This is a room type and its tasks count.", "properties": { "roomType": { "description": "This is a room type and its tasks count.", "$ref": "#/definitions/codeDescriptionType" }, "tasksQuantity": { "description": "This is a room type and its tasks count.", "type": "integer" } } }, "facilityCodesForecastType": { "type": "array", "description": "Collection of facility codes with their forecasts.", "maxItems": 4000, "items": { "$ref": "#/definitions/facilityCodeForecastType" } }, "facilityCodeForecastType": { "type": "object", "description": "A facility code and its forecast.", "properties": { "forecast": { "description": "The forecast of quantities for this facility code.", "$ref": "#/definitions/forecastQuantitiesType" }, "code": { "description": "Facility Task code.", "$ref": "#/definitions/codeDescriptionType" } } }, "facilityTotalForecastType": { "type": "object", "description": "The Total of the forecasts.", "properties": { "totals": { "description": "Total forecast of all facility codes.", "$ref": "#/definitions/forecastTotalsQuantitiesType" }, "totalFacilityCodes": { "description": "Total forecast of each Facility code.", "$ref": "#/definitions/facilityCodesForecastType" } } }, "forecastTotalsQuantitiesType": { "type": "array", "description": "Collection of dates and their total quantities.", "maxItems": 4000, "items": { "$ref": "#/definitions/forecastTotalsQuantityType" } }, "forecastTotalsQuantityType": { "type": "object", "properties": { "date": { "description": "Date of the statistic.", "type": "string", "format": "date", "maxLength": 8 }, "isWeekend": { "description": "Indicates whether the day is a weekend day or not.", "type": "boolean" }, "quantity": { "description": "The actual quantity", "type": "integer" }, "roomTypeBreakDown": { "description": "Collection of room types that have the task on this date.", "$ref": "#/definitions/roomTypeTasksType" }, "totalCredits": { "description": "Total Credits on the specified date.", "type": "integer" } }, "description": "Quatity data for a single day." }, "taskAssignment": { "type": "object", "properties": { "taskAssignmentInfo": { "description": "Information regarding the Task Sheets for the Task Assignment.", "$ref": "#/definitions/housekeepingTaskAssignmentsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "housekeepingTaskAssignmentsType": { "type": "array", "description": "Collection of Assignments", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingTaskAssignmentType" } }, "housekeepingTaskAssignmentType": { "type": "object", "description": "Contains information for all the Task Sheets generated for a particular combination of Date and Task Code.", "properties": { "taskCodes": { "description": "The Task Code(s) for which the Task Sheets were generated.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingTaskCodeType" } }, "taskSheets": { "description": "List of Task Sheets generated for this assignment.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingTaskType" } }, "hotelId": { "description": "Property where the Task Assignment is done.", "type": "string", "minLength": 0, "maxLength": 20 }, "taskDate": { "description": "The date for which the Task Assignment is done. Date should be the current business date in most cases. Date cannot be in the past.", "type": "string", "format": "date", "maxLength": 8 }, "taskSheetsCount": { "type": "integer" } } }, "housekeepingTaskCodeType": { "type": "object", "description": "Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.", "properties": { "description": { "description": "Description of the Task Code.", "type": "string", "minLength": 0, "maxLength": 80 }, "instructions": { "description": "Instructions for this Task Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "facilityDepartureTask": { "description": "Indicates if this task code is the Departure Room Default Task to be scheduled on the departure date of the reservations. Defining a Departure Room Default Task is available when the 'Housekeeping Task Scheduling' OPERA Control is active.", "type": "boolean" }, "linenChange": { "description": "Indicates if a linen change is necessary.", "type": "boolean" }, "hotelId": { "description": "Property where this task code is configured.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "The Code for the task.", "type": "string", "minLength": 0, "maxLength": 20 }, "sequence": { "description": "Ordering sequence for display.", "type": "integer" } } }, "housekeepingTaskType": { "type": "object", "properties": { "taskCodes": { "description": "The Task Code(s) used for this Task Sheet.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingTaskCodeType" } }, "departureTaskInfo": { "description": "Facility task info related to the departure task.", "$ref": "#/definitions/departureTaskInfoType" }, "totalSupplies": { "description": "All Supplies, and their totals, associated with the Task Sheet.", "$ref": "#/definitions/facilityCodesType" }, "credits": { "description": "Credits information for this Task Sheet. This could have the Total Credit information and the Travelling credits if required.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingCreditsType" } }, "attendant": { "description": "Information regarding Housekeeping Attendants.", "type": "object", "properties": { "section": { "description": "Section Code the attendant has been assigned.", "$ref": "#/definitions/housekeepingSectionType" }, "floor": { "description": "The Floor which is assigned to the attendant.", "type": "string", "minLength": 0, "maxLength": 20 }, "attendantId": { "description": "Attendant's unique identifier.", "type": "string", "minLength": 0, "maxLength": 20 }, "attendantName": { "description": "Attendant's name.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelId": { "description": "Property where the attendant belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "activeFlag": { "description": "Indicates if the Attendant is active.", "type": "string", "minLength": 0, "maxLength": 1 }, "sunday": { "type": "boolean" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "attendantInstructions": { "type": "string", "maxLength": 2000 } } }, "appUserOnBreak": { "description": "Information about on break application user and start time.", "$ref": "#/definitions/appUserOnBreakType" }, "rooms": { "description": "Details of the room which is part of the Task Sheet. The room details will be returned when the request for IncludeTaskSheetDetails(flag in the search type) is true.", "type": "array", "maxItems": 4000, "items": { "type": "object", "properties": { "roomType": { "description": "Room type basic information of the room.", "$ref": "#/definitions/roomTypeShortInfoType" }, "floor": { "description": "Floor of the Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "floorDescription": { "description": "Description for the Floor of the Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomFeatures": { "description": "Room Features for the room.", "$ref": "#/definitions/roomFeaturesType" }, "roomDescription": { "description": "Detail Long Description Of The Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the room.", "$ref": "#/definitions/translationTextType2000" }, "smokingPreference": { "description": "This indicates room smoking preference.", "type": "string", "minLength": 0, "maxLength": 20 }, "smokingPreferenceDescription": { "description": "This indicates the description of the room smoking preference.", "type": "string", "minLength": 0, "maxLength": 20 }, "building": { "description": "Building associated with the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomAssignmentRating": { "description": "Assignment Rating associated with the room.", "$ref": "#/definitions/ratePlanRatingType" }, "isAccessible": { "description": "Indicates whether the room is accessibility compliant.", "type": "boolean" }, "roomId": { "description": "Code of the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "meetingRoom": { "description": "Indicates whether the room is a Meeting Room", "type": "boolean" }, "roomSection": { "description": "Room sections of the room.", "$ref": "#/definitions/roomSectionType" }, "housekeeping": { "description": "Identifies the Housekeeping information..", "$ref": "#/definitions/housekeepingType" }, "outOfOrder": { "description": "Identifies the room Out of Order/Out of Service information.", "$ref": "#/definitions/roomsOutOfOrderType" }, "discrepancy": { "description": "Identifies the room discrepancy information.", "$ref": "#/definitions/roomDiscrepanciesType" }, "sitePlanSection": { "description": "Identifies the site plan location of the room.", "$ref": "#/definitions/sitePlanSectionType" }, "componentRoomNumber": { "description": "This flag indicates component room.", "type": "string", "minLength": 0, "maxLength": 20 }, "connectingRooms": { "description": "This flag indicates connecting rooms.", "$ref": "#/definitions/roomRoomsType" }, "componentRooms": { "description": "This flag indicates component rooms.", "$ref": "#/definitions/roomRoomsType" }, "attendant": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/currentServicingAttendantType" } }, "hold": { "description": "Hold attributes if any.", "$ref": "#/definitions/roomHoldType" }, "turndownInfo": { "$ref": "#/definitions/turndownInfoType" }, "resvInfo": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/reservationShortInfoType" } }, "scheduledRoomMoveResvInfo": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/reservationShortInfoType" } }, "componentRoomNumbers": { "description": "List of component room numbers.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "reservationInfo": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/reservationInfoType" } }, "servicingInfo": { "description": "Information regarding the current servicing of the room.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/currentServicingAttendantType" } }, "instructions": { "description": "Task Sheet instructions at the room level.", "type": "string", "minLength": 0, "maxLength": 2000 }, "totalCredits": { "description": "Total credits for this room.", "type": "integer" }, "wakeUpTime": { "description": "The wake up time of the current date", "type": "string", "format": "date" }, "cleaningSequence": { "description": "The sequence for cleaning this room in the task sheet. This would apply only for Pickup and Dirty rooms.", "type": "integer" }, "defaultSequence": { "description": "The sequence for this room from configuration.", "type": "integer" }, "hasPriority": { "description": "The sequence for this room from configuration.", "type": "boolean" }, "maintenanceAllowed": { "description": "Flag if the Room, and the OperaV5 version, allows Room Maintenance or not.", "type": "boolean" } }, "description": "This type represents the primary room attributes." } }, "roomCounts": { "type": "array", "maxItems": 4000, "items": { "type": "object", "properties": { "value": { "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "type": "string", "enum": [ "Clean", "Dirty", "Pickup", "Inspected", "OutOfOrder", "OutOfService" ] }, "totalCount": { "type": "integer" } } } }, "linenChangeCount": { "description": "The total number of linen changes included in this task sheet.", "type": "integer" }, "sheetNumber": { "description": "The Task Sheet number. This will be a sequential number for the task sheets generated for a particular Task Code.", "type": "integer" }, "date": { "description": "The date for which the task sheet applies.", "type": "string", "format": "date" }, "nextDay": { "description": "Indicates the task sheet applies to Next Business Day.", "type": "boolean" }, "autoGenerated": { "description": "Indicates if the task sheet was automatically generated.", "type": "boolean" }, "lockTaskSheet": { "description": "Indicates if the task sheet was locked or not.", "type": "boolean" }, "taskSeqNo": { "description": "The sequence no of the task sheet.", "type": "integer" }, "roomCount": { "description": "The total number of rooms included in this task sheet.", "type": "integer" }, "taskInstructions": { "description": "Task Sheet level instructions. These instructions are applicable to this task sheet only.", "type": "string", "minLength": 0, "maxLength": 2000 }, "completedDate": { "description": "Date the task was completed.", "type": "string", "format": "date" }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "sheetType": { "description": "The Task Sheet type. Indicates how the task sheet was created and what type of rooms are part of it.", "$ref": "#/definitions/taskSheetType" }, "attendantStatus": { "description": "Status of Housekeeping Attendant assigned to this TaskSheet. This value holds the most recent status posted by the attendant.", "$ref": "#/definitions/servicingAttendantStatusType" }, "breakOutId": { "description": "Break out id of the task sheet.", "type": "integer" }, "completedRoomsCount": { "description": "The total number of completed rooms in this task sheet.", "type": "integer" } } }, "departureTaskInfoType": { "type": "object", "description": "Facility task info related to the departure task.", "properties": { "roomType": { "description": "Supplies based on the room type.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomTypeSuppliesType" } }, "code": { "description": "Facility task code of the departure task.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "roomTypeSuppliesType": { "type": "object", "description": "List of the facility codes.", "properties": { "facilityCode": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/facilityCodeType" } }, "type": { "description": "Room type code.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "facilityCodeType": { "type": "object", "description": "Facility Housekeeping Code, its description and quantity.", "properties": { "description": { "description": "Facility Code.", "type": "string", "minLength": 0, "maxLength": 80 }, "quantity": { "description": "Signifies the quantity.", "type": "integer" }, "code": { "description": "Facility code value.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "facilityCodesType": { "type": "array", "description": "List of the facility codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/facilityCodeType" } }, "housekeepingCreditsType": { "type": "object", "description": "Information regarding the credits for housekeeping tasks/rooms.", "properties": { "type": { "description": "The Type of Credit. Example: TOTAL credits for the task sheet, total TRAVELLING credits for the task sheet.", "$ref": "#/definitions/housekeepingCreditsDefinitionType" }, "numberOfCredits": { "description": "Total number of Credits for the Type.", "type": "number" } } }, "housekeepingCreditsDefinitionType": { "type": "string", "description": "Type for the different kinds of Credits which will be used in Rooms Management. ", "enum": [ "Departure", "Pickup", "Turndown", "StayOver", "FacilityTask", "Travelling", "Miscellaneous", "Special", "Total", "ItemInventory" ] }, "appUserOnBreakType": { "type": "object", "description": "Information about on break start time and the application user who goes on break.", "properties": { "appUser": { "description": "The application user name and id of the user who goes on break.", "$ref": "#/definitions/applicationUserType" }, "startTime": { "description": "Start time when the break started. Uses the hotel's time zone.", "type": "string", "format": "date-time" } } }, "sitePlanSectionType": { "type": "object", "description": "Represents the site plan section record.", "properties": { "sectionCode": { "description": "The site plan section code.", "type": "string", "minLength": 0, "maxLength": 20 }, "sectionType": { "description": "The section type.", "type": "string", "minLength": 0, "maxLength": 20 }, "linkCode": { "description": "The link code for the section.", "type": "string", "minLength": 0, "maxLength": 20 }, "coordinates": { "description": "The coordinates for this section.", "type": "string" }, "description": { "description": "The description of this section.", "type": "string" } } }, "reservationInfoType": { "type": "object", "description": "The Reservation class contains the current reservation being created or altered.", "properties": { "reservationIdList": { "description": "Unique identifiers for the reservation for both internal and external systems", "$ref": "#/definitions/reservationIdList" }, "externalReferences": { "description": "External Reference information for Reservation.", "$ref": "#/definitions/externalReferencesType" }, "roomStay": { "description": "Collection of room stays.", "$ref": "#/definitions/stayInfoType" }, "reservationGuest": { "description": "Collection of guests associated with the reservation.", "$ref": "#/definitions/resGuestInfoType" }, "sharedGuests": { "description": "Collection of guests who share this reservation.", "$ref": "#/definitions/resSharedGuestListType" }, "attachedProfiles": { "description": "List of attached profiles", "$ref": "#/definitions/resAttachedProfileListType" }, "reservationPaymentMethod": { "description": "Payment method used for this reservation", "$ref": "#/definitions/reservationPaymentMethodType" }, "reservationFolioWindows": { "description": "Collection of reservation folio windows.", "$ref": "#/definitions/reservationFolioWindowsType" }, "specials": { "description": "Set of reservation preferences which belongs to the Specials group.", "type": "string", "minLength": 0, "maxLength": 4000 }, "lastPrivacyPromptDate": { "description": "Last Privacy Prompt Date", "type": "string", "format": "date", "maxLength": 8 }, "displayColor": { "description": "Color setting of the reservation.", "type": "string", "minLength": 0, "maxLength": 20 }, "reservationIndicators": { "description": "Indicators of additional information attached to the reservation", "$ref": "#/definitions/indicatorsType" }, "housekeepingRoomStatus": { "description": "Current room status", "$ref": "#/definitions/housekeepingRoomStatusType" }, "searchMatches": { "description": "Super Search matching terms.", "$ref": "#/definitions/searchMatchesType" }, "sourceOfSale": { "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", "$ref": "#/definitions/sourceOfSaleType" }, "waitlist": { "description": "Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.", "$ref": "#/definitions/waitlistResType" }, "queue": { "description": "Information about the time and duration this reservation was on Queue for Checkin.", "$ref": "#/definitions/reservationQueueInformationType" }, "housekeeping": { "description": "Information regarding housekeeping for this reservation.", "$ref": "#/definitions/resHousekeepingType" }, "cashiering": { "description": "Holds cashiering related information for the reservation.", "$ref": "#/definitions/resCashieringType" }, "taxType": { "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", "$ref": "#/definitions/taxTypeType" }, "deposit": { "description": "Holds reservation deposit information.", "$ref": "#/definitions/reservationDepositType" }, "allowedActions": { "description": "Collection of reservation allowed actions.", "$ref": "#/definitions/reservationAllowedActionsType" }, "revenuesAndBalances": { "description": "Revenues and Balances Amount summary for the reservation.", "$ref": "#/definitions/resRevenueBalanceType" }, "hotelInterfaceStatusList": { "description": "Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/reservationInterfaceStatusType" } }, "guestPreferredCurrency": { "description": "Currency code preferred by guest.", "type": "string", "minLength": 0, "maxLength": 20 }, "turndownInfo": { "description": "Currency code preferred by guest.", "$ref": "#/definitions/reservationTurndownInfoType" }, "mobileNotifications": { "description": "Denotes the status of Room Ready, Key Ready messages.", "$ref": "#/definitions/resMobileNotificationsType" }, "reservationCommunication": { "description": "Collection of reservation communication details.", "$ref": "#/definitions/resCommunicationType" }, "advanceCheckIn": { "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", "$ref": "#/definitions/advanceCheckInType" }, "welcomeOffer": { "description": "This flag will determine wheather the reservation is eligible for Welcome Offer or not.", "type": "boolean" }, "cancellationInfo": { "description": "Information regarding why reservation has been/was cancelled.", "type": "object", "properties": { "description": { "type": "string", "minLength": 0, "maxLength": 2000 }, "code": { "type": "string", "minLength": 0, "maxLength": 20 }, "date": { "description": "Date when reservation was last cancelled.", "type": "string", "format": "date", "maxLength": 8 } } }, "keyCount": { "description": "Number of keys created for the reservation.", "type": "integer" }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "hotelName": { "type": "string", "minLength": 0, "maxLength": 80 }, "expectedServiceTime": { "type": "string", "minLength": 0, "maxLength": 20 }, "roomStayReservation": { "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.", "type": "boolean" }, "createDateTime": { "description": "Time stamp of the creation. Uses database time zone.", "type": "string", "format": "date-time" }, "creatorId": { "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.", "type": "string", "minLength": 0, "maxLength": 200 }, "lastModifyDateTime": { "description": "Time stamp of last modification. Uses database time zone.", "type": "string", "format": "date-time" }, "lastModifierId": { "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, "maxLength": 200 }, "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", "format": "date", "maxLength": 8 }, "reservationStatus": { "description": "Indicates the status of the reservation.", "$ref": "#/definitions/pMS_ResStatusType" }, "computedReservationStatus": { "description": "Indicates the status of the reservation.", "$ref": "#/definitions/pMS_ResStatusType" }, "walkInIndicator": { "description": "When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.", "type": "boolean" }, "accessRestriction": { "description": "Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.", "$ref": "#/definitions/resAccessRestrictionType" }, "commissionPayoutTo": { "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.", "$ref": "#/definitions/commissionPayoutToType" }, "paymentMethod": { "description": "Payment Method.", "type": "string", "minLength": 0, "maxLength": 20 }, "preRegistered": { "description": "Defines if the reservation is pre-registered or not.", "type": "boolean" }, "openFolio": { "description": "Returns true when reservation has an open folio.", "type": "boolean" }, "allowMobileCheckout": { "description": "Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.", "type": "boolean" }, "allowMobileViewFolio": { "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.", "type": "boolean" }, "optedForCommunication": { "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.", "type": "boolean" }, "backToBack": { "description": "Indicates if the Reservation is Back to Back Reservation. Available when the Back to Back Handling for Linked Reservations OPERA Control is active. ", "type": "boolean" }, "backToBackHSKIndicator": { "description": "Indicates if the Reservation is departing today with a Back to Back Reservation arriving today. Available when the Back to Back Handling for Linked Reservations OPERA Control is active.", "type": "boolean" }, "scheduledRoomMoveInfo": { "description": "Indicates Scheduled Room Move In/Out information.", "$ref": "#/definitions/scheduledRoomMoveInfoType" }, "scheduledMoveInRoomId": { "description": "Indicates the scheduled Move-In Room Number.", "type": "string", "minLength": 0, "maxLength": 20 }, "scheduledMoveOutRoomId": { "description": "Indicates the scheduled Move-Out Room Number.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "reservationIdList": { "type": "array", "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { "$ref": "#/definitions/uniqueID_Type" } }, "externalReferencesType": { "type": "array", "description": "This type contains unique information of external reference.", "maxItems": 4000, "items": { "$ref": "#/definitions/externalReferenceType" } }, "externalReferenceType": { "type": "object", "description": "This type contains unique information of external reference.", "properties": { "id": { "description": "Unique ID of external reference.", "type": "string", "minLength": 0, "maxLength": 80 }, "idExtension": { "description": "ID extension for external reference.", "type": "integer" }, "idContext": { "description": "ID context for external reference.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "stayInfoType": { "type": "object", "description": "Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.", "properties": { "arrivalDate": { "type": "string", "format": "date" }, "departureDate": { "type": "string", "format": "date" }, "originalTimeSpan": { "description": "The Original Time Span covers the Room Stay dates of the original reservation.", "$ref": "#/definitions/timeSpanType" }, "expectedTimes": { "description": "The expected arrival, return and departure times of the guest.", "$ref": "#/definitions/resExpectedTimesType" }, "adultCount": { "description": "A collection of Guest Counts associated with Room Stay.", "type": "integer" }, "childCount": { "description": "A collection of Child Counts associated with Room Stay.", "type": "integer" }, "roomClass": { "description": "Room class code", "type": "string", "minLength": 0, "maxLength": 20 }, "roomType": { "description": "Room type code", "type": "string", "minLength": 0, "maxLength": 20 }, "componentRoomType": { "description": "True indicates room type is a component type.", "type": "boolean" }, "numberOfRooms": { "description": "Room Id", "type": "integer" }, "roomId": { "description": "Room Id", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanCode": { "description": "Rate plan code", "type": "string", "minLength": 0, "maxLength": 20 }, "rateAmount": { "description": "Rate amount", "$ref": "#/definitions/currencyAmountType" }, "points": { "description": "The Points contains the number of points used to book a particular room type.", "$ref": "#/definitions/pointsType" }, "rateSuppressed": { "description": "Whether this rate should be suppressed from view", "type": "boolean" }, "reservationBlock": { "description": "Key information about the block for this reservation.", "$ref": "#/definitions/reservationBlockType" }, "bookingChannelCode": { "description": "Booking channel code", "type": "string", "minLength": 0, "maxLength": 20 }, "linkCode": { "description": "Party code", "type": "string", "maxLength": 2000 }, "fixedRate": { "description": "True if the rate is a fixed rate, otherwise false", "type": "boolean" }, "totalAmount": { "description": "The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.", "$ref": "#/definitions/currencyAmountType" }, "guarantee": { "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.", "$ref": "#/definitions/resGuaranteeType" }, "promotion": { "description": "Promotion Codes", "$ref": "#/definitions/promotionType" }, "marketCode": { "description": "Market code", "type": "string", "minLength": 0, "maxLength": 20 }, "marketDescription": { "description": "Description of Market code", "type": "string", "minLength": 0, "maxLength": 4000 }, "sourceCode": { "description": "Source of business", "type": "string", "minLength": 0, "maxLength": 20 }, "sourceCodeDescription": { "description": "Description of the source of business.", "type": "string", "minLength": 0, "maxLength": 4000 }, "balance": { "description": "Balance amount", "$ref": "#/definitions/currencyAmountType" }, "compBalance": { "description": "Comp Balance amount", "$ref": "#/definitions/currencyAmountType" }, "roomTypeCharged": { "description": "Room type code that was charged", "type": "string", "minLength": 0, "maxLength": 20 }, "depositPayments": { "description": "A collection of deposit and/or payments for the Room Stay.", "$ref": "#/definitions/currencyAmountType" }, "guestServiceStatus": { "description": "Service Status of In House guest like DND or MUP", "$ref": "#/definitions/guestHousekeepingServiceRequestType" }, "scheduledCheckoutTime": { "description": "Indicates that this reservation is scheduled for automated check out.", "type": "string", "format": "date" }, "roomNumberLocked": { "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.", "type": "boolean" }, "pseudoRoom": { "description": "True indicates as pseudoRoom room type. This is usually used for a posting master reservation.", "type": "boolean" }, "assignedByAI": { "description": "Represents the room was assigned by AI Room Assignment.", "type": "boolean" }, "upgradedByAI": { "description": "Represents the room was assigned by AI Room Assignment.", "type": "boolean" } } }, "currencyAmountType": { "type": "object", "description": "A monetary value expressed with a currency code.", "properties": { "amount": { "description": "A monetary amount.", "type": "number" }, "currencyCode": { "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", "type": "string", "minLength": 3, "maxLength": 3 } } }, "pointsType": { "type": "object", "description": "The Redeem Points contains the number of points required to book a room type.", "properties": { "awardsType": { "description": "Awards type for the award type rate code.", "type": "string" }, "points": { "description": "No of points required to book this Room Stay.", "type": "integer" } } }, "reservationBlockType": { "type": "object", "description": "Key information about the block for a reservation.", "properties": { "blockIdList": { "description": "Collection of unique block identifiers for the reservation.", "$ref": "#/definitions/blockIdList" }, "blockName": { "description": "The Name of the block that is attached to the reservation.", "type": "string", "minLength": 0, "maxLength": 40 }, "hotelId": { "description": "This is the HotelCode of the Block.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "blockIdList": { "type": "array", "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { "$ref": "#/definitions/uniqueID_Type" } }, "resGuaranteeType": { "type": "object", "description": "Validations type record returned after Validations are done.", "properties": { "guaranteeCode": { "description": "Guarantee Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "shortDescription": { "description": "Guarantee Code.", "type": "string", "minLength": 0, "maxLength": 80 }, "onHold": { "description": "Guarantee Code.", "type": "boolean" } } }, "promotionType": { "type": "object", "description": "Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.", "properties": { "promotionCode": { "description": "Promotion code associated with the rate plan.", "type": "string", "minLength": 0, "maxLength": 20 }, "promotionName": { "description": "Promotion code Name associated with the rate plan.", "type": "string", "minLength": 0, "maxLength": 20 }, "couponCode": { "description": "Promotion Coupon Code when promotion is setup to have a valid coupon code.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "resGuestInfoType": { "type": "object", "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.", "properties": { "membership": { "description": "The Membership object identifying the frequent customer reward program.", "$ref": "#/definitions/membershipInfoType" }, "namePrefix": { "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)", "$ref": "#/definitions/namePrefixType" }, "givenName": { "description": "Given name, first name or names", "$ref": "#/definitions/givenNameType" }, "alternateGivenName": { "description": "Alternate given name, first name or names", "type": "string", "minLength": 0, "maxLength": 40 }, "middleName": { "description": "The middle name of the person name", "type": "string", "minLength": 0, "maxLength": 40 }, "surnamePrefix": { "description": "e.g \"van der\", \"von\", \"de\"", "type": "string", "minLength": 0, "maxLength": 20 }, "surname": { "description": "Family name, last name.", "$ref": "#/definitions/surnameType" }, "alternateSurname": { "description": "Alternate family name, last name.", "type": "string", "minLength": 0, "maxLength": 40 }, "nameSuffix": { "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).", "type": "string", "minLength": 0, "maxLength": 20 }, "nameTitle": { "description": "Degree or honors (e.g., Ph.D., M.D.)", "type": "string", "minLength": 0, "maxLength": 20 }, "fullName": { "description": "Full display name", "type": "string" }, "alternateFullName": { "description": "Altername full display name", "type": "string" }, "phoneNumber": { "description": "Phone number", "$ref": "#/definitions/phoneNumberType" }, "email": { "description": "Email address", "$ref": "#/definitions/basicEmailType" }, "birthDate": { "description": "Date of birth", "type": "string", "format": "date", "maxLength": 8 }, "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "nationality": { "description": "Affiliation or ethnicity to a particular country.", "$ref": "#/definitions/countryNameType" }, "vip": { "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", "$ref": "#/definitions/vIPType" }, "address": { "description": "Address information that is attached to the reservation guest", "$ref": "#/definitions/addressSearchType" }, "anonymization": { "description": "Provides information about the guest's anonymization status", "$ref": "#/definitions/anonymizationType" }, "accompanyGuests": { "description": "List of guest names that are accompanying the reservation guest", "$ref": "#/definitions/resAccompanyGuestListType" }, "externalInfo": { "description": "External information about the guest associated with the reservation.", "$ref": "#/definitions/resGuestExternalInfoType" }, "guestLastStayInfo": { "description": "Contains information regarding the last stay of this guest.", "$ref": "#/definitions/guestLastStayInfoType" }, "guestRestrictedCode": { "description": "Guest profile restricted reason code", "type": "string" }, "guestRestrictedReasonDesc": { "description": "Guest profile restricted reason description", "type": "string" }, "guestRestricted": { "description": "True indicates there are restrictions associated with the current profile.", "type": "boolean" }, "registrationCardNo": { "description": "Unique identifier of the police registration card number.", "type": "string", "minLength": 0, "maxLength": 40 }, "nameType": { "$ref": "#/definitions/nameTypeType" }, "id": { "description": "A 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.", "type": "string", "minLength": 0, "maxLength": 80 }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "membershipInfoType": { "type": "object", "description": "The Membership object identifies the frequent customer reward program.", "properties": { "membershipId": { "description": "Membership ID (Unique ID from the memberships table).", "type": "number" }, "programCode": { "description": "The code or name of the membership program ('Hertz', 'AAdvantage', etc.).", "type": "string", "minLength": 0, "maxLength": 20 }, "bonusCode": { "description": "The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipTypeDesc": { "description": "The description of the ProgramCode.(Delta Previlige for code DP)", "type": "string", "minLength": 0, "maxLength": 2000 }, "membershipLevelDesc": { "description": "The description of the Bonus Code.(Platinum for code P)", "type": "string", "minLength": 0, "maxLength": 2000 }, "accountId": { "description": "The account identification number for this particular member in this particular program.", "type": "string", "minLength": 0, "maxLength": 50 }, "membershipLevel": { "description": "The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.", "type": "string", "minLength": 0, "maxLength": 20 }, "playerRanking": { "description": "Ranking assigned to the Player Profile by the Gaming system.", "type": "integer" } } }, "namePrefixType": { "type": "string", "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)", "minLength": 0, "maxLength": 40 }, "givenNameType": { "type": "string", "description": "Given name, first name or names", "minLength": 0, "maxLength": 40 }, "surnameType": { "type": "string", "description": "Family name, last name.", "minLength": 0, "maxLength": 40 }, "phoneNumberType": { "type": "string", "description": "Phone number", "minLength": 0, "maxLength": 40 }, "basicEmailType": { "type": "string", "description": "Email address", "minLength": 0, "maxLength": 2000 }, "vIPType": { "type": "object", "description": "The supplier's ranking of the customer.", "properties": { "vipCode": { "description": "VIP Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "vipDescription": { "description": "VIP Description.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "addressSearchType": { "type": "object", "description": "Address Details such as city, state, country, postal code etc.", "properties": { "cityName": { "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", "type": "string", "minLength": 0, "maxLength": 40 }, "postalCode": { "description": "Post Office Code number.", "type": "string", "minLength": 0, "maxLength": 15 }, "state": { "description": "State or Province name (e.g., Texas).", "type": "string", "minLength": 0, "maxLength": 20 }, "country": { "description": "Country name (e.g., Ireland).", "$ref": "#/definitions/countryNameType" }, "streetAddress": { "description": "First Line of Street Address. For profile search it matches the first Address line.", "type": "string", "minLength": 0, "maxLength": 80 }, "excludeNoCity": { "description": "When true indicates that only profiles with city will be fetched.", "type": "boolean" } } }, "anonymizationType": { "type": "object", "description": "Provides information about guest's anonymization status.", "properties": { "anonymizationStatus": { "description": "Status of anonymization such as Requested or Anonymized.", "$ref": "#/definitions/anonymizationStatusType" }, "anonymizationDate": { "description": "Date and Time when the guest was anonymized.", "type": "string", "format": "date-time" } } }, "anonymizationStatusType": { "type": "string", "description": "Guest has been anonymized.", "enum": [ "Requested", "Anonymized" ] }, "resAccompanyGuestListType": { "type": "array", "description": "Collection of accompany guests", "maxItems": 4000, "items": { "$ref": "#/definitions/resAccompanyGuestInfoType" } }, "resAccompanyGuestInfoType": { "type": "object", "properties": { "firstName": { "description": "Given name, first name or names", "type": "string" }, "lastName": { "description": "Family name, last name.", "type": "string" }, "fullName": { "description": "String representation of the full name", "type": "string" }, "registrationCardNo": { "description": "Unique identifier of the police registration card number.", "type": "string", "minLength": 0, "maxLength": 40 }, "profileIdList": { "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", "$ref": "#/definitions/profileIdList" } } }, "profileIdList": { "type": "array", "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { "$ref": "#/definitions/uniqueID_Type" } }, "resGuestExternalInfoType": { "type": "object", "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.", "properties": { "givenName": { "description": "Given name, first name or names", "$ref": "#/definitions/givenNameType" }, "surname": { "description": "Family name, last name.", "$ref": "#/definitions/surnameType" } } }, "guestLastStayInfoType": { "type": "object", "description": "Contains last stay related details of the guest.", "properties": { "lastStayDate": { "description": "Guest's last stay date.", "type": "string", "format": "date", "maxLength": 8 }, "lastStayRoom": { "description": "Room Number where the guest stayed.", "type": "string", "minLength": 0, "maxLength": 20 }, "lastStayRate": { "description": "The Rate amount of the guest's last stay.", "$ref": "#/definitions/currencyAmountType" }, "totalStay": { "description": "The total number of previous stay of the guest.", "type": "integer" } } }, "nameTypeType": { "type": "string", "enum": [ "Guest", "Company", "Agent", "Contact", "Source", "Group", "Employee", "Hotel", "Purge" ] }, "resSharedGuestListType": { "type": "array", "description": "Collection of shared guest reservations.", "maxItems": 4000, "items": { "$ref": "#/definitions/resSharedGuestInfoType" } }, "resSharedGuestInfoType": { "type": "object", "description": "Contains information regarding the share reservation.", "properties": { "profileId": { "$ref": "#/definitions/profileId" }, "firstName": { "description": "Given name, first name or names", "type": "string" }, "lastName": { "description": "Family name, last name.", "type": "string" }, "fullName": { "description": "String representation of the full name", "type": "string" } } }, "profileId": { "type": "object", "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).", "properties": { "url": { "description": "URL that identifies the location associated with the record identified by the UniqueID.", "type": "string" }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 20 }, "instance": { "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", "type": "string", "minLength": 0, "maxLength": 80 }, "idContext": { "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string", "minLength": 0, "maxLength": 80 }, "id": { "description": "A 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.", "type": "string", "minLength": 0, "maxLength": 80 }, "idExtension": { "description": "Additional identifying value assigned by the creating system.", "type": "integer" } } }, "resAttachedProfileListType": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/resAttachedProfileType" } }, "resAttachedProfileType": { "type": "object", "properties": { "name": { "description": "Attached profile name", "type": "string" }, "profileIdList": { "description": "Collection of unique profile identifiers", "$ref": "#/definitions/profileIdList" }, "reservationProfileType": { "$ref": "#/definitions/resProfileTypeType" } } }, "resProfileTypeType": { "type": "string", "enum": [ "Guest", "Company", "Group", "TravelAgent", "Source", "ReservationContact", "BillingContact", "Addressee" ] }, "reservationPaymentMethodType": { "type": "object", "properties": { "paymentCard": { "$ref": "#/definitions/resPaymentCardType" }, "balance": { "$ref": "#/definitions/currencyAmountType" }, "authorizationRule": { "$ref": "#/definitions/authorizationRuleType" }, "emailFolioInfo": { "description": "Information on an email for the customer.", "type": "object", "properties": { "email": { "description": "eMail deatils for the profile.", "$ref": "#/definitions/emailType" }, "emailFolio": { "type": "boolean" }, "id": { "description": "A 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.", "type": "string", "minLength": 0, "maxLength": 80 }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "paymentMethod": { "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "type": "string", "minLength": 0, "maxLength": 2000 }, "folioView": { "type": "integer" } } }, "resPaymentCardType": { "type": "object", "description": "Information on a credit card for the customer.", "properties": { "cardId": { "description": "credit card id", "$ref": "#/definitions/uniqueID_Type" }, "currentAuthorizedAmount": { "$ref": "#/definitions/currencyAmountType" }, "approvalAmountNeeded": { "$ref": "#/definitions/currencyAmountType" }, "cardType": { "description": "Indicates the type of credit card from a defined list", "$ref": "#/definitions/cardTypeType" }, "userDefinedCardType": { "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided", "type": "string", "minLength": 0, "maxLength": 2 }, "cardNumber": { "type": "string", "minLength": 0, "maxLength": 80 }, "cardNumberMasked": { "type": "string", "minLength": 0, "maxLength": 80 }, "cardNumberLast4Digits": { "type": "string", "minLength": 0, "maxLength": 80 }, "expirationDate": { "description": "Expiration date of the credit card", "type": "string", "format": "date", "maxLength": 8 }, "expirationDateMasked": { "description": "Masked Expiration date of the credit card", "type": "string", "minLength": 0, "maxLength": 20 }, "expirationDateExpired": { "type": "boolean" }, "cardHolderName": { "type": "string", "minLength": 0, "maxLength": 200 }, "attachCreditCardToProfile": { "description": "Attach the credit card to profile.", "type": "boolean" }, "processing": { "description": "This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.", "$ref": "#/definitions/cardProcessingType" }, "swiped": { "type": "boolean" }, "cardPresent": { "description": "Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.", "type": "boolean" }, "cardOrToken": { "description": "This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.", "$ref": "#/definitions/cardNumberTypeType" } } }, "cardTypeType": { "type": "string", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.", "enum": [ "Ab", "Am", "Ax", "Cb", "Dc", "Ds", "Dt", "Ec", "Er", "Jc", "Jl", "Mc", "Nb", "So", "St", "Sw", "Va", "Xy", "Zz", "Cp", "Cu" ] }, "cardProcessingType": { "type": "string", "enum": [ "Eft", "Manual" ] }, "cardNumberTypeType": { "type": "string", "description": "Simple type for indicating if credit card number is tokenized.", "enum": [ "CardNumber", "Token" ] }, "authorizationRuleType": { "type": "object", "description": "Configured rule for computing the amount to authorize.", "properties": { "code": { "description": "The authorization rule code.", "type": "integer", "pattern": "[0-9]{1,9}" }, "amount": { "description": "The amount applicable to the authorization rule.", "$ref": "#/definitions/currencyAmountType" }, "percent": { "description": "A percentage value if the authorization rule is percentage based.", "type": "number" } } }, "reservationFolioWindowsType": { "type": "array", "description": "Collection of reservation folio windows.", "maxItems": 4000, "items": { "$ref": "#/definitions/reservationFolioWindowType" } }, "reservationFolioWindowType": { "type": "object", "description": "Folio window view which holds the set of folios for a reservation.", "properties": { "payeeInfo": { "description": "The window's configured payee information.", "$ref": "#/definitions/payeeInfoType" }, "balance": { "description": "Running balance of the window.", "$ref": "#/definitions/currencyAmountType" }, "paymentMethod": { "description": "Payment Method Type", "type": "string", "minLength": 0, "maxLength": 20 }, "folioWindowNo": { "type": "integer" } } }, "payeeInfoType": { "type": "object", "description": "Payee information.", "properties": { "payeeId": { "description": "Opera name id of the payee.", "$ref": "#/definitions/uniqueID_Type" }, "payeeName": { "description": "Name of the payee.", "type": "string", "minLength": 0, "maxLength": 80 }, "payeeAddress": { "description": "Address of the payee.", "$ref": "#/definitions/addressInfoType" }, "payeeAddressCount": { "description": "Payee multiple address count.", "type": "integer" }, "payeeReferenceCurrency": { "description": "Reference currency of the payee.", "type": "string", "minLength": 0, "maxLength": 20 }, "payeeAccountInfo": { "description": "AR account short info of the payee.", "$ref": "#/definitions/aRAccountShortInfoType" }, "payeeTaxNumber": { "description": "The tax number of the payee.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "aRAccountShortInfoType": { "type": "object", "description": "Accounts Receivabales Account details type charged for batched posting.", "properties": { "accountName": { "description": "Name of the AR Account.", "type": "string", "minLength": 0, "maxLength": 200 }, "accountId": { "description": "The unique ID for the Account.", "$ref": "#/definitions/uniqueID_Type" }, "accountNo": { "description": "The Account Number for the Account.", "type": "string", "minLength": 0, "maxLength": 20 }, "status": { "description": "The status of the account.", "$ref": "#/definitions/aRAccountStatusType" } } }, "aRAccountStatusType": { "type": "object", "description": "Type for the Account Status. Status can be restricted and a message/description added to the Account.", "properties": { "restriction": { "description": "The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "User defined status message on the Account.", "type": "string", "minLength": 0, "maxLength": 2000 }, "restricted": { "description": "Flag to indicate if the Account is restricted.", "type": "boolean" } } }, "indicatorsType": { "type": "array", "description": "Collection of lamp indicators.", "maxItems": 4000, "items": { "$ref": "#/definitions/indicatorType" } }, "indicatorType": { "type": "object", "description": "Lamp indicator Type.", "properties": { "indicatorName": { "description": "Name of the indicator.", "type": "string", "minLength": 0, "maxLength": 80 }, "count": { "description": "Indicates number of occurrences of the indicator.", "type": "integer" } } }, "searchMatchesType": { "type": "array", "description": "List of Generic Name-Value-Pair Parameters used for super search matches.", "maxItems": 4000, "items": { "$ref": "#/definitions/searchMatchType" } }, "searchMatchType": { "type": "object", "description": "Search match indicating attribute and the matching value.", "properties": { "attribute": { "description": "Search match attribute.", "type": "string", "minLength": 0, "maxLength": 2000 }, "value": { "description": "Search match value.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "sourceOfSaleType": { "type": "object", "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", "properties": { "sourceType": { "description": "Type of entity/channel who made the reservation..", "type": "string", "minLength": 0, "maxLength": 40 }, "sourceCode": { "description": "The entity/channel who made the reservation.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "waitlistResType": { "type": "object", "description": "Information regarding why reservation is being /has been waitlisted.", "properties": { "reasonDescription": { "description": "Waitlist Reason Description.", "type": "string", "minLength": 0, "maxLength": 2000 }, "priorityDescription": { "description": "Waitlist priority Description.", "type": "string", "minLength": 0, "maxLength": 2000 }, "description": { "description": "Description why the reservation is being /has been waitlisted.", "type": "string", "minLength": 0, "maxLength": 2000 }, "reasonCode": { "description": "Waitlist Reason Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "priorityCode": { "description": "Waitlist Priority Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "telephone": { "description": "Guest telephone number.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "reservationQueueInformationType": { "type": "object", "description": "Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.", "properties": { "timeSpan": { "description": "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 add to the StartDate to yield end date.", "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "maxLength": 8 }, "endDate": { "type": "string", "format": "date", "maxLength": 8 }, "duration": { "type": "string" }, "durationInSeconds": { "description": "The total duration, in seconds, the reservation is on Queue.", "type": "integer" } } }, "guestTextInfo": { "description": "Information for the message sent to the user", "$ref": "#/definitions/queueTextInfoType" }, "priority": { "description": "The Queue Priority given to this reservation.", "type": "integer" }, "averageQueueTimeToCheckIn": { "description": "The average time, in seconds, a reservation was on queue prior to Check-In.", "type": "integer" }, "averageQueueTimeCurrentReservations": { "description": "The average time, in seconds, of the reservations currently in queue.", "type": "integer" }, "queueDate": { "description": "The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.", "type": "string", "format": "date", "maxLength": 8 } } }, "queueTextInfoType": { "type": "object", "description": "Information regarding the message sent to guest.", "properties": { "sentTime": { "description": "Time the text was last sent to the user.", "type": "string", "format": "date-time" }, "sentBy": { "description": "User name of the user who sent message.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "resHousekeepingType": { "type": "object", "description": "Holds housekeeping turndown service information for the room.", "properties": { "instructions": { "description": "Turndown instructions for the room.", "type": "string", "maxLength": 500 }, "facilityTaskInfo": { "description": "The facility task applicable for the current day. This will be information only and not used for any updates.", "$ref": "#/definitions/facilityTaskType" }, "linenChange": { "description": "Indicates if a linen change is necessary.", "type": "boolean" }, "status": { "description": "This will set/fetch housekeeping service request for room.", "$ref": "#/definitions/guestHousekeepingServiceRequestType" }, "cleaningPriority": { "description": "This will set/fetch cleaning priority for room.", "type": "boolean" }, "turndownRequested": { "description": "Indicates whether guest wants turndown facility or not.", "type": "boolean" }, "serviceTime": { "description": "This is the Turndown room service time.", "type": "string", "format": "date", "maxLength": 8 }, "expectedServiceTime": { "description": "Expected Start Time for housekeeping task(s).", "type": "string" }, "housekeepingRoomStatus": { "description": "Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.", "$ref": "#/definitions/housekeepingRoomStatusType" } } }, "facilityTaskType": { "type": "object", "description": "Information regarding facility task on a reservation.", "properties": { "task": { "description": "The Task Code.", "$ref": "#/definitions/housekeepingTaskCodeType" }, "supplies": { "description": "Supplies associated with the task.", "$ref": "#/definitions/facilityCodesType" }, "date": { "description": "The Date on which the task is applicable.", "type": "string", "format": "date", "maxLength": 8 } } }, "resCashieringType": { "type": "object", "description": "Cashiering Information for the reservation.", "properties": { "revenuesAndBalances": { "description": "Revenues and Balances Amount summary for the reservation.", "$ref": "#/definitions/resRevenueBalanceType" }, "billingPrivileges": { "description": "Billing privileges set on the reservation.", "$ref": "#/definitions/billingPrivilegesType" }, "taxType": { "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", "$ref": "#/definitions/reservationTaxTypeInfo" }, "bedTaxReporting": { "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", "$ref": "#/definitions/bedTaxReportingType" }, "folioTexts": { "description": "Additional text fields to display on the folio.", "$ref": "#/definitions/folioTextsType" }, "periodicFolio": { "description": "Information regarding periodic folios set on the reservation.", "$ref": "#/definitions/resPeriodicFolioType" }, "compAccounting": { "description": "Information regarding comp accounting on the reservation.", "$ref": "#/definitions/resCompAccountingType" }, "reservationPreConfiguredRoutingInstruction": { "description": "Information regarding the selected preconfigured routing instruction on the reservation.", "$ref": "#/definitions/resPreConfiguredRoutingInstrType" }, "financiallyResponsible": { "description": "The guest from whom payment has to be recovered (direct guest).", "type": "boolean" }, "proratedBilling": { "description": "In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.", "type": "boolean" }, "lastRoomAndTaxPostedDate": { "description": "Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.", "type": "string", "format": "date", "maxLength": 8 }, "reverseCheckInAllowed": { "description": "This attribute is to verify if reverse check-in is allowed for the reservation.", "type": "boolean" }, "reverseAdvanceCheckInAllowed": { "description": "This attribute is to verify if reverse advance check-in is allowed for the reservation.", "type": "boolean" }, "transactionsPosted": { "description": "Specifies whether reservation has a financial transaction associated with it.", "type": "boolean" } } }, "resRevenueBalanceType": { "type": "object", "description": "Revenue and Balance Amount summary for the reservation.", "properties": { "totalFixedCharge": { "description": "Total Fixed Charges on the reservation.", "$ref": "#/definitions/currencyAmountType" }, "totalPayment": { "description": "Total payment received for the reservation.", "$ref": "#/definitions/currencyAmountType" }, "roomRevenue": { "description": "Room Revenue generated by the reservation.", "$ref": "#/definitions/currencyAmountType" }, "foodAndBevRevenue": { "description": "Food and Beverage Revenue generated by the reservation.", "$ref": "#/definitions/currencyAmountType" }, "otherRevenue": { "description": "Other Revenue generated by the reservation.", "$ref": "#/definitions/currencyAmountType" }, "nonRevenue": { "description": "Total Non Revenue posted on the reservation.", "$ref": "#/definitions/currencyAmountType" }, "totalRevenue": { "description": "Total Revenue generated by the reservation.", "$ref": "#/definitions/currencyAmountType" }, "balance": { "description": "Balance amount on the reservation.", "$ref": "#/definitions/currencyAmountType" }, "compBalance": { "description": "Comp Balance amount", "$ref": "#/definitions/currencyAmountType" } } }, "billingPrivilegesType": { "type": "object", "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", "properties": { "postingRestriction": { "description": "Flag used by interface program during check in.", "type": "boolean" }, "preStayCharging": { "description": "Indicates if the reservation has charging privileges before arrival.", "type": "boolean" }, "postStayCharging": { "description": "Indicates if the reservation has charging privileges after checkout.", "type": "boolean" }, "folioCloseDate": { "description": "Date when folio was closed. This works with PostStayCharging flag.", "type": "string", "format": "date", "maxLength": 8 }, "scheduledCheckout": { "description": "Indicates if the guest is scheduled for automatic check out.", "type": "boolean" }, "scheduledCheckoutTime": { "description": "Time of automatic check out if guest is schedule for automatic check out.", "type": "string", "format": "date", "maxLength": 8 }, "directBillAuthorized": { "description": "If Direct bill is authorized this will hold User ID who authorized it.", "type": "boolean" }, "videoCheckout": { "description": "Indicates if the guest can do video checkout", "type": "boolean" }, "allowAutoCheckin": { "description": "Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudoRoom room types only.", "type": "boolean" }, "autoSettlement": { "description": "Indicates if the is a candidate for auto folio settlement.", "type": "boolean" }, "autoSettlementType": { "description": "The folio settlement type for auto folio settlement.", "type": "string", "minLength": 0, "maxLength": 40 }, "autoSettlementFreq": { "description": "The interval of days between each auto folio settlement.", "type": "integer" }, "creditLimitAutoPay": { "description": "Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.", "type": "boolean" } } }, "reservationTaxTypeInfo": { "type": "object", "description": "Provides information about the Tax Type.", "properties": { "hotelId": { "description": "Code of the Hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Code of the Tax Type.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Tax Type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "collectingAgentTax": { "description": "A boolean flag for Collecting Agent Tax", "type": "boolean" }, "printAutoAdjust": { "description": "Print auto adjust information for this tax type on the tax exempt report.", "type": "boolean" }, "reportExemptDays": { "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.", "type": "integer" }, "reportTaxPercentage": { "description": "Tax percentage. Only used for tax exempt report.", "type": "number", "minimum": 0, "maximum": 100 }, "minimumLengthOfStay": { "description": "Minimun Length of Stay.", "type": "integer" }, "taxExemptNo": { "description": "Tax exempt number on the profile.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "bedTaxReportingType": { "type": "object", "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", "properties": { "taxRegistrationNo": { "description": "Tax Registration Number for Maldives Bed Tax Reporting.", "type": "number" }, "visaNumber": { "description": "Visa number used for Maldives Bed Tax Reporting", "type": "string", "minLength": 0, "maxLength": 40 }, "visaIssueDate": { "description": "Visa Issue Date used for Maldives Bed Tax Reporting.", "type": "string", "format": "date", "maxLength": 8 }, "visaExpiryDate": { "description": "Visa Expiration Date used for Maldives Bed Tax Reporting", "type": "string", "format": "date", "maxLength": 8 }, "taxableDays": { "description": "Number of days for which the Maldives tax is applicable.", "type": "integer" } } }, "folioTextsType": { "type": "array", "description": "This stores the description for the type of tax calculation especially with tax exemption, etc.", "maxItems": 2, "items": { "type": "object", "properties": { "text": { "description": "Additional text field to display on the folio.", "type": "string", "minLength": 0, "maxLength": 50 }, "row": { "description": "Row number of the additional text.", "type": "integer" } } } }, "resPeriodicFolioType": { "type": "object", "description": "Information regarding periodic folios set on the reservation.", "properties": { "lastSettlementDate": { "description": "Latest date when a direct bill settlement was automatically done using the \"Direct Bill Batch Folios\" option.", "type": "string", "format": "date", "maxLength": 8 }, "lastFolioDate": { "description": "Latest date when a folio was printed using the \"Periodic Batch Folios\" option", "type": "string", "format": "date", "maxLength": 8 }, "frequency": { "description": "Frequency in number of days when folios should be printed for this reservation.", "type": "integer" } } }, "resCompAccountingType": { "type": "object", "description": "Information regarding comp accounting on the reservation.", "properties": { "compType": { "description": "Code used to identify the casino comp type and ranking of a guest.", "type": "string", "minLength": 0, "maxLength": 20 }, "authorizer": { "description": "ID of the employee who will act as the host for this guest.", "type": "string", "minLength": 0, "maxLength": 40 }, "compPostings": { "description": "Indicates if the Comp Billing/posting Exist", "type": "string", "minLength": 0, "maxLength": 5 } } }, "resPreConfiguredRoutingInstrType": { "type": "object", "description": "Instruction to attach Pre-Configured Routing Instructions to a Reservation.", "properties": { "authorizerInfo": { "description": "The authorizer information for Promotion Code with attached Complimentary Routing", "$ref": "#/definitions/authorizerInfoType" }, "ratePlanCode": { "description": "Rate Code with attached Routing Instruction.", "type": "string", "minLength": 0, "maxLength": 20 }, "profileType": { "description": "Profile Type with attached Routing Instruction.", "$ref": "#/definitions/resProfileTypeType" }, "promotionCode": { "description": "Promotion Code with attached Complimentary Routing.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "authorizerInfoType": { "type": "object", "description": "Authorizer Information", "properties": { "authorizerId": { "$ref": "#/definitions/uniqueID_Type" }, "authorizerUserName": { "description": "Application user name of the authorizer", "type": "string", "minLength": 0, "maxLength": 40 }, "authorizerName": { "description": "Full name of the authorizer.", "type": "string", "minLength": 0, "maxLength": 100 }, "authorizerRateCode": { "description": "Rate code of the authorizer.", "type": "string", "minLength": 0, "maxLength": 20 }, "inheritAuthorizerRateCode": { "description": "Indicates whether user has the choice to have reservation inherit rate code from the authorizer.", "type": "boolean" } } }, "taxTypeType": { "type": "object", "description": "Provides information about the Tax Type.", "properties": { "hotelId": { "description": "Code of the Hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Code of the Tax Type.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Tax Type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "collectingAgentTax": { "description": "A boolean flag for Collecting Agent Tax", "type": "boolean" }, "printAutoAdjust": { "description": "Print auto adjust information for this tax type on the tax exempt report.", "type": "boolean" }, "reportExemptDays": { "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.", "type": "integer" }, "reportTaxPercentage": { "description": "Tax percentage. Only used for tax exempt report.", "type": "number", "minimum": 0, "maximum": 100 }, "minimumLengthOfStay": { "description": "Minimun Length of Stay.", "type": "integer" } } }, "reservationDepositType": { "type": "object", "description": "Reservation Deposit Type.", "properties": { "amountRequired": { "description": "Deposit Amount Required.", "type": "number" }, "amountPaid": { "description": "Deposit Amount Paid.", "type": "number" }, "amountOwed": { "description": "Deposit Amount Owed.", "type": "number" }, "dueDate": { "description": "Deposit Due Date.", "type": "string", "format": "date", "maxLength": 8 }, "postingDate": { "description": "Deposit Posting Date.", "type": "string", "format": "date", "maxLength": 8 }, "hasPaid": { "description": "Resolves whether reservation has paid deposit.", "type": "boolean" }, "hasOutstanding": { "description": "Resolves whether reservation has outstanding deposit.", "type": "boolean" } } }, "reservationAllowedActionsType": { "type": "array", "description": "Allowed action.", "maxItems": 11, "items": { "$ref": "#/definitions/reservationAllowedActionType" } }, "reservationAllowedActionType": { "type": "string", "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.", "enum": [ "Cancel", "Move", "PreCharge", "PostCharge", "FacilitySchedule", "Upsell", "PreCheckIn", "PostToNoShowCancel", "NoShow", "NameChange", "Discount", "EnrollToPrimaryMembership", "EnrollInProgress" ] }, "reservationInterfaceStatusType": { "type": "object", "description": "Hotel Interface Type for a reservation and status of the various services", "properties": { "roomExtension": { "description": "Identifier for the room extension", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelInterface": { "description": "Hotel interface information for the reservation", "$ref": "#/definitions/hotelInterfaceType" }, "interfaceRights": { "description": "Contains a list of status/rights for the various services under this interface", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/interfaceRightsStatusType" } } } }, "hotelInterfaceType": { "type": "object", "properties": { "interfaceId": { "description": "Unique DB internal number of a Hotel Interface record.", "$ref": "#/definitions/uniqueID_Type" }, "hotelId": { "description": "Hotel Code", "type": "string", "minLength": 0, "maxLength": 20 }, "interfaceName": { "description": "Name of the Hotel Interface", "type": "string", "minLength": 0, "maxLength": 40 }, "interfaceType": { "description": "Three letter code for each interface that identifies the interface.", "$ref": "#/definitions/hotelInterfaceTypeType" }, "logo": { "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", "type": "string", "minLength": 0, "maxLength": 20 }, "machineName": { "description": "Unique machine name of the running IFC.", "type": "string", "minLength": 0, "maxLength": 80 }, "status": { "description": "The current status of the IFC.", "$ref": "#/definitions/hotelInterfaceStatusType" }, "activeFlag": { "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", "type": "boolean" } } }, "hotelInterfaceTypeType": { "type": "string", "enum": [ "Bms", "Cas", "Ccw", "Dls", "Eft", "Exp", "Mak", "Mbs", "Msc", "Pbx", "Pos", "Svs", "Tik", "Vid", "Vms", "Www", "Xml" ], "description": "XML Posting Interface" }, "hotelInterfaceStatusType": { "type": "string", "description": "Status of the Hotel Interface either STOPPED or RUNNING.", "enum": [ "Stopped", "Running", "Waiting", "StopInitiated", "StartInitiated", "RebootInitiated", "Other" ] }, "interfaceRightsStatusType": { "type": "object", "properties": { "right": { "description": "Internal code for each allowed right of a Hotel Interface record.", "type": "integer" }, "statusCode": { "description": "User defined code for an Interface Right.", "type": "string", "minLength": 0, "maxLength": 5 }, "description": { "description": "User defined description for an Interface Right.", "type": "string", "minLength": 0, "maxLength": 80 }, "category": { "description": "Category code of this interface right.", "type": "string", "minLength": 0, "maxLength": 1 } } }, "reservationTurndownInfoType": { "type": "object", "description": "Turndown information for a reservation", "properties": { "allowed": { "description": "Indicates if turndown is allowed or not", "type": "boolean" }, "status": { "description": "Indicates turndown status, values could be required, not required, completed", "$ref": "#/definitions/turndownStatusType" } } }, "resMobileNotificationsType": { "type": "object", "description": "Contains the status of Room Ready and Key Ready messages.", "properties": { "roomReady": { "description": "Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED", "$ref": "#/definitions/communicationStatusType" }, "keyReady": { "description": "Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED", "$ref": "#/definitions/communicationStatusType" }, "checkoutMessageReceived": { "description": "Indicates if the Mobile checkout message is received.", "type": "boolean" }, "requiresAction": { "description": "Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout", "type": "boolean" }, "errorMessage": { "description": "Error message when Mobile Notification has failed.", "type": "string" } } }, "communicationStatusType": { "type": "string", "description": "Enum to denote the Status of Readiness messages sent to Guest Devices.", "enum": [ "Pending", "Completed", "Failed", "Sent", "Received", "Cancelled", "PendingAvailability" ] }, "resCommunicationType": { "type": "object", "description": "Communication details for a reservation.", "properties": { "telephones": { "description": "List of Telephone Number Information", "type": "object", "properties": { "telephoneInfo": { "description": "Collection of Detailed information on telephone/fax for the customer.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/telephoneInfoType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "emails": { "description": "List of email address for the customer.", "type": "object", "properties": { "emailInfo": { "description": "Collection of Detailed information on an eMail address for the customer.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/emailInfoType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } } } }, "advanceCheckInType": { "type": "object", "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", "properties": { "advanceCheckedIn": { "description": "Indicates if the reservation is marked as Advance Checked In", "type": "boolean" }, "expectedReturnTime": { "description": "Expected Return Time", "type": "string", "format": "date-time" }, "eTRComments": { "description": "ETR Comments", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "pMS_ResStatusType": { "type": "string", "description": "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.", "enum": [ "Reserved", "Requested", "NoShow", "Cancelled", "InHouse", "CheckedOut", "Waitlisted", "DueIn", "DueOut", "Walkin", "PendingCheckout" ] }, "resAccessRestrictionType": { "type": "string", "description": "Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.", "enum": [ "Change", "Cancel", "ChangeOrCancel" ] }, "commissionPayoutToType": { "type": "string", "enum": [ "TravelAgent", "Source", "TravelAgentSource", "None" ] }, "taskSheetType": { "type": "string", "description": "Task Sheet classification.", "enum": [ "NoServiceRequired", "DoNotDisturb", "ManuallyCreated", "AutomaticGeneration", "Isolated", "ExtraRooms", "ServiceDeclined" ] }, "housekeepingBoard": { "type": "object", "properties": { "housekeepingRoomInfo": { "description": "Collection of Housekeeping Rooms and their information as well as paging attributes.", "type": "object", "properties": { "housekeepingRooms": { "description": "List of rooms and the room status.", "$ref": "#/definitions/hotelRoomsType" }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, "offset": { "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, "limit": { "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "housekeepingRoomStatusInfoList": { "description": "Collection of Housekeeping Room Status Information.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingRoomStatusInfo" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "housekeepingRoomStatusInfo": { "type": "object", "description": "Housekeeping Room Status Info Type", "properties": { "housekeepingRoomStatus": { "type": "string" }, "numberOfRooms": { "type": "integer" }, "code": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "roomMaintenance": { "type": "object", "description": "Request to change room maintenance details.", "properties": { "criteria": { "description": "Criteria to change a room maintenance request.", "$ref": "#/definitions/roomMaintenanceChangeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomMaintenanceChangeType": { "type": "object", "description": "Base maintenance type", "properties": { "maintenanceCode": { "description": "Maintenance Code", "type": "string", "minLength": 0, "maxLength": 20 }, "remarks": { "description": "Maintenance remarks", "type": "string", "minLength": 0, "maxLength": 2000 }, "maintenanceId": { "description": "Unique maintenance identifier.", "$ref": "#/definitions/uniqueID_Type" }, "assignedUserInfo": { "description": "Maintenance request assignment information", "$ref": "#/definitions/assignedUserType" }, "roomId": { "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "assignedUserType": { "type": "object", "description": "This contains assignment information for the maintenance request.", "properties": { "assignedToUser": { "description": "User to whom this maintenance request has been assigned.", "$ref": "#/definitions/uniqueID_Type" }, "assignedToUserName": { "description": "Name of user to whom this maintenance request has been assigned.", "type": "string", "minLength": 0, "maxLength": 100 }, "assignedByUser": { "description": "User who assigned this maintenance request", "$ref": "#/definitions/uniqueID_Type" }, "assignedByUserName": { "description": "Name of user who assigned this maintenance request.", "type": "string", "minLength": 0, "maxLength": 100 }, "expectedByDate": { "description": "Date when this task is due.", "type": "string", "format": "date", "maxLength": 8 }, "assignedDate": { "description": "Date when this task was assigned.", "type": "string", "format": "date", "maxLength": 8 } } }, "resolvedRoomMaintenance": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "unresolvedRoomMaintenance": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "moveTaskRooms": { "type": "object", "description": "Request for moving rooms between task sheets.", "properties": { "criteria": { "description": "Criteria for moving task sheet rooms. Contains the task sheets information regarding task code, date, sheet number and the rooms which have to be moved.", "$ref": "#/definitions/moveTaskRoomsCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "moveTaskRoomsCriteriaType": { "type": "object", "description": "Type for moving rooms between two task sheets.", "properties": { "rooms": { "description": "List of rooms which have to be moved from one task sheet to another.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomType" } }, "taskCode": { "description": "The task code for the task sheets, for which the rooms are being moved.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingTaskCodeType" } }, "hotelId": { "description": "The property where the task sheets exist for which the rooms are being moved.", "type": "string", "minLength": 0, "maxLength": 20 }, "taskDate": { "description": "The date of the task sheet.", "type": "string", "format": "date", "maxLength": 8 }, "fromTaskSheetNumber": { "description": "The task sheet number from which the rooms are being moved.", "type": "integer" }, "toTaskSheetNumber": { "description": "The task sheet number to which the rooms should be moved.", "type": "integer" } } }, "movedTaskRoomsRS": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestHousekeepingInstructions": { "type": "object", "description": "Return object that contains guest housekeeping instructions for the reservation/room.", "properties": { "guestHouseKeepingInstructions": { "description": "Collection of information about reservation attachments returned/fetched as per the criteria in the fetch request.", "$ref": "#/definitions/resHousekeepingType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestHousekeepingServiceRequest": { "type": "object", "description": "Operation to get set guest housekeeping instructions for the room.", "properties": { "guestHousekeepingInstructions": { "description": "Criteria for setting guest housekeeping instructions.", "$ref": "#/definitions/resHousekeepingSetType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "resHousekeepingSetType": { "type": "object", "description": "Search Criteria for retrieving guest housekeeping instructions.", "properties": { "hotelId": { "description": "Hotel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "reservationId": { "description": "Unique ID of the reservation that housekeeping instruction is linked to.", "$ref": "#/definitions/reservationId" }, "room": { "description": "Room to which housekeeping record belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "housekeepingInstruction": { "description": "housekeeping instructions that should be used.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/housekeepingInstructionsType" } }, "housekeepingInstructions": { "description": "Instructions and associated variables.", "$ref": "#/definitions/resHousekeepingType" } } }, "housekeepingInstructionsType": { "type": "string", "description": "Simple type for housekeeping instructions that can be used in requests for partial operations.", "enum": [ "Turndown", "CleaningPriority", "ServiceRequest" ] }, "guestHousekeepingService": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "schedule": { "type": "object", "description": "Return object that contains a list of facility tasks for the reservation specified in RQ.", "properties": { "reservationId": { "$ref": "#/definitions/reservationId" }, "hotelId": { "description": "The hotel where task is being scheduled.", "$ref": "#/definitions/codeType" }, "guestHouseKeepingInstructions": { "description": "Guest housekeeping instructions associated with the reservation requested.", "$ref": "#/definitions/resHousekeepingType" }, "housekeepingSchedule": { "description": "Facility housekeeping schedule for the reservation requested.", "$ref": "#/definitions/reservationHousekeepingScheduleType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "codeType": { "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", "minLength": 0, "maxLength": 20 }, "reservationHousekeepingScheduleType": { "type": "object", "description": "Criteria type for fetching reservation housekeeping schedule.", "properties": { "facilityHousekeepingTasks": { "description": "List of facility tasks to be performed for the reservation.", "$ref": "#/definitions/facilityHousekeepingTasksType" }, "start": { "description": "Date at which facility tasks started being retrieved.", "type": "string", "format": "date", "maxLength": 8 }, "end": { "description": "Date at which facility tasks stopped being retrieved.", "type": "string", "format": "date", "maxLength": 8 }, "customized": { "description": "Signifies whether task has been customized or not.", "type": "boolean" }, "cycleStartDay": { "description": "Signifies the shift of the housekeeping schedule.", "type": "integer" } } }, "facilityHousekeepingTasksType": { "type": "array", "description": "List of the facility tasks.", "maxItems": 4000, "items": { "$ref": "#/definitions/facilityHousekeepingTaskType" } }, "facilityHousekeepingTaskType": { "type": "object", "description": "A single facility task type.", "properties": { "facilityTask": { "description": "Facility task for the day.", "$ref": "#/definitions/facilityTaskBaseType" }, "taskDate": { "description": "A reservation date on which task must occur.", "type": "string", "format": "date", "maxLength": 8 }, "taskStartDate": { "description": "Date on which the task needs to start being performed.", "type": "string", "format": "date", "maxLength": 8 }, "taskEndDate": { "description": "Date on which task will stop being performed.", "type": "string", "format": "date", "maxLength": 8 }, "stayPeriod": { "description": "Specifies whether task is performed entire stay or specific dates.", "$ref": "#/definitions/housekeepingTaskStayPeriodType" }, "frequency": { "description": "Signifies frequency(i.e. every 2 days) with which task is to be performed.", "type": "integer" }, "cycleStartDay": { "description": "Signifies offset(in days) i.e. start on 3rd day from arrival.", "type": "integer" }, "roomType": { "description": "Signifies the room type for which task is being performed .", "type": "string", "minLength": 0, "maxLength": 20 }, "roomId": { "description": "Room number at which task is to be performed.", "type": "string", "minLength": 0, "maxLength": 20 }, "facilityCodes": { "description": "The hotel code of the room.", "$ref": "#/definitions/facilityCodesType" } } }, "facilityTaskBaseType": { "type": "object", "description": "Facility Housekeeping task code and description.", "properties": { "description": { "description": "Facility task description.", "type": "string", "minLength": 0, "maxLength": 80 }, "priority": { "description": "Signifies the priority of the task.", "type": "integer" }, "code": { "description": "Code of the housekeeping task.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "housekeepingTaskStayPeriodType": { "type": "string", "description": "Simple type for controlling the fetch operations of the housekeeping schedule request.", "enum": [ "EntireStay", "SpecificDates" ] }, "scheduleSearch": { "type": "object", "description": "Request with basic information reservation needed for the reset of the schedule.", "properties": { "criteria": { "description": "Criteria for allocating and reseting housekeeping schedule of the reservation.", "$ref": "#/definitions/reservationHousekeepingScheduleSearchType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "reservationHousekeepingScheduleSearchType": { "type": "object", "description": "Criteria type for fetching reservation housekeeping schedule.", "properties": { "hotelId": { "description": "The hotel code where reservation is made.", "type": "string", "minLength": 0, "maxLength": 20 }, "reservationId": { "$ref": "#/definitions/reservationId" }, "beginDate": { "description": "Begin date from which to start fetching facility tasks.", "type": "string", "format": "date", "maxLength": 8 }, "endDate": { "description": "End date for facility task schedule request.", "type": "string", "format": "date", "maxLength": 8 } } }, "scheduledSearch": { "type": "object", "description": "An updated schedule for the reservation after the reset.", "properties": { "reservationId": { "$ref": "#/definitions/reservationId" }, "hotelId": { "description": "The hotel where task is being scheduled.", "$ref": "#/definitions/codeType" }, "housekeepingSchedule": { "description": "Updated Facility Schedule.", "$ref": "#/definitions/reservationHousekeepingScheduleType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "scheduleShiftRequest": { "type": "object", "description": "Request with the information needed for the shift of the schedule.", "properties": { "criteria": { "description": "Criteria on which shift is to be based.", "$ref": "#/definitions/housekeepingScheduleShiftRequestType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "housekeepingScheduleShiftRequestType": { "type": "object", "description": "Criteria type for fetching reservation housekeeping schedule.", "properties": { "hotelId": { "description": "The hotel code where reservation is made.", "type": "string", "minLength": 0, "maxLength": 20 }, "reservationId": { "$ref": "#/definitions/reservationId" }, "beginDate": { "description": "Begin date from which to start fetching facility tasks.", "type": "string", "format": "date", "maxLength": 8 }, "endDate": { "description": "End date for facility task schedule request.", "type": "string", "format": "date", "maxLength": 8 }, "shiftDay": { "description": "Days of the week to which the schedule is to be shifted to.", "$ref": "#/definitions/housekeepingScheduleShiftDayType" } } }, "housekeepingScheduleShiftDayType": { "type": "object", "description": "Day of the week to which schedule of the week is to be shifted to.", "properties": { "dayOfWeek": { "$ref": "#/definitions/daysOfWeekType" } } }, "daysOfWeekType": { "type": "string", "description": "Allowed values for the days of week type.", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] }, "scheduledShiftRequest": { "type": "object", "description": "An updated schedule for the reservation after the shift.", "properties": { "reservationId": { "$ref": "#/definitions/reservationId" }, "hotelId": { "description": "The hotel where task is being scheduled.", "$ref": "#/definitions/codeType" }, "housekeepingSchedule": { "description": "Updated Facility Schedule.", "$ref": "#/definitions/reservationHousekeepingScheduleType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomMaintenanceRequest": { "type": "object", "description": "Request to create a room maintenance record.", "properties": { "criteria": { "description": "Information to create new room maintenance request.", "$ref": "#/definitions/roomMaintenanceRequestType" }, "includeDetails": { "description": "Attribute to decide whether response should include additional details.", "type": "boolean" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomMaintenanceRequestType": { "type": "object", "description": "Base maintenance type", "properties": { "maintenanceCode": { "description": "Maintenance Code", "type": "string", "minLength": 0, "maxLength": 20 }, "remarks": { "description": "Maintenance remarks", "type": "string", "minLength": 0, "maxLength": 2000 }, "roomIds": { "$ref": "#/definitions/roomIds" }, "assignedUserInfo": { "description": "Maintenance request assignment information", "$ref": "#/definitions/assignedUserType" }, "hotelId": { "description": "Hotel code", "type": "string", "minLength": 0, "maxLength": 20 } } }, "roomIds": { "type": "array", "description": "Collection of room numbers to be process.", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "roomMaintenanceDetails": { "type": "object", "description": "Response for the Fetch Room Maintenance request.", "properties": { "roomMaintenance": { "description": "Collection of room maintenance information records.", "$ref": "#/definitions/hotelRoomMaintenanceType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "hotelRoomMaintenanceType": { "type": "object", "description": "Hotel Rooms maintenance information type.", "properties": { "roomMaintenance": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomMaintenanceType" } }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "roomMaintenanceType": { "type": "object", "description": "Base maintenance type", "properties": { "maintenanceCode": { "description": "Maintenance Code", "type": "string", "minLength": 0, "maxLength": 20 }, "remarks": { "description": "Maintenance remarks", "type": "string", "minLength": 0, "maxLength": 2000 }, "maintenanceId": { "description": "Unique maintenance identifier.", "$ref": "#/definitions/uniqueID_Type" }, "roomInfo": { "description": "Room Details", "$ref": "#/definitions/roomType" }, "resolveInfo": { "description": "Resolve User and Date for resolved room", "$ref": "#/definitions/resolveRoomMaintenanceType" }, "assignedUserInfo": { "description": "Maintenance request assignment information", "$ref": "#/definitions/assignedUserType" }, "images": { "description": "Collection of Maintenance images", "$ref": "#/definitions/imageResultsType" }, "createDateTime": { "description": "Time stamp of the creation. Uses database time zone.", "type": "string", "format": "date-time" }, "creatorId": { "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.", "type": "string", "minLength": 0, "maxLength": 200 }, "lastModifyDateTime": { "description": "Time stamp of last modification. Uses database time zone.", "type": "string", "format": "date-time" }, "lastModifierId": { "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, "maxLength": 200 }, "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", "format": "date", "maxLength": 8 }, "imageCount": { "description": "Number of Maintenance images linked to the record.", "type": "integer" } } }, "resolveRoomMaintenanceType": { "type": "object", "description": "Resolve Room Maintenance Type.", "properties": { "resolveUser": { "description": "Resolved by user.", "type": "string", "minLength": 0, "maxLength": 100 }, "resolveDate": { "description": "Resolve date.", "type": "string", "format": "date", "maxLength": 8 } } }, "imageResultsType": { "type": "array", "description": "Collection of image results.", "maxItems": 4000, "items": { "$ref": "#/definitions/imageResultType" } }, "imageResultType": { "type": "object", "properties": { "imageSet": { "description": "Image set describing path of image.", "type": "string", "minLength": 0, "maxLength": 800 }, "mimeType": { "description": "Mime type of the Image.", "type": "string", "minLength": 0, "maxLength": 20 }, "image": { "description": "Image file to upload.", "type": "string", "format": "byte" }, "imageId": { "description": "ImageId file.", "$ref": "#/definitions/uniqueID_Type" }, "linkId": { "description": "LinkID of the file.", "$ref": "#/definitions/uniqueID_Type" }, "imageLinkId": { "description": "Image link id file.", "$ref": "#/definitions/uniqueID_Type" }, "base64Image": { "description": "Base64Image image content of the file.", "type": "string" } } }, "completeRoomRepair": { "type": "object", "properties": { "criteria": { "type": "object", "description": "Criteria to complete the out of order status of a room and bring the room back into rotation. A list or range of rooms can be provided.", "properties": { "roomRepairByRoomNumber": { "type": "array", "description": "Completing an existing OO/OS room by room number.", "maxItems": 4000, "items": { "type": "object", "properties": { "roomId": { "type": "string", "minLength": 0, "maxLength": 20 }, "roomOutOfOrder": { "type": "object", "description": "Out Of Order and Out Of Service Room information.", "properties": { "repairRemarks": { "description": "Notes or Remarks on the OO/OS room", "type": "string", "minLength": 0, "maxLength": 2000 }, "returnStatus": { "description": "Room Status which will be used on completion of OO/OS.", "$ref": "#/definitions/housekeepingRoomStatusType" }, "reasonCode": { "description": "Reason Code why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 20 }, "reasonDescription": { "description": "Reason Description why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 80 }, "newDateRange": { "description": "The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms.", "$ref": "#/definitions/dateRangeType" }, "start": { "description": "The starting value of the date range.", "type": "string", "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", "format": "date" }, "endTime": { "description": "The date and time until which the room is marked as OO/OS.", "type": "string", "format": "date-time" } } } } } }, "roomRangeList": { "type": "object", "properties": { "roomIds": { "$ref": "#/definitions/roomIds" }, "range": { "type": "object", "properties": { "roomRange": { "$ref": "#/definitions/roomRangeType" } } }, "roomOutOfOrder": { "type": "object", "description": "Out Of Order and Out Of Service Room information.", "properties": { "repairRemarks": { "description": "Notes or Remarks on the OO/OS room", "type": "string", "minLength": 0, "maxLength": 2000 }, "returnStatus": { "description": "Room Status which will be used on completion of OO/OS.", "$ref": "#/definitions/housekeepingRoomStatusType" }, "reasonCode": { "description": "Reason Code why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 20 }, "reasonDescription": { "description": "Reason Description why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 80 }, "newDateRange": { "description": "The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms.", "$ref": "#/definitions/dateRangeType" }, "start": { "description": "The starting value of the date range.", "type": "string", "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", "format": "date" }, "endTime": { "description": "The date and time until which the room is marked as OO/OS.", "type": "string", "format": "date-time" } } } } } } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomRangeType": { "type": "object", "properties": { "fromRoomNumber": { "type": "string", "minLength": 0, "maxLength": 20 }, "toRoomNumber": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "completeRoomRepairStatus": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomRepairOutOfOrder": { "type": "object", "properties": { "criteria": { "type": "object", "description": "Criteria to set the room or a collection of rooms out of order. The criteria can include a collection of rooms or a range of rooms along with the date range.", "properties": { "roomRangeList": { "type": "object", "properties": { "roomIds": { "type": "array", "description": "Collection of room numbers to be process.", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "range": { "type": "object", "description": "Range information.", "properties": { "roomRange": { "description": "Set the roomRange.", "$ref": "#/definitions/roomRangeType" } } }, "roomOutOfOrder": { "type": "object", "description": "Out Of Order and Out Of Service Room information.", "properties": { "repairRemarks": { "description": "Notes or Remarks on the OO/OS room", "type": "string", "minLength": 0, "maxLength": 2000 }, "returnStatus": { "description": "Room Status which will be used on completion of OO/OS.", "$ref": "#/definitions/housekeepingRoomStatusType" }, "reasonCode": { "description": "Reason Code why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 20 }, "reasonDescription": { "description": "Reason Description why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 80 }, "newDateRange": { "description": "The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms.", "$ref": "#/definitions/dateRangeType" }, "start": { "description": "The starting value of the date range.", "type": "string", "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", "format": "date" }, "endTime": { "description": "The date and time until which the room is marked as OO/OS.", "type": "string", "format": "date-time" } } } } } } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomRepairOutOfService": { "type": "object", "properties": { "criteria": { "type": "object", "description": "Criteria to set the room or a collection of rooms out of service. The criteria can include a collection of rooms or a range of rooms along with the date range.", "properties": { "roomRangeList": { "type": "object", "properties": { "roomIds": { "type": "array", "description": "Collection of room numbers to be process.", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "range": { "type": "object", "description": "Range information.", "properties": { "roomRange": { "description": "Set the roomRange.", "$ref": "#/definitions/roomRangeType" } } }, "roomOutOfOrder": { "type": "object", "description": "Out Of Order and Out Of Service Room information.", "properties": { "repairRemarks": { "description": "Notes or Remarks on the OO/OS room", "type": "string", "minLength": 0, "maxLength": 2000 }, "returnStatus": { "description": "Room Status which will be used on completion of OO/OS.", "$ref": "#/definitions/housekeepingRoomStatusType" }, "reasonCode": { "description": "Reason Code why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 20 }, "reasonDescription": { "description": "Reason Description why the room is OO/OS.", "type": "string", "minLength": 0, "maxLength": 80 }, "newDateRange": { "description": "The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms.", "$ref": "#/definitions/dateRangeType" }, "start": { "description": "The starting value of the date range.", "type": "string", "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", "format": "date" }, "endTime": { "description": "The date and time until which the room is marked as OO/OS.", "type": "string", "format": "date-time" } } } } } } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "housekeepingRoomStatusCriteria": { "type": "object", "properties": { "roomList": { "description": "Collection of room numbers for which the status is to be updated.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomInformationType" } }, "housekeepingStatus": { "description": "The new Housekeeping status that will be assigned.", "$ref": "#/definitions/frontOfficeRoomStatusType" }, "housekeepingRoomStatus": { "description": "The new Room status that will be assigned.", "$ref": "#/definitions/housekeepingRoomStatusType" }, "turndownStatus": { "$ref": "#/definitions/turndownStatusType" }, "roomPersons": { "description": "The Room person information per the reservation and housekeeping.", "$ref": "#/definitions/roomPersonsCountType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomInformationType": { "type": "object", "description": "Room Information needed in updating the status.", "properties": { "roomId": { "type": "string", "minLength": 0, "maxLength": 20 }, "reservationId": { "$ref": "#/definitions/reservationId" } } }, "housekeepingRoomStatus": { "type": "object", "description": "Response Body.", "properties": { "warnings": { "description": "Refer to Generic common types document.", "$ref": "#/definitions/warningsType" }, "links": { "$ref": "#/definitions/links" } } }, "roomCleaningPriority": { "type": "object", "description": "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.", "properties": { "criteria": { "description": "Criteria for setting the list of rooms as priority for cleaning.", "$ref": "#/definitions/housekeepingRoomsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "housekeepingRoomsType": { "type": "object", "description": "Type for a list of Housekeeping rooms for a resort. Used as a criteria type for requests.", "properties": { "roomList": { "description": "Collection of room numbers.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } } } }, "roomCleaningPriorityRequestStatus": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "changedRoomMaintenance": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "taskRoom": { "type": "object", "description": "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 the room.", "properties": { "criteria": { "$ref": "#/definitions/serviceTaskRoomType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "serviceTaskRoomType": { "type": "object", "description": "Criteria for servicing a task room.", "properties": { "taskCodes": { "description": "List of Task Codes of the task sheet.", "$ref": "#/definitions/codeListType" }, "allottedMinutes": { "description": "The allotted minutes for completing the task.", "type": "number" }, "hotelId": { "description": "Property where the task sheet exists.", "type": "string", "minLength": 0, "maxLength": 20 }, "taskDate": { "description": "Date for which the task sheet was created. By default this would be the current business date.", "type": "string", "format": "date", "maxLength": 8 }, "sheetNumber": { "description": "The Task Sheet number where the room exists.", "type": "integer" }, "roomId": { "description": "The room number to service.", "type": "string", "minLength": 0, "maxLength": 20 }, "attendant": { "description": "The Attendant ID who is currently servicing the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "frontOfficeStatus": { "description": "The FO status code i.e Vacant, Occupied.", "$ref": "#/definitions/frontOfficeRoomStatusType" }, "housekeepingRoomStatus": { "description": "The room status code example Clean, Dirty etc.", "$ref": "#/definitions/housekeepingRoomStatusType" }, "roomTaskCode": { "description": "The task code for the current room which is to be done.", "type": "string", "minLength": 0, "maxLength": 20 }, "removeGuestServiceStatus": { "description": "When set to true, the current Guest Service Status (Do Not Disturb, Service Declined, Make Up Room) will be removed and set to No Status Selected. This element is available when the Guest Service Status OPERA Control is active.", "type": "boolean" } } }, "canceledServicingTaskRoom": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "completedServicingTaskRoom": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "skipedServicingTaskRoom": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "serviceTime": { "type": "object", "description": "Response type for the start task room service. Can contain errors or warnings.", "properties": { "elapsedTime": { "description": "Total time in seconds spent in servicing the room.", "type": "number" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestHousekeepingServiceRequestCriteria": { "type": "object", "description": "Operation to set the Guest Service status of an occupied room. The service status can be Do Not Disturb or Make Up Room.", "properties": { "criteria": { "description": "Criteria for setting the status.", "$ref": "#/definitions/setGuestHousekeepingServiceRequestCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "setGuestHousekeepingServiceRequestCriteriaType": { "type": "object", "description": "Criteria for changing the guest service status on an occupied room.", "properties": { "hotelId": { "description": "The hotel code of the rooms for which the guest service status needs to be changed.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomList": { "description": "Collection of room numbers for which the status is to be updated.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "status": { "description": "Service Status to be used. If this element is not used or is null, then the service status will be removed from the room.", "$ref": "#/definitions/guestHousekeepingServiceRequestType" } } }, "guestHousekeepingServiceRequestStatus": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "taskCompanion": { "type": "object", "description": "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 details of the rooms current status and reservations for the room, if any.", "properties": { "taskRoom": { "description": "Details of the room and the task sheet.", "type": "object", "properties": { "taskCodes": { "description": "The Task Code(s) used for this Task Sheet.", "type": "array", "items": { "$ref": "#/definitions/housekeepingTaskCodeType" } }, "departureTaskInfo": { "description": "Facility task info related to the departure task.", "$ref": "#/definitions/departureTaskInfoType" }, "totalSupplies": { "description": "All Supplies, and their totals, associated with the Task Sheet.", "$ref": "#/definitions/facilityCodesType" }, "credits": { "description": "Credits information for this Task Sheet. This could have the Total Credit information and the Travelling credits if required.", "type": "array", "items": { "$ref": "#/definitions/housekeepingCreditsType" } }, "attendant": { "description": "Information regarding Housekeeping Attendants.", "type": "object", "properties": { "section": { "description": "Section Code the attendant has been assigned.", "$ref": "#/definitions/housekeepingSectionType" }, "floor": { "description": "The Floor which is assigned to the attendant.", "type": "string", "minLength": 0, "maxLength": 20 }, "attendantId": { "description": "Attendant's unique identifier.", "type": "string", "minLength": 0, "maxLength": 20 }, "attendantName": { "description": "Attendant's name.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelId": { "description": "Property where the attendant belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "activeFlag": { "description": "Indicates if the Attendant is active.", "type": "string", "minLength": 0, "maxLength": 1 }, "sunday": { "type": "boolean" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "attendantInstructions": { "type": "string", "maxLength": 2000 } } }, "appUserOnBreak": { "description": "Information about on break application user and start time.", "$ref": "#/definitions/appUserOnBreakType" }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, "offset": { "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, "limit": { "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" }, "rooms": { "description": "This type represents the primary room attributes.", "type": "array", "maxItems": 4000, "items": { "type": "object", "properties": { "roomType": { "description": "Room type basic information of the room.", "$ref": "#/definitions/roomTypeShortInfoType" }, "floor": { "description": "Floor of the Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "floorDescription": { "description": "Description for the Floor of the Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomFeatures": { "description": "Room Features for the room.", "$ref": "#/definitions/roomFeaturesType" }, "roomDescription": { "description": "Detail Long Description Of The Room.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the room.", "$ref": "#/definitions/translationTextType2000" }, "smokingPreference": { "description": "This indicates room smoking preference.", "type": "string", "minLength": 0, "maxLength": 20 }, "smokingPreferenceDescription": { "description": "This indicates the description of the room smoking preference.", "type": "string", "minLength": 0, "maxLength": 20 }, "building": { "description": "Building associated with the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomAssignmentRating": { "description": "Assignment Rating associated with the room.", "$ref": "#/definitions/ratePlanRatingType" }, "roomNumber": { "description": "Code of the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomSection": { "description": "Room sections of the room.", "$ref": "#/definitions/roomSectionType" }, "housekeeping": { "description": "Identifies the Housekeeping information..", "$ref": "#/definitions/housekeepingType" }, "outOfOrder": { "description": "Identifies the room Out of Order/Out of Service information.", "$ref": "#/definitions/roomsOutOfOrderType" }, "discrepancy": { "description": "Identifies the room discrepancy information.", "$ref": "#/definitions/roomDiscrepanciesType" }, "sitePlanSection": { "description": "Identifies the site plan location of the room.", "$ref": "#/definitions/sitePlanSectionType" }, "componentRoomNumber": { "description": "This flag indicates component room.", "type": "string", "minLength": 0, "maxLength": 20 }, "connectingRooms": { "description": "This flag indicates connecting rooms.", "$ref": "#/definitions/roomRoomsType" }, "componentRooms": { "description": "This flag indicates component rooms.", "$ref": "#/definitions/roomRoomsType" }, "attendant": { "type": "array", "items": { "$ref": "#/definitions/currentServicingAttendantType" } }, "hold": { "description": "Hold attributes if any.", "$ref": "#/definitions/roomHoldType" }, "turndownInfo": { "$ref": "#/definitions/turndownInfoType" }, "resvInfo": { "type": "array", "items": { "$ref": "#/definitions/reservationShortInfoType" } }, "reservationInfo": { "type": "array", "items": { "$ref": "#/definitions/reservationInfoType" } }, "servicingInfo": { "description": "Information regarding the current servicing of the room.", "type": "array", "items": { "$ref": "#/definitions/currentServicingAttendantType" } }, "maintenance": { "$ref": "#/definitions/maintenanceCountType" }, "instructions": { "description": "Task Sheet instructions at the room level.", "type": "string", "minLength": 0, "maxLength": 2000 }, "totalCredits": { "description": "Total credits for this room.", "type": "integer" }, "wakeUpTime": { "description": "The wake up time of the current date", "type": "string", "format": "date" }, "cleaningSequence": { "description": "The sequence for cleaning this room in the task sheet. This would apply only for Pickup and Dirty rooms.", "type": "integer" }, "defaultSequence": { "description": "The sequence for this room from configuration.", "type": "integer" }, "hasPriority": { "description": "The sequence for this room from configuration.", "type": "boolean" }, "maintenanceAllowed": { "description": "Flag if the Room, and the OperaV5 version, allows Room Maintenance or not.", "type": "boolean" } }, "description": "This type represents the primary room attributes." } }, "roomCounts": { "type": "array", "items": { "type": "object", "properties": { "value": { "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "type": "string", "enum": [ "Clean", "Dirty", "Pickup", "Inspected", "OutOfOrder", "OutOfService" ] }, "totalCount": { "type": "integer" } } } }, "linenChangeCount": { "description": "The total number of linen changes included in this task sheet.", "type": "integer" }, "sheetNumber": { "description": "The Task Sheet number. This will be a sequential number for the task sheets generated for a particular Task Code.", "type": "integer" }, "date": { "description": "The date for which the task sheet applies.", "type": "string", "format": "date" }, "nextDay": { "description": "Indicates the task sheet applies to Next Business Day.", "type": "boolean" }, "autoGenerated": { "description": "Indicates if the task sheet was automatically generated.", "type": "boolean" }, "lockTaskSheet": { "description": "Indicates if the task sheet was locked or not.", "type": "boolean" }, "taskSeqNo": { "description": "The sequence no of the task sheet.", "type": "integer" }, "roomCount": { "description": "The total number of rooms included in this task sheet.", "type": "integer" }, "taskInstructions": { "description": "Task Sheet level instructions. These instructions are applicable to this task sheet only.", "type": "string", "minLength": 0, "maxLength": 2000 }, "completedDate": { "description": "Date the task was completed.", "type": "string", "format": "date" }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "sheetType": { "description": "The Task Sheet type. Indicates how the task sheet was created and what type of rooms are part of it.", "$ref": "#/definitions/taskSheetType" }, "attendantStatus": { "description": "Status of Housekeeping Attendant assigned to this TaskSheet. This value holds the most recent status posted by the attendant.", "$ref": "#/definitions/servicingAttendantStatusType" }, "breakOutId": { "description": "Break out id of the task sheet.", "type": "integer" }, "allEvaluatedRoomsSkipped": { "description": "Indicates if all the possible rooms to be evaluated have been skipped.", "type": "boolean" }, "emptyTaskSheet": { "description": "Indicates if the task sheet has no rooms.", "type": "boolean" }, "taskSheetCompleted": { "description": "Indicates if all the rooms in the task sheet are Clean/Inspected i.e they do not have the Dirty or the Pickup status.", "type": "boolean" }, "completedRoomsCount": { "description": "The total number of completed rooms in this task sheet.", "type": "integer" } } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "taskSheetTemplate": { "type": "object", "description": "Response for retrieving a task sheet template. It contains all the information of the previously generated tasksheet.", "properties": { "taskSheetTemplateDetails": { "description": "Information regarding the Task Sheets template for the Task Assignment.", "$ref": "#/definitions/autoGenerateTaskSheetsCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "changedTaskSheetTemplate": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "taskSheet": { "type": "object", "description": "Request of Changing a Task Sheet. The task instructions, total credits, attendant information and room information can be changed on a task sheet. Task Instructions , Total Credits and Attendants will be replaced with what is sent in this request. Example: If the task instructions is null in the request, the task instructions on the task sheet will be updated to null. If rooms are sent as part of this request, this will replace the existing rooms on the task sheet. If rooms are not sent, then the original rooms will remain. The task date, hotel code, task sheet number and task code is required to search for the task sheet which has to be changed", "properties": { "taskSheetDetails": { "description": "The update information on a task sheet. The information that will be updated are the task instructions, total credits, attendant information and rooms. All other information in this type will not used to update. The task date, hotel code, task sheet number and task code is required to search for the task sheet which has to be changed", "$ref": "#/definitions/housekeepingTaskType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "changedTaskSheet": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "changedTaskSheetRooms": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "taskSheetToLock": { "type": "object", "description": "Request for locking a task sheet.", "properties": { "criteria": { "description": "Criteria to lock or unlock a task sheet.", "$ref": "#/definitions/taskSheetLockCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "taskSheetLockCriteriaType": { "type": "object", "description": "Criteria to lock or unlock a task sheet.", "properties": { "hotelId": { "description": "Property code which the task sheet belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "taskSeqNo": { "description": "Task sequence number of the task sheet.", "type": "integer" }, "lockTaskSheet": { "description": "If set to true, the task sheet will be locked.", "type": "boolean" } } }, "lockedTaskSheet": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "taskSheetToUnlock": { "type": "object", "description": "Request for unlocking a task sheet.", "properties": { "criteria": { "description": "Criteria to unlock a task sheet.", "$ref": "#/definitions/taskSheetLockCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "unlockedTaskSheet": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "endedServiceBreak": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "startedServiceBreak": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "taskSheetToMerge": { "type": "object", "description": "Request for merging task sheets.", "properties": { "criteria": { "description": "Criteria to merge task sheets.", "$ref": "#/definitions/mergeTaskSheetCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "mergeTaskSheetCriteriaType": { "type": "object", "description": "Criteria to merge task sheets.", "properties": { "hotelId": { "description": "Property code which the task sheets belong.", "type": "string", "minLength": 0, "maxLength": 20 }, "fromTaskSeqNo": { "description": "Source task sequence number of the task sheet.", "type": "integer" }, "toTaskSeqNo": { "description": "Destination task sequence number of the task sheet.", "type": "integer" }, "hkBreakOutId": { "description": "Break out id of the task sheet.", "type": "integer" } } }, "scheduledRoomMoveInfoType": { "type": "object", "description": "Holds the scheduled room Move In/Out information.", "properties": { "scheduledRoomMoveInTime": { "description": "Scheduled Room Move-In Time. Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "scheduledRoomMoveOutTime": { "description": "Scheduled Room Move-Out Time. Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "scheduledRoomMoveIn": { "description": "True indicates room is scheduled for move in.", "type": "boolean" }, "scheduledRoomMoveOut": { "description": "True indicates room is scheduled for move out.", "type": "boolean" } } }, "roomPersonsCountType": { "type": "object", "properties": { "houseKeepingPersons": { "type": "integer" } } }, "maintenanceCountType": { "type": "object", "description": "Information regarding Room Maintenance count", "properties": { "unresolvedMaintenanceCount": { "description": "The number of unresolved maintenance requests for a room. This functionality is available when the Room Maintenance OPERA Control is active.", "type": "number" } } }, "pingRS": { "type": "object", "description": "Response for Ping operation.", "properties": { "operaVersion": { "description": "Opera version number.", "$ref": "#/definitions/operaVersionNumberType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "operaVersionNumberType": { "type": "string", "description": "Current Opera Version Number", "minLength": 0, "maxLength": 40 } }, "tags": [ { "name": "Housekeeping", "description": "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." } ], "externalDocs": { "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } }