openapi: 3.2.0
info:
  title: OPERA Cloud Service Housekeeping API
  description: APIs to cater for Housekeeping functionality in OPERA Cloud. <br /><br />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.<br /><br /> Compatible with OPERA Cloud release 26.2.0.0.<br /><br /><p> 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.</p>
  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
servers:
- url: /hsk/v1
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.
paths:
  /hotels/{hotelId}/attendants/houseKeepingTasks:
    get:
      summary: Get the housekeeping attendants schedule
      description: This API will allow you to get the housekeeping attendants schedule. <p><strong>OperationId:</strong>getHousekeepingAttendantsSchedule</p> <p>This API allows a time span of <strong>30</strong> days.</p>
      operationId: getHousekeepingAttendantsSchedule
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: scheduleStartDate
        in: query
        required: true
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: scheduleEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for fetching the attendants schedule.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/attendantSchedule'
        '204':
          description: HousekeepingAttendantsSchedule not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
    delete:
      summary: Delete housekeeping attendant schedule
      description: This API will allow you to delete housekeeping attendant schedule. <p><strong>OperationId:</strong>deleteHousekeepingAttendantSchedule</p>
      operationId: deleteHousekeepingAttendantSchedule
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: scheduleDate
        in: query
        required: true
        description: Schedule date of attendants' assignment. Used when attendants to scheduled are of the same date.
        schema:
          type: string
          format: date
      - name: attendantId
        in: query
        description: ID of the attendant.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/autoTaskSheets:
    post:
      summary: Auto generate the task sheets
      description: This API will allow you to Auto generate the task sheets. <p><strong>OperationId:</strong>autoGenerateTaskSheets</p>
      operationId: autoGenerateTaskSheets
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheets'
        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.'
        required: true
  /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. <p><strong>OperationId:</strong>getRoomConditions</p>
      operationId: getRoomConditions
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomConditionsOnly
        in: query
        required: false
        description: Include rooms with conditions only.
        schema:
          type: boolean
      - name: roomWithoutConditionsOnly
        in: query
        required: false
        description: Include rooms without conditions only.
        schema:
          type: boolean
      - name: room
        in: query
        required: false
        description: Identifier of the room.
        schema:
          type: string
      - name: fromRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: toRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: roomConditions
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomTypes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClasses
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: frontOfficeRoomStatus
        in: query
        description: Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Vacant
            - Occupied
          uniqueItems: true
      - name: reservationStatuses
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomAssignmentStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Assigned
            - Unassigned
          uniqueItems: true
      - name: floors
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomFeatures
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: amSections
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: pmSections
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: buildings
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: housekeepingRoomStatus
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Clean
            - Dirty
            - Pickup
            - Inspected
            - OutOfOrder
            - OutOfService
          uniqueItems: true
      - name: roomParityStatus
        in: query
        description: Simple type for room parity instructions to be used in requests for fetching housekeeping rooms. Valid status values are Odd and Even.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Odd
            - Even
          uniqueItems: true
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response element for fetching room conditions.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rooms'
        '204':
          description: RoomConditions not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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. <p><strong>OperationId:</strong>setRoomCondition</p>
      operationId: setRoomCondition
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomConditionRequestStatus'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomCondition'
        description: Request element for setting room condition.
        required: true
  /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 . <p><strong>OperationId:</strong>getFacilityForecast</p> <p>This API allows a time span of <strong>30</strong> days.</p>
      operationId: getFacilityForecast
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: duration
        in: query
        required: false
        schema:
          type: string
      - name: Codes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: usePriority
        in: query
        required: false
        description: .
        schema:
          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.
        schema:
          type: boolean
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response element for the fetched facility forecast.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/facilityForecast'
        '204':
          description: FacilityForecast not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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.<p><strong>OperationId:</strong>deleteHouseKeepingTaskSheets</p>
      operationId: deleteHouseKeepingTaskSheets
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Indicates Unique Hotel Code for which the task sheets will be deleted.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: taskCodesBreakOutId
        in: path
        required: true
        description: Indicates Unique breakout ID for which the task sheets will be deleted.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of deleted resource
              schema:
                type: string
          description: Additional warnings about the operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/houseKeepingtasks:
    get:
      summary: Get the existing task sheets
      description: This API will allow you to get the existing task sheets. <p><strong>OperationId:</strong>getHouseKeepingTasks</p>
      operationId: getHouseKeepingTasks
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: taskDate
        in: query
        required: true
        description: Date for which the Task Assignment information is required.
        schema:
          type: string
          format: date
      - name: attendantInRoomOnly
        in: query
        required: false
        description: Query only rooms with attendant working in them.
        schema:
          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.
        schema:
          type: boolean
      - name: includeReservationInfo
        in: query
        required: false
        description: Setting this to true will include reservation information associated to the room.
        schema:
          type: boolean
      - name: includeComponentRoomsInfo
        in: query
        required: false
        description: Setting this to true will include component rooms information associated to the room.
        schema:
          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.
        schema:
          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.'
        schema:
          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.'
        schema:
          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.
        schema:
          type: boolean
      - name: taskCodes
        in: query
        description: The Code for the task.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: taskHotelCodes
        in: query
        description: Property for which the Task Assignment information is required.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: taskSequences
        in: query
        description: Ordering sequence for display.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: taskDescriptions
        in: query
        description: Description of the Task Code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: taskInstructions
        in: query
        description: Instructions for this Task Code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: facilityDepartureTask
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
          maxItems: 4000
      - name: linenChange
        in: query
        description: Indicates if a linen change is necessary.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - 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.
        schema:
          type: string
      - name: taskCodesBreakOutIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: taskCodesBreakOutIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: attendantId
        in: query
        required: false
        description: Attendant ID for which the Task Sheets are assigned.
        schema:
          type: string
      - name: taskSheetNumber
        in: query
        description: Specific Task Sheet number for which the information is required.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
          maxItems: 4000
      - name: housekeepingRoomStatus
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Clean
            - Dirty
            - Pickup
            - Inspected
            - OutOfOrder
            - OutOfService
          uniqueItems: true
      - name: guestService
        in: query
        description: Possible values for the Guest Service Status.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - DoNotDisturb
            - MakeUpRoom
            - NoStatusSelected
            - ServiceDeclined
          uniqueItems: true
      - name: roomStatusToChange
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Clean
            - Dirty
            - Pickup
            - Inspected
            - OutOfOrder
            - OutOfService
          uniqueItems: true
      - 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.
        schema:
          type: boolean
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: ''
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/taskAssignment'
        '204':
          description: HouseKeepingTasks not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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.<p><strong>OperationId:</strong>getHousekeepingDiscrepancies</p>
      operationId: getHousekeepingDiscrepancies
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomDiscrepancyStatus
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Sleep
            - Skip
            - PersonDiscrepancy
          uniqueItems: true
      - name: fromRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: toRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: roomClass
        in: query
        description: Room Class of the Room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: housekeepingEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: housekeepingStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: floor
        in: query
        description: The floor of room to be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: dueOut
        in: query
        required: false
        description: List the rooms based on the flag DUE OUT for departure only.
        schema:
          type: boolean
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: ''
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rooms'
        '204':
          description: HousekeepingDiscrepancies not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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. <p><strong>OperationId:</strong>getHousekeepingOverview</p>
      operationId: getHousekeepingOverview
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code for which Housekeeping overview needs to be fetched
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: offset
        in: query
        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.
        schema:
          type: integer
          default: 0
      - name: housekeepingRoomStatus
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Clean
            - Dirty
            - Pickup
            - Inspected
            - OutOfOrder
            - OutOfService
          uniqueItems: true
      - name: frontOfficeRoomStatus
        in: query
        description: Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Vacant
            - Occupied
          uniqueItems: true
      - name: turndownStatus
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Required
            - NotRequired
            - Compeleted
          uniqueItems: true
      - name: roomParityStatus
        in: query
        description: Simple type for room parity instructions to be used in requests for fetching housekeeping rooms. Valid status values are Odd and Even.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Odd
            - Even
          uniqueItems: true
      - name: serviceRequestStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Open
            - PendingFollowUp
            - Closed
            - DoNotDisturb
            - MakeUpRoom
          uniqueItems: true
      - name: roomAssignmentStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Assigned
            - Unassigned
          uniqueItems: true
      - name: fetchInstructions
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Summary
            - ResvInfo
            - TurndownInfo
            - ScheduedRoomMoveInfo
            - ResvQueueInfo
            - AttendantInRoomInfo
          uniqueItems: true
      - name: fromRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: toRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: floor
        in: query
        description: The floor of room to be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomType
        in: query
        description: Room Type of the Room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClass
        in: query
        description: Room Class of the Room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: building
        in: query
        description: Building of the Room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomFeatures
        in: query
        description: Features of the Room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: daySection
        in: query
        description: AM Sections of the Room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: eveningSection
        in: query
        description: PM Sections of the Room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: reservationStatus
        in: query
        description: The status of the reservation to which this Room is assigned.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: guestServiceRequest
        in: query
        required: false
        description: Possible values for the Guest Service Status.
        schema:
          type: string
          enum:
          - DoNotDisturb
          - MakeUpRoom
          - NoStatusSelected
          - ServiceDeclined
          uniqueItems: true
      - name: roomIdText
        in: query
        required: false
        description: Wild Card entry for Room numbers to be Fetched.
        schema:
          type: string
      - name: excludeCombo
        in: query
        required: false
        description: Indicates we need to exclude the combo rooms while fetching the housekeeping details.
        schema:
          type: boolean
      - name: cleaningPriorityOnly
        in: query
        required: false
        description: Determines whether fetching cleaning priority rooms only.
        schema:
          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.
        schema:
          type: boolean
      - name: attendantInRoomOnly
        in: query
        required: false
        description: Query only rooms with attendant working in them.
        schema:
          type: boolean
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: ''
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/housekeepingBoard'
        '204':
          description: HousekeepingOverview not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/maintenances/{mainteananceId}:
    delete:
      summary: Delete the maintenances for rooms
      description: Use this API to delete maintenances from rooms. <p><strong>OperationId:</strong>deleteRoomMaintenance</p>
      operationId: deleteRoomMaintenance
      parameters:
      - name: mainteananceId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/maintenances/{mainteananceId}/resolve:
    put:
      summary: Resolve maintenances for rooms
      description: Use this API to Resolve maintenances for rooms. <p><strong>OperationId:</strong>resolveRoomMaintenance</p>
      operationId: resolveRoomMaintenance
      parameters:
      - name: mainteananceId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/resolvedRoomMaintenance'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomMaintenance'
        description: Request to resolve a room maintenance request.
        required: true
  /hotels/{hotelId}/maintenances/{mainteananceId}/unResolve:
    put:
      summary: unResolve the maintenances for rooms
      description: Use this API to unResolve maintenances for rooms. <p><strong>OperationId:</strong>unResolveRoomMaintenance</p>
      operationId: unResolveRoomMaintenance
      parameters:
      - name: mainteananceId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/unresolvedRoomMaintenance'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomMaintenance'
        description: Request to set unresolved status for room maintenance request.
        required: true
  /hotels/{hotelId}/moveTaskRooms:
    put:
      summary: Move the task rooms
      description: This API will allow you to Move the tasksheet rooms. <p><strong>OperationId:</strong>moveTaskRooms</p>
      operationId: moveTaskRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/movedTaskRoomsRS'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/moveTaskRooms'
        description: Request for moving rooms between task sheets.
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes:
    get:
      summary: Get the guest housekeeping instructions
      description: This API will allow you to get the guest housekeeping instructions. <p><strong>OperationId:</strong>getGuestHousekeepingNotes</p>
      operationId: getGuestHousekeepingNotes
      parameters:
      - name: reservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: reservationIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: reservationIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: room
        in: query
        required: false
        description: Room to which housekeeping record belongs.
        schema:
          type: string
      - name: housekeepingInstruction
        in: query
        description: Simple type for housekeeping instructions that can be used in requests for partial operations.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Turndown
            - CleaningPriority
            - ServiceRequest
          uniqueItems: true
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Return object that contains guest housekeeping instructions for the reservation/room.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/guestHousekeepingInstructions'
        '204':
          description: GuestHousekeepingNotes not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
    put:
      summary: Set guest housekeeping instructions
      description: This API will allow you to Set guest housekeeping instructions. <p><strong>OperationId:</strong>setGuestHousekeepingNotes</p>
      operationId: setGuestHousekeepingNotes
      parameters:
      - name: reservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/guestHousekeepingService'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/guestHousekeepingServiceRequest'
        description: Operation to get set guest housekeeping instructions for the room.
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules:
    get:
      summary: Get reservation housekeeping schedule
      description: This API will allow you to get reservation housekeeping schedule. <p><strong>OperationId:</strong>getReservationHousekeepingSchedule</p>
      operationId: getReservationHousekeepingSchedule
      parameters:
      - name: reservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: reservationIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: reservationIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: beginDate
        in: query
        required: false
        description: Begin date from which to start fetching facility tasks.
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        description: End date for facility task schedule request.
        schema:
          type: string
          format: date
      - name: fetchInstructions
        in: query
        description: Simple type for controlling the fetch operations of the housekeeping schedule request.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - HousekeepingInstructions
            - FacilitySchedule
          uniqueItems: true
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Return object that contains a list of facility tasks for the reservation specified in RQ.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/schedule'
        '204':
          description: ReservationHousekeepingSchedule not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
    post:
      summary: Create reservation housekeeping tasks
      description: This API will allow you to create reservation housekeeping tasks. <p><strong>OperationId:</strong>postReservationHousekeepingTasks</p>
      operationId: postReservationHousekeepingTasks
      parameters:
      - name: reservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/schedule'
        description: A schedule with task(s) to be created for the given reservation.
        required: true
    put:
      summary: Update reservation housekeeping tasks
      description: This API will allow you to update reservation housekeeping tasks. <p><strong>OperationId:</strong>editReservationHousekeepingTasks</p>
      operationId: editReservationHousekeepingTasks
      parameters:
      - name: reservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: An updated schedule for the reservation after the edit.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/schedule'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/schedule'
        description: A schedule with task(s) to be edited for the given reservation.
        required: true
    delete:
      summary: Delete reservation housekeeping task
      description: This API will allow you to delete reservation housekeeping task. <p><strong>OperationId:</strong>deleteReservationHousekeepingTasks</p>
      operationId: deleteReservationHousekeepingTasks
      parameters:
      - name: reservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: customized
        in: query
        required: false
        description: Signifies whether task has been customized or not.
        schema:
          type: boolean
      - name: cycleStartDay
        in: query
        required: false
        description: Signifies the shift of the housekeeping schedule.
        schema:
          type: integer
      - name: endDate
        in: query
        required: false
        description: Date at which facility tasks stopped being retrieved.
        schema:
          type: string
          format: date
      - name: startDate
        in: query
        required: false
        description: Date at which facility tasks started being retrieved.
        schema:
          type: string
          format: date
      - name: facilityTaskCode
        in: query
        description: Code of the housekeeping task.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: facilityTaskDescription
        in: query
        description: Description of the housekeeping task code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: facilityTaskPriority
        in: query
        required: false
        description: Signifies the priority of the task.
        schema:
          type: integer
      - name: taskDate
        in: query
        description: A reservation date on which task must occur.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: taskStartDate
        in: query
        description: Date on which the task needs to start being performed.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: taskEndDate
        in: query
        description: Date on which task will stop being performed.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: stayPeriod
        in: query
        description: Simple type for controlling the fetch operations of the housekeeping schedule request.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - EntireStay
            - SpecificDates
          uniqueItems: true
      - name: frequency
        in: query
        description: Signifies frequency(i.e. every 2 days) with which task is to be performed.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: taskCycleStartDay
        in: query
        description: Signifies offset(in days) i.e. start on 3rd day from arrival.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: roomType
        in: query
        description: Signifies the room type for which task is being performed .
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roomId
        in: query
        description: Room number at which task is to be performed.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: facilityCodes
        in: query
        description: Facility code value.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: facilityCodesDescription
        in: query
        description: Facility Code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: facilityCodesQuantity
        in: query
        description: Signifies the quantity.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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. <p><strong>OperationId:</strong>resetReservationHousekeepingSchedule</p>
      operationId: resetReservationHousekeepingSchedule
      parameters:
      - name: reservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: An updated schedule for the reservation after the reset.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/scheduledSearch'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/scheduleSearch'
        description: Request with basic information reservation needed for the reset of the schedule.
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/shift:
    put:
      summary: Shift reservation housekeeping schedule
      description: This API will allow you to shift reservation housekeeping schedule. <p><strong>OperationId:</strong>shiftReservationHousekeepingSchedule</p>
      operationId: shiftReservationHousekeepingSchedule
      parameters:
      - name: reservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: An updated schedule for the reservation after the shift.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/scheduledShiftRequest'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/scheduleShiftRequest'
        description: Request with the information needed for the shift of the schedule.
        required: true
  /hotels/{hotelId}/rooms/cleaningPriority:
    delete:
      summary: Delete room cleaning priority
      description: This API will allow you to delete room cleaning priority. <p><strong>OperationId:</strong>putRoomCleaningPriority</p>
      operationId: putRoomCleaningPriority
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomId
        in: query
        description: Collection of room numbers.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/rooms/maintenanceCodes/{maintenanceCode}:
    post:
      summary: Create maintenances for rooms
      description: Use this API to create maintenances for rooms. <p><strong>OperationId:</strong>postRoomMaintenance</p>
      operationId: postRoomMaintenance
      parameters:
      - name: maintenanceCode
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomMaintenanceRequest'
        description: Request to create a room maintenance record.
        required: true
  /hotels/{hotelId}/rooms/maintenances:
    get:
      summary: Get the maintenance rooms
      description: Use this API to get a list of rooms with maintenances. <p><strong>OperationId:</strong>getRoomMaintenance</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getRoomMaintenance
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomIdText
        in: query
        required: false
        description: Wildcard Room filter.
        schema:
          type: string
      - name: roomId
        in: query
        required: false
        description: Room Number filter.
        schema:
          type: string
      - name: roomClasses
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomTypes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: maintenanceCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomMaintenanceStatus
        in: query
        required: false
        description: Room Maintenance Status.
        schema:
          type: string
          enum:
          - All
          - UnResolved
          - Resolved
          uniqueItems: true
      - name: assignedUserId
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: assignedUserIdContext
        in: query
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: assignedUserIdType
        in: query
        description: A reference to the type of object defined by the UniqueID element.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - 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.
        schema:
          type: string
      - name: maintenanceIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: maintenanceIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: resolvedEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: resolvedStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: includeImages
        in: query
        required: false
        description: Indicator that tells whether to include Images in search results.
        schema:
          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.
        required: false
        schema:
          type: string
          enum:
          - Vacant
          - Occupied
          uniqueItems: true
      - name: expectedByDate
        in: query
        required: false
        description: The date the room maintenance record is expected to be resolved.
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for the Fetch Room Maintenance request.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomMaintenanceDetails'
        '204':
          description: RoomMaintenance not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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. <p><strong>OperationId:</strong>getOutOfOrderRooms</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getOutOfOrderRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code for which Out Of Order rooms needs to be fetched.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: startDate
        in: query
        required: true
        description: The start date for which the out of order / out of service rooms are to be fetched.
        schema:
          type: string
          format: date
      - name: roomId
        in: query
        required: false
        description: Room number to be Fetched.
        schema:
          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.
        schema:
          type: string
          format: date
      - name: roomTypes
        in: query
        description: The room type of out of order / out of service rooms to be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClasses
        in: query
        required: false
        description: The room class of out of order / out of service rooms to be fetched.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: ''
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rooms'
        '204':
          description: OutOfOrderRooms not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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. <p><strong>OperationId:</strong>completeOutOfOrderRooms</p>
      operationId: completeOutOfOrderRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code for which Out Of Order rooms needs to be returned to Clean, Inspected, Dirty or Pickup status.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/completeRoomRepairStatus'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/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'
        required: true
    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. <p><strong>OperationId:</strong>postOutOfOrderRooms</p>
      operationId: postOutOfOrderRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code of Room(s) which is to be set as Out Of Order.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/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'
        required: true
  /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. <p><strong>OperationId:</strong>completeOutOfServiceRooms</p>
      operationId: completeOutOfServiceRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code for which Out Of Service rooms needs to be returned to Clean, Inspected, Dirty or Pickup status.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/completeRoomRepairStatus'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/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'
        required: true
    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. <p><strong>OperationId:</strong>getOutOfServiceRooms</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getOutOfServiceRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code for which Out Of Service rooms needs to be fetched.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: startDate
        in: query
        required: true
        description: The start date for which the out of order / out of service rooms are to be fetched.
        schema:
          type: string
          format: date
      - name: roomId
        in: query
        required: false
        description: Room number to be Fetched.
        schema:
          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.
        schema:
          type: string
          format: date
      - name: roomTypes
        in: query
        description: The room type of out of order / out of service rooms to be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClasses
        in: query
        required: false
        description: The room class of out of order / out of service rooms to be fetched.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: ''
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/rooms'
        '204':
          description: OutOfServiceRooms not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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. <p><strong>OperationId:</strong>postOutOfServiceRooms</p>
      operationId: postOutOfServiceRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code of Room(s) which is to be set as Out Of Service.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/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'
        required: true
  /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. <p><strong>OperationId:</strong>putRoomRelatedStatus</p>
      operationId: putRoomRelatedStatus
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code for which housekeeping room status, housekeeping status or turndown status have to be modified
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/housekeepingRoomStatus'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/housekeepingRoomStatusCriteria'
              - example:
                  roomList:
                  - roomId: '112'
                  - roomId: '114'
                  housekeepingStatus: Vacant
                  housekeepingRoomStatus: Clean
        required: true
  /hotels/{hotelId}/rooms/{roomId}/cleaningPriority:
    put:
      summary: Set the room cleaning priority
      description: This API will allow you to set the room cleaning priority. <p><strong>OperationId:</strong>setRoomCleaningPriority</p>
      operationId: setRoomCleaningPriority
      parameters:
      - name: roomId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomCleaningPriorityRequestStatus'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomCleaningPriority'
        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.
        required: true
  /hotels/{hotelId}/rooms/{roomId}/maintenances/{maintenanceId}:
    put:
      summary: Change maintenances for rooms
      description: Use this API to change the maintenances for rooms. <p><strong>OperationId:</strong>putRoomMaintenance</p>
      operationId: putRoomMaintenance
      parameters:
      - name: maintenanceId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/changedRoomMaintenance'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomMaintenance'
        description: Request to change room maintenance details.
        required: true
  /hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}:
    put:
      summary: Cancel servicing task room
      description: This API will allow you to cancel servicing task room. <p><strong>OperationId:</strong>cancelServicingTaskRoom</p>
      operationId: cancelServicingTaskRoom
      parameters:
      - name: sheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/canceledServicingTaskRoom'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskRoom'
        description: Request to cancel the servicing of a task room.
        required: true
  /hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/complete:
    put:
      summary: Complete servicing task room
      description: This API will allow you to complete servicing task room. <p><strong>OperationId:</strong>completeServicingTaskRoom</p>
      operationId: completeServicingTaskRoom
      parameters:
      - name: sheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/completedServicingTaskRoom'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskRoom'
        description: Request to complete servicing of a task room. This will complete the servicing and set the end time and status to COMPLETED.
        required: true
  /hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/skip:
    put:
      summary: Skip servicing task room
      description: This API will allow you to Skip servicing task room. <p><strong>OperationId:</strong>skipServicingTaskRoom</p>
      operationId: skipServicingTaskRoom
      parameters:
      - name: sheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/skipedServicingTaskRoom'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskRoom'
        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.
        required: true
  /hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/start:
    put:
      summary: Start servicing task room
      description: This API will allow you to start servicing task room. <p><strong>OperationId:</strong>startServicingTaskRoom</p>
      operationId: startServicingTaskRoom
      parameters:
      - name: sheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response type for the start task room service. Can contain errors or warnings.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/serviceTime'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskRoom'
        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.
        required: true
  /hotels/{hotelId}/schedules/houseKeepingTasks:
    post:
      summary: Create housekeeping attendant schedule
      description: This API will allow you to create housekeeping attendant schedule. <p><strong>OperationId:</strong>postHousekeepingAttendantSchedule</p>
      operationId: postHousekeepingAttendantSchedule
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/attendantSchedule'
        description: Request for creating the attendant schedule.
        required: true
  /hotels/{hotelId}/serviceRequests:
    put:
      summary: Set the Guest housekeeping service requests
      description: This API allows you to Set the guest housekeeping service requests <p><strong>OperationId:</strong>setGuestHousekeepingServiceRequest</p>
      operationId: setGuestHousekeepingServiceRequest
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/guestHousekeepingServiceRequestStatus'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/guestHousekeepingServiceRequestCriteria'
        description: Operation to set the Guest Service status of an occupied room. The service status can be Do Not Disturb or Make Up Room.
        required: true
  /hotels/{hotelId}/sheets/{sheetNumber}:
    get:
      summary: Get task companion
      description: This API allows you to get task companion. <p><strong>OperationId:</strong>getTaskCompanion</p>
      operationId: getTaskCompanion
      parameters:
      - name: sheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: taskCodes
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: taskDate
        in: query
        required: false
        description: Date for which the task sheet was created. By default this would be the current business date.
        schema:
          type: string
          format: date
      - name: roomId
        in: query
        required: false
        description: Choice to search by a room number if a particular room is required.
        schema:
          type: string
      - name: skipRoomNumbers
        in: query
        description: Room number that should be skipped.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomStatusToChange
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Clean
            - Dirty
            - Pickup
            - Inspected
            - OutOfOrder
            - OutOfService
          uniqueItems: true
      - 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.
        schema:
          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.
        schema:
          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.
        schema:
          type: boolean
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: offset
        in: query
        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.
        schema:
          type: integer
          default: 0
      - name: taskSheetRoomsOnly
        in: query
        required: false
        description: Flag to indicate whether to include only tasksheet rooms only in the response.
        schema:
          type: boolean
          default: 0
      - 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.
        schema:
          type: boolean
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          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.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/taskCompanion'
        '204':
          description: TaskCompanion not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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.<p><strong>OperationId:</strong>completeTaskSheet</p>
      operationId: completeTaskSheet
      parameters:
      - name: taskSequenceNumber
        in: path
        required: true
        description: Indicates unique Task sequence number for which the task sheet will be completed.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Indicates Unique Hotel Code for which the task sheet will be completed.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of completed resource
              schema:
                type: string
          description: Additional warnings about the operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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.<p><strong>OperationId:</strong>reopenTaskSheet</p>
      operationId: reopenTaskSheet
      parameters:
      - name: taskSequenceNumber
        in: path
        required: true
        description: Indicates unique Task sequence number for which the task sheet will be reopened.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Indicates Unique Hotel Code for which the task sheet will be reopened.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of reopened resource
              schema:
                type: string
          description: Additional warnings about the operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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.<p><strong>OperationId:</strong>completeTaskSheetSet</p>
      operationId: completeTaskSheetSet
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Indicates Unique Hotel Code for which the task sheets will be completed.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: taskCodesBreakOutId
        in: path
        required: true
        description: Indicates Unique breakout ID for which the task sheets will be completed.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of completed resource
              schema:
                type: string
          description: Additional warnings about the operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      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.<p><strong>OperationId:</strong>reopenTaskSheetSet</p>
      operationId: reopenTaskSheetSet
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Indicates Unique Hotel Code for which the task sheets will be reopened.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: taskCodesBreakOutId
        in: path
        required: true
        description: Indicates Unique Breakout ID for which the task sheets will be reopened.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of reopened resource
              schema:
                type: string
          description: Additional warnings about the operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/taskSheetTemplates:
    get:
      summary: Get the task sheet templates
      description: This API allows you to get the task sheet templates. <p><strong>OperationId:</strong>getTaskSheetTemplate</p>
      operationId: getTaskSheetTemplate
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel Code for which task sheet templates needs to be fetched
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: templateCode
        in: query
        required: false
        description: Template name for the task sheet.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for retrieving a task sheet template. It contains all the information of the previously generated tasksheet.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/taskSheetTemplate'
        '204':
          description: TaskSheetTemplate not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/taskSheetTemplates/{taskSheetTemplateCode}:
    put:
      summary: Change the task sheet templates
      description: This API allows you to change the task sheet templates. <p><strong>OperationId:</strong>putTaskSheetTemplate</p>
      operationId: putTaskSheetTemplate
      parameters:
      - name: taskSheetTemplateCode
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/changedTaskSheetTemplate'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheetTemplate'
        description: Request for changing task sheet template.
        required: true
    delete:
      summary: Delete task sheet templates
      description: This API allows you to delete task sheet templates. <p><strong>OperationId:</strong>deleteTaskSheetTemplate</p>
      operationId: deleteTaskSheetTemplate
      parameters:
      - name: taskSheetTemplateCode
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/taskSheets:
    post:
      summary: Create the task sheet
      description: This API allows you to create the task sheet. <p><strong>OperationId:</strong>postTaskSheet</p>
      operationId: postTaskSheet
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheet'
        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.
        required: true
    put:
      summary: Change the task sheet
      description: This API allows you to change the task sheet. <p><strong>OperationId:</strong>putTaskSheet</p>
      operationId: putTaskSheet
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/changedTaskSheet'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheet'
        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'
        required: true
    delete:
      summary: Delete the task sheet
      description: This API allows you to delete the task sheet. <p><strong>OperationId:</strong>deleteTaskSheet</p>
      operationId: deleteTaskSheet
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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.
        schema:
          type: integer
      - name: taskCodes
        in: query
        description: The Code for the task.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: date
        in: query
        required: false
        description: The date for which the task sheet applies.
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
  /hotels/{hotelId}/taskSheets/rooms:
    put:
      summary: Change the task sheet rooms
      description: This API allows you to change the task sheet rooms. <p><strong>OperationId:</strong>putTaskSheetRooms</p>
      operationId: putTaskSheetRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/changedTaskSheetRooms'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheet'
        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.
        required: true
    delete:
      summary: Delete task sheet rooms
      description: This API allows you to delete task sheet rooms. <p><strong>OperationId:</strong>deleteTaskSheetRooms</p>
      operationId: deleteTaskSheetRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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.
        schema:
          type: integer
      - name: taskCodes
        in: query
        description: The Code for the task.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: date
        in: query
        required: false
        description: The date for which the task sheet applies.
        schema:
          type: string
          format: date
      - name: roomId
        in: query
        description: Code of the room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
    post:
      summary: Create the task sheet rooms
      description: This API allows you to create the task sheet rooms. <p><strong>OperationId:</strong>postTaskSheetRooms</p>
      operationId: postTaskSheetRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheet'
        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.
        required: true
  /hotels/{hotelId}/taskSheets/{sheetNumber}/lock:
    put:
      summary: Lock the task sheet
      description: This API allows you to Lock the task sheet. <p><strong>OperationId:</strong>lockTaskSheet</p>
      operationId: lockTaskSheet
      parameters:
      - name: sheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/lockedTaskSheet'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheetToLock'
        description: Request for locking a task sheet.
        required: true
  /hotels/{hotelId}/taskSheets/{sheetNumber}/unlock:
    put:
      summary: Unlock the task sheet
      description: This API allows you to Unlock the task sheet. <p><strong>OperationId:</strong>unlockTaskSheet</p>
      operationId: unlockTaskSheet
      parameters:
      - name: sheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/unlockedTaskSheet'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheetToUnlock'
        description: Request for unlocking a task sheet.
        required: true
  /hotels/{hotelId}/taskSheets/{taskSheetNumber}/end:
    put:
      summary: End the service break
      description: This API allows you to end the Attendant's service break. <p><strong>OperationId:</strong>endServiceBreak</p>
      operationId: endServiceBreak
      parameters:
      - name: taskSheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/endedServiceBreak'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskRoom'
        description: Request to end service break.
        required: true
  /hotels/{hotelId}/taskSheets/{taskSheetNumber}/start:
    put:
      summary: Start the service break
      description: This API allows you to Start the Attendant's service break. <p><strong>OperationId:</strong>startServiceBreak</p>
      operationId: startServiceBreak
      parameters:
      - name: taskSheetNumber
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/startedServiceBreak'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskRoom'
        description: Request to start service break.
        required: true
  /hotels/{hotelId}/taskSheets/{toTaskSequenceNo}/merge:
    post:
      summary: Merge task sheet
      description: This API allows you to merge task sheet. <p><strong>OperationId:</strong>mergeTaskSheet</p>
      operationId: mergeTaskSheet
      parameters:
      - name: toTaskSequenceNo
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/taskSheetToMerge'
        description: Request for merging task sheets.
        required: true
  /services/houseKeeping/status:
    get:
      summary: ' ping the house keeping service'
      description: This API allows you to ping the house keeping service. <p><strong>OperationId:</strong>pingHouseKeepingService</p>
      operationId: pingHouseKeepingService
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for Ping operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/pingRS'
        '204':
          description: pingHouseKeepingService not found.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - Housekeeping
components:
  schemas:
    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: '#/components/schemas/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
    unlockedTaskSheet:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    guestHousekeepingServiceRequestType:
      type: string
      description: Possible values for the Guest Service Status.
      enum:
      - DoNotDisturb
      - MakeUpRoom
      - NoStatusSelected
      - ServiceDeclined
    housekeepingRoomStatusInfo:
      type: object
      description: Housekeeping Room Status Info Type
      properties:
        housekeepingRoomStatus:
          type: string
        numberOfRooms:
          type: integer
        code:
          type: string
          minLength: 0
          maxLength: 20
    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: '#/components/schemas/profileIdList'
    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: '#/components/schemas/timeSpanType'
        expectedTimes:
          description: The expected arrival, return and departure times of the guest.
          $ref: '#/components/schemas/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: '#/components/schemas/currencyAmountType'
        points:
          description: The Points contains the number of points used to book a particular room type.
          $ref: '#/components/schemas/pointsType'
        rateSuppressed:
          description: Whether this rate should be suppressed from view
          type: boolean
        reservationBlock:
          description: Key information about the block for this reservation.
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/resGuaranteeType'
        promotion:
          description: Promotion Codes
          $ref: '#/components/schemas/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: '#/components/schemas/currencyAmountType'
        compBalance:
          description: Comp Balance amount
          $ref: '#/components/schemas/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: '#/components/schemas/currencyAmountType'
        guestServiceStatus:
          description: Service Status of In House guest like DND or MUP
          $ref: '#/components/schemas/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
    changedRoomMaintenance:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    resSharedGuestInfoType:
      type: object
      description: Contains information regarding the share reservation.
      properties:
        profileId:
          $ref: '#/components/schemas/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
    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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/turndownStatusType'
        roomAssignmentStatusList:
          description: Room assignment status to be used in requests for fetching housekeeping rooms.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomAssignmentStatusType'
    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
    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: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomMaintenance:
      type: object
      description: Request to change room maintenance details.
      properties:
        criteria:
          description: Criteria to change a room maintenance request.
          $ref: '#/components/schemas/roomMaintenanceChangeType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomIds:
      type: array
      description: Collection of room numbers to be process.
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    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: '#/components/schemas/housekeepingScheduleShiftRequestType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/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: '#/components/schemas/uniqueID_Type'
        assignedUserInfo:
          description: Maintenance request assignment information
          $ref: '#/components/schemas/assignedUserType'
        roomId:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    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
    reservationFolioWindowsType:
      type: array
      description: Collection of reservation folio windows.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationFolioWindowType'
    namePrefixType:
      type: string
      description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
      minLength: 0
      maxLength: 40
    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: '#/components/schemas/uniqueID_Type'
        linkId:
          description: LinkID of the file.
          $ref: '#/components/schemas/uniqueID_Type'
        imageLinkId:
          description: Image link id file.
          $ref: '#/components/schemas/uniqueID_Type'
        base64Image:
          description: Base64Image image content of the file.
          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: '#/components/schemas/reservationIdList'
        externalReferences:
          description: External Reference information for Reservation.
          $ref: '#/components/schemas/externalReferencesType'
        roomStay:
          description: Collection of room stays.
          $ref: '#/components/schemas/stayInfoType'
        reservationGuest:
          description: Collection of guests associated with the reservation.
          $ref: '#/components/schemas/resGuestInfoType'
        sharedGuests:
          description: Collection of guests who share this reservation.
          $ref: '#/components/schemas/resSharedGuestListType'
        attachedProfiles:
          description: List of attached profiles
          $ref: '#/components/schemas/resAttachedProfileListType'
        reservationPaymentMethod:
          description: Payment method used for this reservation
          $ref: '#/components/schemas/reservationPaymentMethodType'
        reservationFolioWindows:
          description: Collection of reservation folio windows.
          $ref: '#/components/schemas/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: '#/components/schemas/indicatorsType'
        housekeepingRoomStatus:
          description: Current room status
          $ref: '#/components/schemas/housekeepingRoomStatusType'
        searchMatches:
          description: Super Search matching terms.
          $ref: '#/components/schemas/searchMatchesType'
        sourceOfSale:
          description: Point of Sale of reservation. Identifies the entity/channel who made the reservation.
          $ref: '#/components/schemas/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: '#/components/schemas/waitlistResType'
        queue:
          description: Information about the time and duration this reservation was on Queue for Checkin.
          $ref: '#/components/schemas/reservationQueueInformationType'
        housekeeping:
          description: Information regarding housekeeping for this reservation.
          $ref: '#/components/schemas/resHousekeepingType'
        cashiering:
          description: Holds cashiering related information for the reservation.
          $ref: '#/components/schemas/resCashieringType'
        taxType:
          description: This stores the code for the type of tax calculation especially with tax exemption, etc.
          $ref: '#/components/schemas/taxTypeType'
        deposit:
          description: Holds reservation deposit information.
          $ref: '#/components/schemas/reservationDepositType'
        allowedActions:
          description: Collection of reservation allowed actions.
          $ref: '#/components/schemas/reservationAllowedActionsType'
        revenuesAndBalances:
          description: Revenues and Balances Amount summary for the reservation.
          $ref: '#/components/schemas/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: '#/components/schemas/reservationInterfaceStatusType'
        guestPreferredCurrency:
          description: Currency code preferred by guest.
          type: string
          minLength: 0
          maxLength: 20
        turndownInfo:
          description: Currency code preferred by guest.
          $ref: '#/components/schemas/reservationTurndownInfoType'
        mobileNotifications:
          description: Denotes the status of Room Ready, Key Ready messages.
          $ref: '#/components/schemas/resMobileNotificationsType'
        reservationCommunication:
          description: Collection of reservation communication details.
          $ref: '#/components/schemas/resCommunicationType'
        advanceCheckIn:
          description: Information relating to Reservation's Advance Checked In state and Expected Time of Return
          $ref: '#/components/schemas/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: '#/components/schemas/pMS_ResStatusType'
        computedReservationStatus:
          description: Indicates the status of the reservation.
          $ref: '#/components/schemas/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: '#/components/schemas/resAccessRestrictionType'
        commissionPayoutTo:
          description: If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.
          $ref: '#/components/schemas/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: '#/components/schemas/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
    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: '#/components/schemas/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
    roomConditionAssigmentType:
      type: string
      description: Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.
      enum:
      - Available
      - NotAvailable
    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: '#/components/schemas/housekeepingTaskType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    resAccessRestrictionType:
      type: string
      description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
      enum:
      - Change
      - Cancel
      - ChangeOrCancel
    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
    canceledServicingTaskRoom:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/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: '#/components/schemas/autoGenerateTaskSheetsCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/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: '#/components/schemas/housekeepingRoomStatusInfo'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomCondition:
      type: object
      description: Request element for setting room condition.
      properties:
        criteria:
          description: Criteria to set the condition of a room.
          $ref: '#/components/schemas/setRoomConditionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    reservationIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    housekeepingInstructionsType:
      type: string
      description: Simple type for housekeeping instructions that can be used in requests for partial operations.
      enum:
      - Turndown
      - CleaningPriority
      - ServiceRequest
    communicationStatusType:
      type: string
      description: Enum to denote the Status of Readiness messages sent to Guest Devices.
      enum:
      - Pending
      - Completed
      - Failed
      - Sent
      - Received
      - Cancelled
      - PendingAvailability
    resCashieringType:
      type: object
      description: Cashiering Information for the reservation.
      properties:
        revenuesAndBalances:
          description: Revenues and Balances Amount summary for the reservation.
          $ref: '#/components/schemas/resRevenueBalanceType'
        billingPrivileges:
          description: Billing privileges set on the reservation.
          $ref: '#/components/schemas/billingPrivilegesType'
        taxType:
          description: This stores the code for the type of tax calculation especially with tax exemption, etc.
          $ref: '#/components/schemas/reservationTaxTypeInfo'
        bedTaxReporting:
          description: This stores the information for Bed Tax Reporting. Mainly used in Maldives.
          $ref: '#/components/schemas/bedTaxReportingType'
        folioTexts:
          description: Additional text fields to display on the folio.
          $ref: '#/components/schemas/folioTextsType'
        periodicFolio:
          description: Information regarding periodic folios set on the reservation.
          $ref: '#/components/schemas/resPeriodicFolioType'
        compAccounting:
          description: Information regarding comp accounting on the reservation.
          $ref: '#/components/schemas/resCompAccountingType'
        reservationPreConfiguredRoutingInstruction:
          description: Information regarding the selected preconfigured routing instruction on the reservation.
          $ref: '#/components/schemas/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
    schedule:
      type: object
      description: Return object that contains a list of facility tasks for the reservation specified in RQ.
      properties:
        reservationId:
          $ref: '#/components/schemas/reservationId'
        hotelId:
          description: The hotel where task is being scheduled.
          $ref: '#/components/schemas/codeType'
        guestHouseKeepingInstructions:
          description: Guest housekeeping instructions associated with the reservation requested.
          $ref: '#/components/schemas/resHousekeepingType'
        housekeepingSchedule:
          description: Facility housekeeping schedule for the reservation requested.
          $ref: '#/components/schemas/reservationHousekeepingScheduleType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    resPaymentCardType:
      type: object
      description: Information on a credit card for the customer.
      properties:
        cardId:
          description: credit card id
          $ref: '#/components/schemas/uniqueID_Type'
        currentAuthorizedAmount:
          $ref: '#/components/schemas/currencyAmountType'
        approvalAmountNeeded:
          $ref: '#/components/schemas/currencyAmountType'
        cardType:
          description: Indicates the type of credit card from a defined list
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/cardNumberTypeType'
    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
    hotelRoomMaintenanceType:
      type: object
      description: Hotel Rooms maintenance information type.
      properties:
        roomMaintenance:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomMaintenanceType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    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: '#/components/schemas/facilityTaskType'
        linenChange:
          description: Indicates if a linen change is necessary.
          type: boolean
        status:
          description: This will set/fetch housekeeping service request for room.
          $ref: '#/components/schemas/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: '#/components/schemas/housekeepingRoomStatusType'
    forecastTotalsQuantitiesType:
      type: array
      description: Collection of dates and their total quantities.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/forecastTotalsQuantityType'
    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
    indicatorsType:
      type: array
      description: Collection of lamp indicators.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/indicatorType'
    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
    reservationPaymentMethodType:
      type: object
      properties:
        paymentCard:
          $ref: '#/components/schemas/resPaymentCardType'
        balance:
          $ref: '#/components/schemas/currencyAmountType'
        authorizationRule:
          $ref: '#/components/schemas/authorizationRuleType'
        emailFolioInfo:
          description: Information on an email for the customer.
          type: object
          properties:
            email:
              description: eMail deatils for the profile.
              $ref: '#/components/schemas/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
    roomTypeSuppliesType:
      type: object
      description: List of the facility codes.
      properties:
        facilityCode:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/facilityCodeType'
        type:
          description: Room type code.
          type: string
          minLength: 0
          maxLength: 20
    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
    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: '#/components/schemas/roomOutOfOrderType'
    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: '#/components/schemas/uniqueID_Type'
        roomInfo:
          description: Room Details
          $ref: '#/components/schemas/roomType'
        resolveInfo:
          description: Resolve User and Date for resolved room
          $ref: '#/components/schemas/resolveRoomMaintenanceType'
        assignedUserInfo:
          description: Maintenance request assignment information
          $ref: '#/components/schemas/assignedUserType'
        images:
          description: Collection of Maintenance images
          $ref: '#/components/schemas/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
    completedServicingTaskRoom:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/roomIds'
                range:
                  type: object
                  properties:
                    roomRange:
                      $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    addressInfoType:
      type: object
      description: Provides address information.
      properties:
        address:
          description: Address details for the profile.
          $ref: '#/components/schemas/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
    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
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    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
    roomRangeType:
      type: object
      properties:
        fromRoomNumber:
          type: string
          minLength: 0
          maxLength: 20
        toRoomNumber:
          type: string
          minLength: 0
          maxLength: 20
    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: '#/components/schemas/uniqueID_Type'
        accountNo:
          description: The Account Number for the Account.
          type: string
          minLength: 0
          maxLength: 20
        status:
          description: The status of the account.
          $ref: '#/components/schemas/aRAccountStatusType'
    cardNumberTypeType:
      type: string
      description: Simple type for indicating if credit card number is tokenized.
      enum:
      - CardNumber
      - Token
    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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/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: '#/components/schemas/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
    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: '#/components/schemas/roomTypeTaskType'
    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
    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
    reservationShortInfoType:
      type: object
      properties:
        guestName:
          description: Guest name that is registered for the reservation.
          type: string
          minLength: 0
          maxLength: 80
        reservationId:
          $ref: '#/components/schemas/reservationId'
        reservationStatusInfo:
          $ref: '#/components/schemas/housekeepingRoomReservationStatusType'
        stayDateInfo:
          $ref: '#/components/schemas/stayDateInfoType'
        vipStatus:
          description: VIP status of the guest.
          $ref: '#/components/schemas/vIPStatusType'
        profileId:
          description: ProfileId of the guest.
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/reservationQueueInformationType'
    startedServiceBreak:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    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
    telephoneInfoType:
      type: object
      description: Information on a telephone number for the customer.
      properties:
        telephone:
          description: Phone details for the profile.
          $ref: '#/components/schemas/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
    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: '#/components/schemas/turndownStatusType'
    roomMaintenanceDetails:
      type: object
      description: Response for the Fetch Room Maintenance request.
      properties:
        roomMaintenance:
          description: Collection of room maintenance information records.
          $ref: '#/components/schemas/hotelRoomMaintenanceType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    guestHousekeepingService:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    resProfileTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Group
      - TravelAgent
      - Source
      - ReservationContact
      - BillingContact
      - Addressee
    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
    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
    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: '#/components/schemas/moveTaskRoomsCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    codeListType:
      type: array
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    forecastQuantitiesType:
      type: array
      description: Collection of dates and their quantities.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/forecastQuantityType'
    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
    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: '#/components/schemas/codeDescriptionType'
        tasksQuantity:
          description: This is a room type and its tasks count.
          type: integer
    facilityHousekeepingTaskType:
      type: object
      description: A single facility task type.
      properties:
        facilityTask:
          description: Facility task for the day.
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/facilityCodesType'
    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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    facilityCodesForecastType:
      type: array
      description: Collection of facility codes with their forecasts.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/facilityCodeForecastType'
    hotelInterfaceType:
      type: object
      properties:
        interfaceId:
          description: Unique DB internal number of a Hotel Interface record.
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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
    cardProcessingType:
      type: string
      enum:
      - Eft
      - Manual
    scheduledSearch:
      type: object
      description: An updated schedule for the reservation after the reset.
      properties:
        reservationId:
          $ref: '#/components/schemas/reservationId'
        hotelId:
          description: The hotel where task is being scheduled.
          $ref: '#/components/schemas/codeType'
        housekeepingSchedule:
          description: Updated Facility Schedule.
          $ref: '#/components/schemas/reservationHousekeepingScheduleType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    movedTaskRoomsRS:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    endedServiceBreak:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/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: '#/components/schemas/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
    status:
      type: object
      description: Response Body.
      properties:
        warnings:
          $ref: '#/components/schemas/warningsType'
        links:
          $ref: '#/components/schemas/links'
    authorizerInfoType:
      type: object
      description: Authorizer Information
      properties:
        authorizerId:
          $ref: '#/components/schemas/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
    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: '#/components/schemas/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: '#/components/schemas/housekeepingInstructionsType'
        housekeepingInstructions:
          description: Instructions and associated variables.
          $ref: '#/components/schemas/resHousekeepingType'
    hotelRoomsType:
      type: object
      description: Collection of Room record that contain Housekeeping and Out Of Order information.
      properties:
        room:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    ratePlanRatingType:
      type: string
      description: Possible Rate plan rating values.
      enum:
      - MostImportant
      - Important
      - SomewhatImportant
      - LessImportant
      - LeastImportant
      - NoValueSet
    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: '#/components/schemas/setGuestHousekeepingServiceRequestCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    taskSheetToMerge:
      type: object
      description: Request for merging task sheets.
      properties:
        criteria:
          description: Criteria to merge task sheets.
          $ref: '#/components/schemas/mergeTaskSheetCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    turndownInfoType:
      type: object
      properties:
        turndownStatusInfo:
          $ref: '#/components/schemas/turndownStatusType'
    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
    facilityHousekeepingTasksType:
      type: array
      description: List of the facility tasks.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/facilityHousekeepingTaskType'
    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
    nameTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Agent
      - Contact
      - Source
      - Group
      - Employee
      - Hotel
      - Purge
    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
    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
    applicationUserType:
      type: object
      properties:
        hotel:
          description: Hotel where user belongs.
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/employeeInfoType'
        userSessionInfo:
          description: This is only used during log-in.
          $ref: '#/components/schemas/userSessionInfoType'
        attendantInfo:
          $ref: '#/components/schemas/attendantType'
    taskSheetType:
      type: string
      description: Task Sheet classification.
      enum:
      - NoServiceRequired
      - DoNotDisturb
      - ManuallyCreated
      - AutomaticGeneration
      - Isolated
      - ExtraRooms
      - ServiceDeclined
    housekeepingRoomStatus:
      type: object
      description: Response Body.
      properties:
        warnings:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/warningsType'
        links:
          $ref: '#/components/schemas/links'
    payeeInfoType:
      type: object
      description: Payee information.
      properties:
        payeeId:
          description: Opera name id of the payee.
          $ref: '#/components/schemas/uniqueID_Type'
        payeeName:
          description: Name of the payee.
          type: string
          minLength: 0
          maxLength: 80
        payeeAddress:
          description: Address of the payee.
          $ref: '#/components/schemas/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: '#/components/schemas/aRAccountShortInfoType'
        payeeTaxNumber:
          description: The tax number of the payee.
          type: string
          minLength: 0
          maxLength: 40
    resAccompanyGuestListType:
      type: array
      description: Collection of accompany guests
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resAccompanyGuestInfoType'
    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: '#/components/schemas/reservationHousekeepingScheduleSearchType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    basicEmailType:
      type: string
      description: Email address
      minLength: 0
      maxLength: 2000
    blockIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    resSharedGuestListType:
      type: array
      description: Collection of shared guest reservations.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resSharedGuestInfoType'
    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: '#/components/schemas/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
    scheduledShiftRequest:
      type: object
      description: An updated schedule for the reservation after the shift.
      properties:
        reservationId:
          $ref: '#/components/schemas/reservationId'
        hotelId:
          description: The hotel where task is being scheduled.
          $ref: '#/components/schemas/codeType'
        housekeepingSchedule:
          description: Updated Facility Schedule.
          $ref: '#/components/schemas/reservationHousekeepingScheduleType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/housekeepingRoomsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    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: '#/components/schemas/codeDescriptionType'
        cro:
          $ref: '#/components/schemas/codeDescriptionType'
        chain:
          type: string
          minLength: 0
          maxLength: 20
        cROCountryCode:
          type: string
          minLength: 0
          maxLength: 20
        sessionDefaults:
          $ref: '#/components/schemas/userSessionDefaultsType'
        parameters:
          $ref: '#/components/schemas/parametersType'
    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: '#/components/schemas/communicationStatusType'
        keyReady:
          description: Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED
          $ref: '#/components/schemas/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
    facilityTaskType:
      type: object
      description: Information regarding facility task on a reservation.
      properties:
        task:
          description: The Task Code.
          $ref: '#/components/schemas/housekeepingTaskCodeType'
        supplies:
          description: Supplies associated with the task.
          $ref: '#/components/schemas/facilityCodesType'
        date:
          description: The Date on which the task is applicable.
          type: string
          format: date
          maxLength: 8
    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
    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
    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
    skipedServicingTaskRoom:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/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: '#/components/schemas/housekeepingAttendantScheduleType'
    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: '#/components/schemas/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
    roomSectionType:
      type: object
      properties:
        daySectionCode:
          type: string
          minLength: 0
          maxLength: 20
        eveningSectionCode:
          type: string
          minLength: 0
          maxLength: 20
    roomFeaturesType:
      type: array
      description: A recurring element that identifies the room features.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomFeatureType'
    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: '#/components/schemas/roomType'
        taskCode:
          description: The task code for the task sheets, for which the rooms are being moved.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/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
    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: '#/components/schemas/codeDescriptionType'
        assignmentType:
          description: Determine if room, after applying condition, is available or not in Room Assignment listing.
          $ref: '#/components/schemas/roomConditionAssigmentType'
        remarks:
          description: Remarks on room condition assignment.
          type: string
          minLength: 0
          maxLength: 2000
    housekeepingType:
      type: object
      description: Identifies the Housekeeping information.
      properties:
        housekeepingRoomStatus:
          description: The Room status information per the reservation and housekeeping.
          $ref: '#/components/schemas/roomStatusType'
        roomPersons:
          description: The Room person information per the reservation and housekeeping.
          $ref: '#/components/schemas/roomPersonsType'
        guestServiceRequest:
          $ref: '#/components/schemas/guestHousekeepingServiceRequestType'
        cleaningPriority:
          description: Cleaning priority for the room, if a priority was set.
          $ref: '#/components/schemas/roomCleaningPriorityType'
        roomCondition:
          description: Condition of the room, if a condition was set.
          $ref: '#/components/schemas/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: '#/components/schemas/codeListType'
        roomCompleted:
          description: Indicates if this room has been completed. A room is complete when it reaches the highest available Room Status.
          type: boolean
    surnameType:
      type: string
      description: Family name, last name.
      minLength: 0
      maxLength: 40
    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
    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: '#/components/schemas/currencyAmountType'
        totalStay:
          description: The total number of previous stay of the guest.
          type: integer
    rooms:
      type: object
      properties:
        housekeepingRooms:
          description: List of rooms and the room status.
          $ref: '#/components/schemas/hotelRoomsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    emailInfoType:
      type: object
      description: Information on an email for the customer.
      properties:
        email:
          description: eMail deatils for the profile.
          $ref: '#/components/schemas/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
    roomAssignmentStatusType:
      type: string
      enum:
      - Assigned
      - Unassigned
    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: '#/components/schemas/housekeepingTaskCodeType'
            departureTaskInfo:
              description: Facility task info related to the departure task.
              $ref: '#/components/schemas/departureTaskInfoType'
            totalSupplies:
              description: All Supplies, and their totals, associated with the Task Sheet.
              $ref: '#/components/schemas/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: '#/components/schemas/housekeepingCreditsType'
            attendant:
              description: Information regarding Housekeeping Attendants.
              type: object
              properties:
                section:
                  description: Section Code the attendant has been assigned.
                  $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/roomFeaturesType'
                  roomDescription:
                    description: Detail Long Description Of The Room.
                    type: string
                    minLength: 0
                    maxLength: 20
                  description:
                    description: Description of the room.
                    $ref: '#/components/schemas/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: '#/components/schemas/ratePlanRatingType'
                  roomNumber:
                    description: Code of the room.
                    type: string
                    minLength: 0
                    maxLength: 20
                  roomSection:
                    description: Room sections of the room.
                    $ref: '#/components/schemas/roomSectionType'
                  housekeeping:
                    description: Identifies the Housekeeping information..
                    $ref: '#/components/schemas/housekeepingType'
                  outOfOrder:
                    description: Identifies the room Out of Order/Out of Service information.
                    $ref: '#/components/schemas/roomsOutOfOrderType'
                  discrepancy:
                    description: Identifies the room discrepancy information.
                    $ref: '#/components/schemas/roomDiscrepanciesType'
                  sitePlanSection:
                    description: Identifies the site plan location of the room.
                    $ref: '#/components/schemas/sitePlanSectionType'
                  componentRoomNumber:
                    description: This flag indicates component room.
                    type: string
                    minLength: 0
                    maxLength: 20
                  connectingRooms:
                    description: This flag indicates connecting rooms.
                    $ref: '#/components/schemas/roomRoomsType'
                  componentRooms:
                    description: This flag indicates component rooms.
                    $ref: '#/components/schemas/roomRoomsType'
                  attendant:
                    type: array
                    items:
                      $ref: '#/components/schemas/currentServicingAttendantType'
                  hold:
                    description: Hold attributes if any.
                    $ref: '#/components/schemas/roomHoldType'
                  turndownInfo:
                    $ref: '#/components/schemas/turndownInfoType'
                  resvInfo:
                    type: array
                    items:
                      $ref: '#/components/schemas/reservationShortInfoType'
                  reservationInfo:
                    type: array
                    items:
                      $ref: '#/components/schemas/reservationInfoType'
                  servicingInfo:
                    description: Information regarding the current servicing of the room.
                    type: array
                    items:
                      $ref: '#/components/schemas/currentServicingAttendantType'
                  maintenance:
                    $ref: '#/components/schemas/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: '#/components/schemas/taskSheetType'
            attendantStatus:
              description: Status of Housekeeping Attendant assigned to this TaskSheet. This value holds the most recent status posted by the attendant.
              $ref: '#/components/schemas/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: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/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: '#/components/schemas/roomIds'
        assignedUserInfo:
          description: Maintenance request assignment information
          $ref: '#/components/schemas/assignedUserType'
        hotelId:
          description: Hotel code
          type: string
          minLength: 0
          maxLength: 20
    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: '#/components/schemas/errorInstance'
        links:
          $ref: '#/components/schemas/links'
      required:
      - type
      - title
    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
    facilityCodesType:
      type: array
      description: List of the facility codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/facilityCodeType'
    resAttachedProfileListType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resAttachedProfileType'
    roomConditionRequestStatus:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    roomType:
      type: object
      description: This type represents the primary room attributes.
      properties:
        roomType:
          description: Room type basic information of the room.
          $ref: '#/components/schemas/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: '#/components/schemas/roomFeaturesType'
        roomDescription:
          description: Detail Long Description Of The Room.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the room.
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/roomSectionType'
        housekeeping:
          description: Identifies the Housekeeping information..
          $ref: '#/components/schemas/housekeepingType'
        outOfOrder:
          description: Identifies the room Out of Order/Out of Service information.
          $ref: '#/components/schemas/roomsOutOfOrderType'
        discrepancy:
          description: Identifies the room discrepancy information.
          $ref: '#/components/schemas/roomDiscrepanciesType'
        componentRoomNumber:
          description: This flag indicates component room.
          type: string
          minLength: 0
          maxLength: 20
        connectingRooms:
          description: This flag indicates connecting rooms.
          $ref: '#/components/schemas/roomRoomsType'
        componentRooms:
          description: This flag indicates component rooms.
          $ref: '#/components/schemas/roomRoomsType'
        attendant:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/currentServicingAttendantType'
        hold:
          description: Hold attributes if any.
          $ref: '#/components/schemas/roomHoldType'
        turndownInfo:
          $ref: '#/components/schemas/turndownInfoType'
        resvInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationShortInfoType'
        componentRoomNumbers:
          description: List of component room numbers.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
    roomRoomType:
      type: object
      description: This type represents the primary room attributes.
      properties:
        roomType:
          description: Room type basic information of the room.
          $ref: '#/components/schemas/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: '#/components/schemas/roomFeaturesType'
        roomDescription:
          description: Detail Long Description Of The Room.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the room.
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/codeDescriptionType'
    roomPersonsCountType:
      type: object
      properties:
        houseKeepingPersons:
          type: integer
    facilityTotalForecastType:
      type: object
      description: The Total of the forecasts.
      properties:
        totals:
          description: Total forecast of all facility codes.
          $ref: '#/components/schemas/forecastTotalsQuantitiesType'
        totalFacilityCodes:
          description: Total forecast of each Facility code.
          $ref: '#/components/schemas/facilityCodesForecastType'
    roomDiscrepanciesType:
      type: array
      description: Room Discrepancies between front office and housekeeping room status and number of persons in the room.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomDiscrepancyType'
    personNameTypeType:
      type: string
      description: Person's name in an external system.
      enum:
      - Primary
      - Alternate
      - Incognito
      - External
      - Phonetic
    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
    roomPersonsType:
      type: object
      properties:
        frontOfficePersons:
          type: integer
        houseKeepingPersons:
          type: integer
    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: '#/components/schemas/autoGenerateTaskSheetsCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/givenNameType'
        surname:
          description: Family name, last name.
          $ref: '#/components/schemas/surnameType'
    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
    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
    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: '#/components/schemas/translationsTextType'
    phoneNumberType:
      type: string
      description: Phone number
      minLength: 0
      maxLength: 40
    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
    daysOfWeekType:
      type: string
      description: Allowed values for the days of week type.
      enum:
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
    hotelInterfaceStatusType:
      type: string
      description: Status of the Hotel Interface either STOPPED or RUNNING.
      enum:
      - Stopped
      - Running
      - Waiting
      - StopInitiated
      - StartInitiated
      - RebootInitiated
      - Other
    givenNameType:
      type: string
      description: Given name, first name or names
      minLength: 0
      maxLength: 40
    imageResultsType:
      type: array
      description: Collection of image results.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/imageResultType'
    pingRS:
      type: object
      description: Response for Ping operation.
      properties:
        operaVersion:
          description: Opera version number.
          $ref: '#/components/schemas/operaVersionNumberType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    facilityCodeForecastType:
      type: object
      description: A facility code and its forecast.
      properties:
        forecast:
          description: The forecast of quantities for this facility code.
          $ref: '#/components/schemas/forecastQuantitiesType'
        code:
          description: Facility Task code.
          $ref: '#/components/schemas/codeDescriptionType'
    roomMaintenanceRequest:
      type: object
      description: Request to create a room maintenance record.
      properties:
        criteria:
          description: Information to create new room maintenance request.
          $ref: '#/components/schemas/roomMaintenanceRequestType'
        includeDetails:
          description: Attribute to decide whether response should include additional details.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    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
    attendantType:
      type: object
      properties:
        attendantId:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    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: '#/components/schemas/resHousekeepingType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    unresolvedRoomMaintenance:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    resRevenueBalanceType:
      type: object
      description: Revenue and Balance Amount summary for the reservation.
      properties:
        totalFixedCharge:
          description: Total Fixed Charges on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        totalPayment:
          description: Total payment received for the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        roomRevenue:
          description: Room Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        foodAndBevRevenue:
          description: Food and Beverage Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        otherRevenue:
          description: Other Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        nonRevenue:
          description: Total Non Revenue posted on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        totalRevenue:
          description: Total Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        balance:
          description: Balance amount on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        compBalance:
          description: Comp Balance amount
          $ref: '#/components/schemas/currencyAmountType'
    housekeepingRoomStatusCriteria:
      type: object
      properties:
        roomList:
          description: Collection of room numbers for which the status is to be updated.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomInformationType'
        housekeepingStatus:
          description: The new Housekeeping status that will be assigned.
          $ref: '#/components/schemas/frontOfficeRoomStatusType'
        housekeepingRoomStatus:
          description: The new Room status that will be assigned.
          $ref: '#/components/schemas/housekeepingRoomStatusType'
        turndownStatus:
          $ref: '#/components/schemas/turndownStatusType'
        roomPersons:
          description: The Room person information per the reservation and housekeeping.
          $ref: '#/components/schemas/roomPersonsCountType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/housekeepingCreditsDefinitionType'
        numberOfCredits:
          description: Total number of Credits for the Type.
          type: number
    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: '#/components/schemas/roomTypeSuppliesType'
        code:
          description: Facility task code of the departure task.
          type: string
          minLength: 0
          maxLength: 20
    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: '#/components/schemas/roomTypeTasksType'
    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
    parametersType:
      type: array
      description: Collection of generic Name-Value-Pair parameters.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/parameterType'
    anonymizationType:
      type: object
      description: Provides information about guest's anonymization status.
      properties:
        anonymizationStatus:
          description: Status of anonymization such as Requested or Anonymized.
          $ref: '#/components/schemas/anonymizationStatusType'
        anonymizationDate:
          description: Date and Time when the guest was anonymized.
          type: string
          format: date-time
    resAttachedProfileType:
      type: object
      properties:
        name:
          description: Attached profile name
          type: string
        profileIdList:
          description: Collection of unique profile identifiers
          $ref: '#/components/schemas/profileIdList'
        reservationProfileType:
          $ref: '#/components/schemas/resProfileTypeType'
    housekeepingTaskStayPeriodType:
      type: string
      description: Simple type for controlling the fetch operations of the housekeeping schedule request.
      enum:
      - EntireStay
      - SpecificDates
    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
    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
    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
    resolvedRoomMaintenance:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    operaVersionNumberType:
      type: string
      description: Current Opera Version Number
      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: '#/components/schemas/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
    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
    housekeepingTaskType:
      type: object
      properties:
        taskCodes:
          description: The Task Code(s) used for this Task Sheet.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/housekeepingTaskCodeType'
        departureTaskInfo:
          description: Facility task info related to the departure task.
          $ref: '#/components/schemas/departureTaskInfoType'
        totalSupplies:
          description: All Supplies, and their totals, associated with the Task Sheet.
          $ref: '#/components/schemas/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: '#/components/schemas/housekeepingCreditsType'
        attendant:
          description: Information regarding Housekeeping Attendants.
          type: object
          properties:
            section:
              description: Section Code the attendant has been assigned.
              $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/roomFeaturesType'
              roomDescription:
                description: Detail Long Description Of The Room.
                type: string
                minLength: 0
                maxLength: 20
              description:
                description: Description of the room.
                $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/roomSectionType'
              housekeeping:
                description: Identifies the Housekeeping information..
                $ref: '#/components/schemas/housekeepingType'
              outOfOrder:
                description: Identifies the room Out of Order/Out of Service information.
                $ref: '#/components/schemas/roomsOutOfOrderType'
              discrepancy:
                description: Identifies the room discrepancy information.
                $ref: '#/components/schemas/roomDiscrepanciesType'
              sitePlanSection:
                description: Identifies the site plan location of the room.
                $ref: '#/components/schemas/sitePlanSectionType'
              componentRoomNumber:
                description: This flag indicates component room.
                type: string
                minLength: 0
                maxLength: 20
              connectingRooms:
                description: This flag indicates connecting rooms.
                $ref: '#/components/schemas/roomRoomsType'
              componentRooms:
                description: This flag indicates component rooms.
                $ref: '#/components/schemas/roomRoomsType'
              attendant:
                type: array
                maxItems: 4000
                items:
                  $ref: '#/components/schemas/currentServicingAttendantType'
              hold:
                description: Hold attributes if any.
                $ref: '#/components/schemas/roomHoldType'
              turndownInfo:
                $ref: '#/components/schemas/turndownInfoType'
              resvInfo:
                type: array
                maxItems: 4000
                items:
                  $ref: '#/components/schemas/reservationShortInfoType'
              scheduledRoomMoveResvInfo:
                type: array
                maxItems: 4000
                items:
                  $ref: '#/components/schemas/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: '#/components/schemas/reservationInfoType'
              servicingInfo:
                description: Information regarding the current servicing of the room.
                type: array
                maxItems: 4000
                items:
                  $ref: '#/components/schemas/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: '#/components/schemas/taskSheetType'
        attendantStatus:
          description: Status of Housekeeping Attendant assigned to this TaskSheet. This value holds the most recent status posted by the attendant.
          $ref: '#/components/schemas/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
    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
    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: '#/components/schemas/facilityTaskForecastType'
            totals:
              description: Totals
              $ref: '#/components/schemas/facilityTotalForecastType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    taskSheetToUnlock:
      type: object
      description: Request for unlocking a task sheet.
      properties:
        criteria:
          description: Criteria to unlock a task sheet.
          $ref: '#/components/schemas/taskSheetLockCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomInformationType:
      type: object
      description: Room Information needed in updating the status.
      properties:
        roomId:
          type: string
          minLength: 0
          maxLength: 20
        reservationId:
          $ref: '#/components/schemas/reservationId'
    housekeepingScheduleShiftDayType:
      type: object
      description: Day of the week to which schedule of the week is to be shifted to.
      properties:
        dayOfWeek:
          $ref: '#/components/schemas/daysOfWeekType'
    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
    roomStatusType:
      type: object
      properties:
        reservationStatusList:
          description: List of status of the reservation to which this Room is assigned..
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/housekeepingRoomReservationStatusType'
        housekeepingRoomStatus:
          description: Status of the room (Dirty/Clean/Inspected/Pickup).
          $ref: '#/components/schemas/housekeepingRoomStatusType'
        frontOfficeStatus:
          description: Front office status ( Occupied/Vacant ).
          $ref: '#/components/schemas/frontOfficeRoomStatusType'
        housekeepingStatus:
          description: Housekeeping status ( Occupied/Vacant ).
          $ref: '#/components/schemas/frontOfficeRoomStatusType'
    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: '#/components/schemas/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: '#/components/schemas/dateRangeType'
        housekeepingRoomStatus:
          description: The out of order or out of service room status OO/OS.
          $ref: '#/components/schemas/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: '#/components/schemas/uniqueID_Type'
    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.
    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
    reservationAllowedActionsType:
      type: array
      description: Allowed action.
      maxItems: 11
      items:
        $ref: '#/components/schemas/reservationAllowedActionType'
    taskAssignment:
      type: object
      properties:
        taskAssignmentInfo:
          description: Information regarding the Task Sheets for the Task Assignment.
          $ref: '#/components/schemas/housekeepingTaskAssignmentsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/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
    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
    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
    searchMatchesType:
      type: array
      description: List of Generic Name-Value-Pair Parameters used for super search matches.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/searchMatchType'
    externalReferencesType:
      type: array
      description: This type contains unique information of external reference.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/externalReferenceType'
    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: '#/components/schemas/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: '#/components/schemas/housekeepingScheduleShiftDayType'
    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
    changedTaskSheetRooms:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/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: '#/components/schemas/resHousekeepingSetType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    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
    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
    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
    taskSheetToLock:
      type: object
      description: Request for locking a task sheet.
      properties:
        criteria:
          description: Criteria to lock or unlock a task sheet.
          $ref: '#/components/schemas/taskSheetLockCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    serviceTaskRoomType:
      type: object
      description: Criteria for servicing a task room.
      properties:
        taskCodes:
          description: List of Task Codes of the task sheet.
          $ref: '#/components/schemas/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: '#/components/schemas/frontOfficeRoomStatusType'
        housekeepingRoomStatus:
          description: The room status code example Clean, Dirty etc.
          $ref: '#/components/schemas/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
    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: '#/components/schemas/authorizerInfoType'
        ratePlanCode:
          description: Rate Code with attached Routing Instruction.
          type: string
          minLength: 0
          maxLength: 20
        profileType:
          description: Profile Type with attached Routing Instruction.
          $ref: '#/components/schemas/resProfileTypeType'
        promotionCode:
          description: Promotion Code with attached Complimentary Routing.
          type: string
          minLength: 0
          maxLength: 20
    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
    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: '#/components/schemas/serviceTaskRoomType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    guestHousekeepingServiceRequestStatus:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomCleaningPriorityRequestStatus:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomRoomsType:
      type: array
      description: Collection of rooms.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomRoomType'
    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
    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: '#/components/schemas/guestHousekeepingServiceRequestType'
    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: '#/components/schemas/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: '#/components/schemas/applicationUserType'
        startTime:
          description: The start time of the service.
          type: string
          format: date-time
        status:
          description: Status of the respective Housekeeping Attendant.
          $ref: '#/components/schemas/servicingAttendantStatusType'
    lockedTaskSheet:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/membershipInfoType'
        namePrefix:
          description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
          $ref: '#/components/schemas/namePrefixType'
        givenName:
          description: Given name, first name or names
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/phoneNumberType'
        email:
          description: Email address
          $ref: '#/components/schemas/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: '#/components/schemas/countryNameType'
        vip:
          description: The supplier's ranking of the customer (e.g., VIP, numerical ranking).
          $ref: '#/components/schemas/vIPType'
        address:
          description: Address information that is attached to the reservation guest
          $ref: '#/components/schemas/addressSearchType'
        anonymization:
          description: Provides information about the guest's anonymization status
          $ref: '#/components/schemas/anonymizationType'
        accompanyGuests:
          description: List of guest names that are accompanying the reservation guest
          $ref: '#/components/schemas/resAccompanyGuestListType'
        externalInfo:
          description: External information about the guest associated with the reservation.
          $ref: '#/components/schemas/resGuestExternalInfoType'
        guestLastStayInfo:
          description: Contains information regarding the last stay of this guest.
          $ref: '#/components/schemas/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: '#/components/schemas/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
    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
    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: '#/components/schemas/payeeInfoType'
        balance:
          description: Running balance of the window.
          $ref: '#/components/schemas/currencyAmountType'
        paymentMethod:
          description: Payment Method Type
          type: string
          minLength: 0
          maxLength: 20
        folioWindowNo:
          type: integer
    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: '#/components/schemas/taskSheetGenerationStatusTypesType'
        instructions:
          description: The Room Instructions, Task Instructions and Attendant Instructions which will be added to the Task Sheets.
          $ref: '#/components/schemas/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
    reservationBlockType:
      type: object
      description: Key information about the block for a reservation.
      properties:
        blockIdList:
          description: Collection of unique block identifiers for the reservation.
          $ref: '#/components/schemas/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
    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
    employeeInfoType:
      type: object
      properties:
        personName:
          $ref: '#/components/schemas/personNameType'
        profileId:
          $ref: '#/components/schemas/uniqueID_Type'
        addressInfo:
          $ref: '#/components/schemas/addressInfoType'
        emailInfo:
          $ref: '#/components/schemas/emailInfoType'
        phoneInfo:
          $ref: '#/components/schemas/telephoneInfoType'
        department:
          $ref: '#/components/schemas/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
    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
    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: '#/components/schemas/housekeepingTaskCodeType'
        taskSheets:
          description: List of Task Sheets generated for this assignment.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/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
    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
    housekeepingTaskAssignmentsType:
      type: array
      description: Collection of Assignments
      maxItems: 4000
      items:
        $ref: '#/components/schemas/housekeepingTaskAssignmentType'
    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: '#/components/schemas/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
    anonymizationStatusType:
      type: string
      description: Guest has been anonymized.
      enum:
      - Requested
      - Anonymized
    changedTaskSheetTemplate:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    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: '#/components/schemas/applicationUserType'
        startTime:
          description: Start time when the break started. Uses the hotel's time zone.
          type: string
          format: date-time
    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: '#/components/schemas/housekeepingAttendantsScheduleType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    changedTaskSheet:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    servicingAttendantStatusType:
      type: string
      description: Possible values for the Status of a Servicing Attendant.
      enum:
      - Standby
      - Break
      - Working
      - Completed
    stayDateInfoType:
      type: object
      description: Room attached with stay detail information
      properties:
        timeSpan:
          $ref: '#/components/schemas/timeSpanType'
        expectedTimes:
          $ref: '#/components/schemas/resExpectedTimesType'
    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
    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
    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: '#/components/schemas/hotelInterfaceType'
        interfaceRights:
          description: Contains a list of status/rights for the various services under this interface
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/interfaceRightsStatusType'
    facilityTaskForecastType:
      type: object
      description: A facility task and its forecast.
      properties:
        taskForecast:
          description: Forecast of quantities for this facility task.
          $ref: '#/components/schemas/forecastQuantitiesType'
        facilityCodes:
          description: Forecast of Facility codes belonging to this facility task.
          $ref: '#/components/schemas/facilityCodesForecastType'
        task:
          description: Facility Task.
          $ref: '#/components/schemas/codeDescriptionType'
    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
    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
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    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: '#/components/schemas/codeListType'
        roomCondition:
          description: Condition to be assigned on the room.
          $ref: '#/components/schemas/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
    completeRoomRepairStatus:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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: '#/components/schemas/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
    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: '#/components/schemas/currencyAmountType'
        percent:
          description: A percentage value if the authorization rule is percentage based.
          type: number
    commissionPayoutToType:
      type: string
      enum:
      - TravelAgent
      - Source
      - TravelAgentSource
      - None
    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
    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: '#/components/schemas/roomTypeTasksType'
        totalCredits:
          description: Total Credits on the specified date.
          type: integer
      description: Quatity data for a single day.
    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
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '503':
      description: Service Unavailable
    '413':
      description: Request Entity Too Large
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '403':
      description: Forbidden
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    x-hotelid:
      name: x-hotelid
      description: Mandatory parameter to identify the hotel code where the end user is logged in
      in: header
      required: true
      schema:
        type: string
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    externalData:
      name: externalData
      description: Pass this header as true, if payload needs DVM
      in: header
      schema:
        type: string
    Accept-Language:
      name: Accept-Language
      description: Language code
      in: header
      schema:
        type: string
    x-app-key:
      name: x-app-key
      description: Client or Partner's Application Key
      in: header
      required: true
      schema:
        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}$
    x-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    x-request-id:
      name: x-request-id
      description: Request Id of an incoming request
      in: header
      schema:
        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}
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html