openapi: 3.2.0
info:
  title: OPERA Cloud Service Front Desk Operations API
  description: APIs to cater for Front Desk Operations and Front Desk Statistic functionality in OPERA Cloud. <br /><br /> Front Desk features some of the most commonly used operations in OPERA Cloud, such as managing guest arrivals, managing in-house guests, and managing guest departures. Some additional tasks you can complete from the Front Desk menu are room searches, room assignments, and quick check outs as well as opening folios, creating registration cards, setting wake up calls, and sending messages to guests.<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: /fof/v1
tags:
- name: FrontDeskOperations
  description: Front Desk module provides APIs related to a guests stay in the property. For example, checking a guest into the property, providing room information, splitting reservations, as well as adding wake-up calls to a reservation. This module goes hand-in-hand with cashiering module.
paths:
  /hotels/{hotelId}/authorizationReservations:
    get:
      summary: Get resrvation for batch CCAuth
      description: This API is used to get reservations for batch CC Authorization. <p><strong>OperationId:</strong>getResvForBatchCCAuth</p>
      operationId: getResvForBatchCCAuth
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: guestName
        in: query
        required: false
        description: Used for Character Strings, length 0 to 80.
        schema:
          type: string
      - name: room
        in: query
        required: false
        description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
        schema:
          type: string
      - name: arrivalStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: reservationStatus
        in: query
        required: false
        description: 'Indicates the status of the reservations that is to be returned '
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - CheckedIn
            - InHouse
            - Arrival
            - Reserved
          uniqueItems: true
      - name: cardType
        in: query
        description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Ab
            - Am
            - Ax
            - Cb
            - Dc
            - Ds
            - Dt
            - Ec
            - Er
            - Jc
            - Jl
            - Mc
            - Nb
            - So
            - St
            - Sw
            - Va
            - Xy
            - Zz
            - Cp
            - Cu
          uniqueItems: true
      - name: userDefinedCardType
        in: query
        description: Listing of user defined credit card types.
        required: false
        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: Response which contains a listing of reservations, and associated payment methods, that require credit card authorization.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/resvForBatchCCAut'
        '204':
          description: ResvForBatchCCAuth 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:
      - FrontDeskOperations
  /hotels/{hotelId}/batchReservationAuthorizations:
    put:
      summary: Process batch CC Auth
      description: This API is used to process batch CC Authorization. <p><strong>OperationId:</strong>processBatchCCAuth</p>
      operationId: processBatchCCAuth
      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 for starting a credit card authorization batch job, which contains the batch ID upon success.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/batchCCAuthToProcess'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/batchCCAuth'
        description: Request to start a batch job that will process a list of reservation, and their associated payment methods, that require credit card authorizations.
        required: true
  /hotels/{hotelId}/billingReservations:
    get:
      summary: Get Reservations for billing
      description: You can use this API to fetch the reservations for billing. <p><strong>OperationId:</strong>getReservationsForBilling</p> <p>This API allows a time span of <strong>50</strong> days.</p>
      operationId: getReservationsForBilling
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        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: searchType
        in: query
        required: false
        description: Represents Reservation search type Player Snapshot.
        schema:
          type: string
          enum:
          - Any
          - DayUse
          - Arrival
          - Arrived
          - Departure
          - WaitList
          - Cancellation
          - CheckedOut
          - NoShow
          - Complimentary
          - InHouse
          - PostStayPendingBalance
          - PreRegistered
          - PostToRoom
          - OpenFolio
          - ScheduledCheckOut
          - Queued
          - MobileCheckout
          - RegisteredAndInHouse
          - ResvBlockTraces
          - GuestMessages
          - MassCancellation
          - Operator
          - Turndown
          - WalkIn
          - AdvanceCheckedIn
          - OpenBalance
          - AutoFolioSettlement
          - Routing
          - PlayerSnapshot
          uniqueItems: true
      - name: multipleHotelsSearchList
        in: query
        description: Hotel code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: superSearch
        in: query
        required: false
        description: Free form text field for searching all reservation fields
        schema:
          type: string
      - name: reservationId
        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: reservationIdContext
        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: reservationIdType
        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: nights
        in: query
        required: false
        description: The number of nights on a reservation.
        schema:
          type: integer
      - name: arrivalEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: departureEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: departureStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: reservationProfileType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Guest
            - Company
            - Group
            - TravelAgent
            - Source
            - ReservationContact
            - BillingContact
            - Addressee
          uniqueItems: true
      - name: attachedProfileName
        in: query
        description: Attached profile name
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: attachedProfileId
        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: attachedProfileIdContext
        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: attachedProfileIdType
        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: resGuestId
        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: resGuestIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: resGuestIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: membershipId
        in: query
        required: false
        description: Membership ID criteria.
        schema:
          type: string
      - name: membershipLevelCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: membershipTypeCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: surname
        in: query
        required: false
        description: Family name, last name.
        schema:
          type: string
      - name: givenName
        in: query
        required: false
        description: Given name, first name or names
        schema:
          type: string
      - name: cityName
        in: query
        required: false
        description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
        schema:
          type: string
      - name: postalCode
        in: query
        required: false
        description: Post Office Code number.
        schema:
          type: string
      - name: state
        in: query
        required: false
        description: State or Province name (e.g., Texas).
        schema:
          type: string
      - name: countryCode
        in: query
        required: false
        description: Code for a country or a nationality.
        schema:
          type: string
      - name: streetAddress
        in: query
        required: false
        description: First Line of Street Address. For profile search it matches the first Address line.
        schema:
          type: string
      - name: bookingChannelCode
        in: query
        required: false
        description: Booking Channel Code
        schema:
          type: string
      - name: blockHotelId
        in: query
        required: false
        description: The Hotel Code of the Block.
        schema:
          type: string
      - name: blockId
        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: blockIdContext
        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: blockIdType
        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: recordLocator
        in: query
        required: false
        description: GDS Record Locator for reservation.
        schema:
          type: string
      - name: orderByAttributeName
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: orderType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Asc
            - Desc
          uniqueItems: true
      - name: roomId
        in: query
        required: false
        description: Room number of the reservation to search by.
        schema:
          type: string
      - name: roomType
        in: query
        description: Room Type.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: fetchInstructions
        in: query
        description: Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Reservation
            - ReservationID
            - Indicators
            - Deposits
            - RevenuesAndBalances
            - GuestServiceStatus
            - MasterInfo
            - CancellationInfo
            - BlockReservations
            - TaxType
            - GuestDeviceNotification
            - RoomAssignedByAI
          uniqueItems: true
      - name: excludeNoPost
        in: query
        required: false
        description: Indicates that reservations with No Post flag should not be expected from the result.
        schema:
          type: boolean
      - name: excludePMRooms
        in: query
        required: false
        description: Indicates that reservations with PM room type should not be expected from the result.
        schema:
          type: boolean
      - name: hasOpenFolio
        in: query
        required: false
        description: Indicates that only reservations with open folio should be expected from the result.
        schema:
          type: boolean
      - name: excludedReservationIds
        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: excludedReservationIdsContext
        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: excludedReservationIdsType
        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: advanceCheckedIn
        in: query
        required: false
        description: Indicates to exclude Advance Checked In Reservations from search result.
        schema:
          type: boolean
      - name: searchTypesSearchType
        in: query
        description: Represents Reservation search type Player Snapshot.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Any
            - DayUse
            - Arrival
            - Arrived
            - Departure
            - WaitList
            - Cancellation
            - CheckedOut
            - NoShow
            - Complimentary
            - InHouse
            - PostStayPendingBalance
            - PreRegistered
            - PostToRoom
            - OpenFolio
            - ScheduledCheckOut
            - Queued
            - MobileCheckout
            - RegisteredAndInHouse
            - ResvBlockTraces
            - GuestMessages
            - MassCancellation
            - Operator
            - Turndown
            - WalkIn
            - AdvanceCheckedIn
            - OpenBalance
            - AutoFolioSettlement
            - Routing
            - PlayerSnapshot
          uniqueItems: true
      - name: reservationStatus
        in: query
        description: Reservation status type for reservations search.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Cancelled
            - CheckedOut
            - CheckedIn
            - DueIn
            - DueOut
            - InHouse
            - NoShow
            - WaitList
          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 object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reservationsInfo'
        '204':
          description: ReservationsForBilling 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:
      - FrontDeskOperations
  /hotels/{hotelId}/dailyDocket:
    get:
      summary: Get Daily Docket
      description: Use this API to fetch Daily Dockets. <p><strong>OperationId:</strong>getDailyDocket</p>
      operationId: getDailyDocket
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: docketDate
        in: query
        required: false
        description: log book date.
        schema:
          type: string
          format: date
      - name: department
        in: query
        required: false
        description: Department code the log book entries belong to.
        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 object for fetching log book entries.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/dailyDocket'
        '204':
          description: DailyDocket 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:
      - FrontDeskOperations
    put:
      summary: 'Change Daily Docket '
      description: Use this API to change Daily Docket. <p><strong>OperationId:</strong>putDailyDocket</p>
      operationId: putDailyDocket
      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/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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/dailyDocket'
        description: Change log book entries.
        required: true
    post:
      summary: 'Create Daily Docket '
      description: Use this API to create a Daily Docket. <p><strong>OperationId:</strong>postDailyDocket</p>
      operationId: postDailyDocket
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/dailyDocket'
        description: Add log book entries.
        required: true
  /hotels/{hotelId}/dailyDocket/{docketId}:
    delete:
      summary: 'Delete Daily Docket '
      description: Use this API to delete a Daily Docket. <p><strong>OperationId:</strong>deleteDailyDocket</p>
      operationId: deleteDailyDocket
      parameters:
      - name: docketId
        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:
      - FrontDeskOperations
  /hotels/{hotelId}/externalRoomKeys:
    post:
      summary: Requests room key(s)
      description: "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud PMS connected to external Door Lock Systems systems via Outbound Systems configuration: \n\n<strong>OPERA Cloud utilizes this operation </strong>\n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservation but valid for a defined time - (for show rooms, repair) - One Shot Key.\n\n- to request to re-encode a key whereby other keys for this room remain active.\n\n- to request to read a key data from a room key and display it to the user in the PMS.\n\n- to request to modify existing key data - upon room move or change of departure date. (online key systems only!!)\n\n- to request to remove / delete a room key from a room on. Usually sent with check out of a reservation.\n\nUse this API to post a room key action to the active Door Lock System.\n\n<strong>Notes on keyType values:</strong>\n\n<strong>keyType = New\n\nkeyType = Lost </strong>\n\nIt is expected that all previous active keys for the room will become invalid.\n\nIt is expected that partner system handles multiple keys being active in case numberOfKeys is >1.\n\n<strong>keyType = Duplicate\n\nkeyType = ReEncode</strong>\n\nIt is expected that existing active keys for this room remain active.\n\n<strong>keyType = OneShot</strong>\n\nIt is expected that the room key is only valid for a room for specific time (for maintenance or Show room).\n\nIt is never related to a reservation.\n\n<strong>keyType = Read</strong> A request to the Key Card system to read Key Card information from requested Key Encoder/reader.\n\nThe Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only for display to the user.\n\n<strong>keyType = Remove</strong>\n\nIt is expected that with this request all active keys for a room or reservation will become inactive or invalid so they will not be able to open the room after defined validityEnd time.\n\n<strong>Additional KeyType actions used by Online Door Lock Systems:</strong>\n\n<strong>Online Key card Systems</strong> are systems which do not write guest data to the room key directly but do store guest data internally and send the information to the related door lock.\n\n<strong>keyType = ModifyStay</strong>\n\nFor Online Door Lock Systems - Request to adjust Room key data when guest changes length of stay (validityEnd)\n\n<strong>keyType = RoomMove</strong>\n\nFor Online Door Lock Systems - adjust Room key data when guest performs room move. \n\n<p><strong>OperationId:</strong> postExternalRoomKeys</p>"
      operationId: postExternalRoomKeys
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel
        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})*'
          description: 'Response from the active Door Locking System Property Interface to the post request.<p><strong>Note on Response messages:</strong>


            It is necessary to specify both the PMS ''encoderTerminal'' and the Key Service system''s coder (encoderId) in cases where more than one PMS workstation may be addressing one key coder. ORACLE PMS will NOT send another Request command automatically should a negative response be received. The user sees the response and decides if another try should be made.<p>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomKeyExternalDetails'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomKeyExternal'
        description: Request for generation of room key.
        required: true
  /hotels/{hotelId}/floorPlans:
    get:
      summary: Get floor plans
      description: Use this API to get Floor Plans for a property. Floor Plans provide a graphical layout of floors, rooms, and other physical features such as stairways, HVAC closets, elevators, and more <p><strong>OperationId:</strong>getFloorPlans</p>
      operationId: getFloorPlans
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: room
        in: query
        required: false
        description: Room filter.
        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: List of suggested rooms for room assignment.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/floorPlans'
        '204':
          description: FloorPlans 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:
      - FrontDeskOperations
  /hotels/{hotelId}/fulfillmentActivityLogs:
    get:
      summary: Get the fullfillment activity log
      description: You can use this API to get the fullfillment activity log. <p><strong>OperationId:</strong>getFulfillmentActivityLog</p> <p>This API allows a time span of <strong>180</strong> days.</p>
      operationId: getFulfillmentActivityLog
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        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: module
        in: query
        required: false
        description: Activity module.
        schema:
          type: string
          enum:
          - Reservation
          - Contract
          - Allotment
          - Outlookview
          - Profile
          - Accountreceivables
          - GdsConvRateCodes
          - RateCode
          - Billing
          - Activity
          uniqueItems: true
      - name: parameterName
        in: query
        description: Name of the parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: parameterValue
        in: query
        description: Value of the parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: activityGroup
        in: query
        required: false
        schema:
          type: string
      - name: activityType
        in: query
        required: false
        schema:
          type: string
      - name: fromDate
        in: query
        required: false
        description: Search from date for the user activity log.
        schema:
          type: string
          format: date
      - name: toDate
        in: query
        required: false
        description: Search to date for the user activity log.
        schema:
          type: string
          format: date
      - name: searchText
        in: query
        required: false
        description: Search text for the user activity log.
        schema:
          type: string
      - name: userByIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
          maxItems: 4000
      - name: userForIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
          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: Fulfillment activity log response.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/activityLog'
        '204':
          description: FulfillmentActivityLog 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:
      - FrontDeskOperations
  /hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses:
    get:
      summary: Get room interface status
      description: This Api will getch the room interface status. <p><strong>OperationId:</strong>getRoomInterfaceStatus</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getRoomInterfaceStatus
      parameters:
      - name: interfaceId
        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: interfaceName
        in: query
        required: false
        description: Name of the Hotel Interface
        schema:
          type: string
      - name: interfaceType
        in: query
        required: false
        description: XML Posting Interface
        schema:
          type: string
          enum:
          - Bms
          - Cas
          - Ccw
          - Dls
          - Eft
          - Exp
          - Mak
          - Mbs
          - Msc
          - Pbx
          - Pos
          - Svs
          - Tik
          - Vid
          - Vms
          - Www
          - Xml
          uniqueItems: true
      - name: logo
        in: query
        required: false
        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.
        schema:
          type: string
      - name: machineName
        in: query
        required: false
        description: Unique machine name of the running IFC.
        schema:
          type: string
      - name: status
        in: query
        required: false
        description: Status of the Hotel Interface either STOPPED or RUNNING.
        schema:
          type: string
          enum:
          - Stopped
          - Running
          - Waiting
          - StopInitiated
          - StartInitiated
          - RebootInitiated
          - Other
          uniqueItems: true
      - name: activeFlag
        in: query
        required: false
        description: Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.
        schema:
          type: boolean
      - name: code
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: blockId
        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: blockIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: blockIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: roomId
        in: query
        required: false
        description: Wild card search value for Room number
        schema:
          type: string
      - name: lastName
        in: query
        required: false
        description: Wild card search value to lookup reservations with this last name
        schema:
          type: string
      - name: firstName
        in: query
        required: false
        description: Wild card search value to lookup reservations with this first name
        schema:
          type: string
      - name: reservationIds
        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: reservationIdsContext
        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: reservationIdsType
        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: arrivalEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: expectedArrivalEndTime
        in: query
        required: false
        description: The ending value of the time span.
        schema:
          type: string
          format: date-time
      - name: expectedArrivalStartTime
        in: query
        required: false
        description: The starting value of the time span.
        schema:
          type: string
          format: date-time
      - name: specialCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: floorCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomFeatureCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClassCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomStatus
        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: guaranteeCode
        in: query
        required: false
        description: Include reservations that have Guarantee Code(Reservation Type) only.
        schema:
          type: string
      - name: reservationStatus
        in: query
        description: Reservation status type for reservations search.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Cancelled
            - CheckedOut
            - CheckedIn
            - DueIn
            - DueOut
            - InHouse
            - NoShow
            - WaitList
          uniqueItems: true
      - name: includeLinkedReservations
        in: query
        required: false
        description: Include linked reservations.
        schema:
          type: boolean
      - name: includeBlocks
        in: query
        required: false
        description: Include reservations attached to a block.
        schema:
          type: boolean
      - name: orderBy
        in: query
        required: false
        description: A collection of supported sorting for Room Interface Status search results.
        schema:
          type: string
          enum:
          - RoomNo
          - Name
          - ArrivalDateETR
          - ArrivalDate
          uniqueItems: true
      - name: orderType
        in: query
        required: false
        schema:
          type: string
          enum:
          - Asc
          - Desc
          uniqueItems: true
      - name: expectedReturnEndTime
        in: query
        required: false
        description: The ending value of the time span.
        schema:
          type: string
          format: date-time
      - name: expectedReturnStartTime
        in: query
        required: false
        description: The starting value of the time span.
        schema:
          type: string
          format: date-time
      - name: advanceCheckedIn
        in: query
        required: false
        description: Shows whether reservation is in Advance CheckIn state.
        schema:
          type: boolean
      - name: guaranteeCodes
        in: query
        required: false
        description: Fetches the reservation having Guarantee Codes(Reservation Type) supplied here. Example guaranteeCodes=6PM
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            minLength: 0
            maxLength: 20
          maxItems: 100
      - $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 object for fetching room interface status
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomInterfaceStatus'
        '204':
          description: RoomInterfaceStatus 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:
      - FrontDeskOperations
    put:
      summary: Change room interface status
      description: You can use this API to change room interface status. <p><strong>OperationId:</strong>putRoomInterfaceStatus</p>
      operationId: putRoomInterfaceStatus
      parameters:
      - name: interfaceId
        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/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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/reservationInterface'
        description: Request to change the interface status for a reservation.
        required: true
  /hotels/{hotelId}/keyInterfaces:
    get:
      summary: Get key encoder interface configuration details
      description: You can use thie API to get key encoder interface configuration details. <p><strong>OperationId:</strong>getRoomKeyInterfaceDetails</p>
      operationId: getRoomKeyInterfaceDetails
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomNumbersCode
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: interfaceId
        in: query
        required: false
        description: Unique DB internal number of a Hotel Interface record.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: orderBy
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Sequence
      - name: sortOrder
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Asc
            - Desc
          default:
          - Asc
          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 with the configuration details of active room key interfaces including the available key encoders.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomKeyInterfaceDetails'
        '204':
          description: RoomKeyInterfaceDetails 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:
      - FrontDeskOperations
  /hotels/{hotelId}/queuedReservations:
    get:
      summary: Get the reservation in queue
      description: Fetch all current reservations that are Queued Reservations.  These reservations are guests that have arrived at the hotel, but their room isn't ready, so they're sitting in a queue.  <p><strong>OperationId:</strong>getReservationsInQueue</p>
      operationId: getReservationsInQueue
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomClassCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomTypeCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomNumberWildCard
        in: query
        required: false
        description: Wildcard search of reservations in queue by Room Number.
        schema:
          type: string
      - name: guestNameWildCard
        in: query
        required: false
        description: Wildcard search of reservations in queue by Guest Name.
        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 the operation to fetch Reservations in Queue
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reservationsInQueue'
        '204':
          description: ReservationsInQueue 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:
      - FrontDeskOperations
  /hotels/{hotelId}/queuedReservations/{reservationId}:
    put:
      summary: Add reservation to queue
      description: Using this API you can assign reservations to the reservation queue if the guest's room is not ready for assignment or if there are no available rooms of the room type attached to the reservation. Housekeeping staff can use the Queue Rooms functionality to determine if there are guests waiting to check in to a particular room or type of room; if there are, the queue list can provide guidance in determining which rooms need attention first. <p><strong>OperationId:</strong>addReservationToQueue</p>
      operationId: addReservationToQueue
      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 to the request to add a reservation to the Queue for Check-In.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reservationQueuePriority'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/queueReservation'
        description: Request to add a reservation to the Queue for Check-In. A reservation can be added to the queue prior to Check-In on the day of arrival.
        required: true
    delete:
      summary: Delete reservation from queue
      description: Use this API to remove a reservation that is already set as a Queued Reservation. <p><strong>OperationId:</strong>deleteReservationFromQueue</p>
      operationId: deleteReservationFromQueue
      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: 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservationSummaries:
    get:
      summary: Get reservation summaries
      description: Use this API to return reservation summaries for a specific hotel based on search criteria such as reservationId, blockId, rrivalStart, membershipNumber, roomId, etc.. <p><strong>OperationId:</strong>getReservationSummaries</p> <p>This API allows a time span of <strong>30</strong> days.</p>
      operationId: getReservationSummaries
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: searchType
        in: query
        required: false
        description: Represents Reservation search type Player Snapshot.
        schema:
          type: string
          enum:
          - Any
          - DayUse
          - Arrival
          - Arrived
          - Departure
          - WaitList
          - Cancellation
          - CheckedOut
          - NoShow
          - Complimentary
          - InHouse
          - PostStayPendingBalance
          - PreRegistered
          - PostToRoom
          - OpenFolio
          - ScheduledCheckOut
          - Queued
          - MobileCheckout
          - RegisteredAndInHouse
          - ResvBlockTraces
          - GuestMessages
          - MassCancellation
          - Operator
          - Turndown
          - WalkIn
          - AdvanceCheckedIn
          - OpenBalance
          - AutoFolioSettlement
          - Routing
          - PlayerSnapshot
          uniqueItems: true
      - name: reservationId
        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: reservationIdContext
        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: reservationIdType
        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: blockId
        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: blockIdContext
        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: blockIdType
        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: arrivalEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: departureEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: departureStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: stayOnEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: stayOnStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: createdOnEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: createOnStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: depositDateEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: depositDateStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: dateCriteriaExpectedArrivalEndTime
        in: query
        required: false
        description: The ending value of the time span.
        schema:
          type: string
          format: date-time
      - name: dateCriteriaExpectedArrivalStartTime
        in: query
        required: false
        description: The starting value of the time span.
        schema:
          type: string
          format: date-time
      - name: depositDueDateEnd
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: depositDueDateStart
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: expectedReturnEndTime
        in: query
        required: false
        description: The ending value of the time span.
        schema:
          type: string
          format: date-time
      - name: expectedReturnStartTime
        in: query
        required: false
        description: The starting value of the time span.
        schema:
          type: string
          format: date-time
      - name: membershipNumber
        in: query
        required: false
        description: Lookup reservations with this membership number.
        schema:
          type: string
      - name: anyVIPStatus
        in: query
        required: false
        description: VIP status of the customer.
        schema:
          type: boolean
      - name: vipStatusCodes
        in: query
        description: VIP status of the customer.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roomId
        in: query
        required: false
        description: Wildcard Search value to lookup reservation with this room number.
        schema:
          type: string
      - name: lastName
        in: query
        required: false
        description: Wildcard Search value to lookup reservations with this Last Name.
        schema:
          type: string
      - name: firstName
        in: query
        required: false
        description: Wildcard Search value to lookup reservations with this First Name.
        schema:
          type: string
      - name: blockCode
        in: query
        required: false
        description: Wildcard Search value to lookup reservation with this block code.
        schema:
          type: string
      - name: companyName
        in: query
        required: false
        description: Lookup reservations with this company name.
        schema:
          type: string
      - name: travelAgentName
        in: query
        required: false
        description: Lookup reservations with this travel agent name.
        schema:
          type: string
      - name: creditCardNumber
        in: query
        required: false
        description: Lookup reservations which has this credit card attached.
        schema:
          type: string
      - name: customReference
        in: query
        required: false
        description: Lookup reservations with this custom reference number.
        schema:
          type: string
      - name: externalReference
        in: query
        required: false
        description: Lookup reservations with this external reference id.
        schema:
          type: string
      - name: attributeName
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Room
            - Name
            - ArrivalTime
            - DepartureTime
            - ArrivalDate
            - DepartureDate
          uniqueItems: true
      - name: orderType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Asc
            - Desc
          uniqueItems: true
      - name: expectedArrivalEndTime
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: expectedArrivalStartTime
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: roomTypes
        in: query
        description: Room Type.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomStatuses
        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: paymentMethod
        in: query
        description: Payment Method to search the reservation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: indicator
        in: query
        description: Simple type that corresponds to reservation indicators.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Package
            - Message
            - Attachments
            - Share
            - Routing
            - Itinerary
            - Trace
            - ServiceRequests
            - Locator
            - Comment
            - AuthorizedBilling
            - StayRevenue
            - Preference
            - ProfileNote
            - NoPost
            - DepositCancellation
            - FixedCharge
            - RateChange
            - QmsTask
            - Activity
            - Queue
            - Member
            - CancelReason
            - Extension
            - OpenFolio
            - PreStay
            - PostStay
            - WakeUpCall
            - Alert
            - ExternalQms
            - Transport
            - TrackIt
            - Award
            - ItemInventory
            - Waitlist
            - HistoryFuture
            - Communication
            - PrepaidCards
            - WebRegistrationCards
          uniqueItems: true
      - name: fetchSummaryInstructions
        in: query
        description: Simple type for reservation summary instructions that can be used in requests to fetch summary.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - ReservationPaymentMethods
            - RoomDetails
            - BlockReservationDetails
          uniqueItems: true
      - name: allowedAction
        in: query
        description: Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Cancel
            - Move
            - PreCharge
            - PostCharge
            - FacilitySchedule
            - Upsell
            - PreCheckIn
            - PostToNoShowCancel
            - NoShow
            - NameChange
            - Discount
            - HouseKeeping
            - EnrollToPrimaryMembership
            - EnrollInProgress
          uniqueItems: true
      - name: keyword
        in: query
        required: false
        description: Wildcard search value to lookup reservation summaries with RoomId or First Name or Last Name. If both keyword and roomId/firstName/lastName is specified, keyword will take precedence.
        schema:
          type: string
      - name: fetchInstructions
        in: query
        description: Simple type for reservation instructions that can be used in requests to fetch necessary reservation summary details.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - ShortReservationSummaries
          uniqueItems: true
      - 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
      - $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 of fetch room keys operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/shortReservation'
        '204':
          description: ReservationSummaries 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/ai/rooms:
    post:
      summary: AI Assign Rooms
      description: This API runs AI Room Assignment and allocates rooms to incoming reservations. <p><strong>OperationId:</strong>assignRoomsAI</p>
      operationId: assignRoomsAI
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomsAI'
        description: Request to run AI Room Assignment and allocate rooms to incoming reservations.
        required: true
    get:
      summary: Automated Intelligence Room Assignment last run status
      description: This API fetches the last run status of an Automated Intelligence Room Assignment. <p><strong>OperationId:</strong>getAiraLastRunStatus</p>
      operationId: getAiraLastRunStatus
      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})*'
          description: Response of last execution for AI Room Assignment
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/airaLastRunStatusInfo'
        '204':
          description: Room Reservations 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/autoRoomAssignments:
    post:
      summary: Assign the room automatically
      description: This API can be used to assign the room automatically. <p><strong>OperationId:</strong>autoAssignRoom</p>
      operationId: autoAssignRoom
      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: Collection of result set which is made of reservation id, error and warning.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/autoAssignedRoom'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/autoAssignRoom'
        description: Request for auto assignment of rooms to reservations.
        required: true
    delete:
      summary: Auto unassign room
      description: This API can be used to auto unassign a room. <p><strong>OperationId:</strong>autoUnAssignRoom</p>
      operationId: autoUnAssignRoom
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: id
        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: idExtension
        in: query
        description: Additional identifying value assigned by the creating system.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: type
        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: includeDepartureRooms
        in: query
        required: false
        description: Indicates if departure rooms are to be included in the auto unassignment.
        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: roomNumberWildcard
        in: query
        required: false
        schema:
          type: string
      - name: useAIRoomAssignment
        in: query
        required: false
        description: If the AI ROOM ASSIGNMENT application parameter is set to Y, this flag when set to true will use the AI Room Assignment algorithm to fetch the results in order of suitability.
        schema:
          type: boolean
      - name: useAssociatedProfilePreferences
        in: query
        required: false
        description: Indicates if preferences on the profile associated to the reservation should be used to determine the room type. The preferences for FLOOR, SMOKING and ROOM FEATURES will be used.
        schema:
          type: boolean
      - name: hotelRoomStatus
        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: hotelFORoomStatus
        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: fromRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: toRoomNumber
        in: query
        required: false
        schema:
          type: string
      - 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: roomType
        in: query
        description: The room types of hotel rooms to be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClass
        in: query
        required: false
        description: The room class of hotel rooms to be fetched.
        schema:
          type: string
      - name: floor
        in: query
        required: false
        description: The floor of room to be fetched.
        schema:
          type: string
      - name: includeDueOut
        in: query
        required: false
        description: This flag when set to true when include rooms assigned to due out reservations.
        schema:
          type: boolean
      - name: departureTime
        in: query
        required: false
        description: When IncludeDueOut is enable,it is the departure time before which to search.
        schema:
          type: string
          format: date-time
      - name: code
        in: query
        description: A code representing a room feature.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: description
        in: query
        description: A code representing a room feature.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: orderSequence
        in: query
        description: Display Order sequence.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: quantity
        in: query
        description: Indicates quantity.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: smokingPreference
        in: query
        required: false
        description: The smoking preference of room to be fetched.
        schema:
          type: string
      - name: includeAllRoomConditions
        in: query
        required: false
        description: This flag when set to true will include all room conditions, when set to false then room with "General Assignment" condition type will be excluded from the result.
        schema:
          type: boolean
      - name: includeComponentRooms
        in: query
        required: false
        description: This flag when set to true will include all component rooms
        schema:
          type: boolean
      - name: includePseudoRooms
        in: query
        required: false
        description: This flag when set to true will include all pseudo rooms
        schema:
          type: boolean
      - name: includeOORoomCheck
        in: query
        required: false
        description: This flag when set to true will work for Available Rooms functionality
        schema:
          type: boolean
      - name: connectingRoomsOnly
        in: query
        required: false
        description: This flag when set to true will include only connecting rooms.
        schema:
          type: boolean
      - name: reservationIdId
        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: reservationIdIdExtension
        in: query
        required: false
        description: Additional identifying value assigned by the creating system.
        schema:
          type: integer
      - name: idContext
        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: pseudoRoomsOnly
        in: query
        required: false
        description: This flag when set to true will include only pseudo rooms
        schema:
          type: boolean
      - name: includeAttendentInRoom
        in: query
        required: false
        description: This flag when set to true will includes attendent in Rooms
        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})*'
            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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/massAdvanceCheckIns:
    post:
      summary: Mass Advance Check in Reservations
      description: Use this API to perform a mass advance checkin for reservations. <p><strong>OperationId:</strong>postMassAdvanceCheckIn</p>
      operationId: postMassAdvanceCheckIn
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/massAdvanceCheckInReservations'
        description: Request object to Submit Batch job for Mass Advance Check In of Reservations.
        required: true
  /hotels/{hotelId}/reservations/massCheckIns:
    post:
      summary: Mass checkin reservations
      description: Use this API to perform a mass Checkin for reservations. <p><strong>OperationId:</strong>postMassCheckIn</p>
      operationId: postMassCheckIn
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/massCheckInReservations'
        description: Request object to Submit Batch job for Mass Checkin of Reservations.
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns:
    post:
      summary: Advance checkin a reservation
      description: At times, when guests arrive to the property prior to a room being ready, you can flag a reservation as Advance Checked In for arrivals due in on the current business date. This enables guests to post charges to their reservation folio prior to check in, and helps the rooms management team prioritize room cleaning and assignment. Individual reservations (including Walk In reservations, Pre Registered reservations, and reservations that are in Queue) and group block reservations can be Advance Checked In. <p><strong>OperationId:</strong>postAdvanceCheckIn</p>
      operationId: postAdvanceCheckIn
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/advanceCheckInReservation'
        description: Request object to perform Advance Check In of a Reservation.
        required: true
    delete:
      summary: 'Reverse Advance Checkin '
      description: Reverse an advance check in for a reservation. <p><strong>OperationId:</strong>deleteAdvanceCheckIn</p>
      operationId: deleteAdvanceCheckIn
      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: 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/{reservationId}/checkIns:
    delete:
      summary: Revert a checked-in Reservation
      description: Use this API to revert a reservation that has been checked in.  This will return the reservation to a Due in/Arrival status. <p><strong>OperationId:</strong>deleteCheckin</p>
      operationId: deleteCheckin
      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: roomStatus
        in: query
        required: false
        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.
        schema:
          type: string
          enum:
          - Clean
          - Dirty
          - Pickup
          - Inspected
          - OutOfOrder
          - OutOfService
          uniqueItems: true
      - name: unassignRoom
        in: query
        required: false
        description: This option is used when all reservation check-in is reversed and the user wants to choose if the room is to be blocked. If all check-ins are not reversed, this is ignored and a default value false is used.
        schema:
          type: boolean
      - name: sharersList
        in: query
        description: List of sharers IDs linked to the reservation selected to be reverse check in.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 40
      - name: backToBackResvList
        in: query
        description: List of back to back reservation IDs linked to the reservation selected.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 40
      - $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:
      - FrontDeskOperations
    post:
      summary: Checks in a guest
      description: Use this API to check in a guest reservation.  The reservation needs to be 'due in' status.  The API also provides an option to select an available room. <p><strong>OperationId:</strong>postCheckIn</p>
      operationId: postCheckIn
      parameters:
      - name: reservationId
        in: path
        required: true
        description: Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel where reservation is being booked
        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: CheckIn response will commonly be errors over warnings. If a check has to be done before checking a reservation to a hotel, then the VerifyCheckinReservation operation can be utilized.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/checkedinReservation'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/reservation'
              - example:
                  reservation:
                    roomId: D209
                    ignoreWarnings: true
                    stopCheckin: false
                    printRegistration: true
                  fetchReservationInstruction:
                  - ReservationDetail
                  includeNotifications: true
        description: 'Validation checks includes the following: - Reservation is not valid to be checked in. - Split is still required before the reservation can be checked in. - Room information is missing. - Payment information is missing. - The status of the room needs to be reviewed. - Sharers was impacted. The check-in process affected the reservation details of shared guests on the reservation. - Sharers was not impacted. The check-in process has not affected the reservation details of shared guests on the reservation.'
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/keyOptions:
    get:
      summary: Fetch the keysOptions
      description: This API is used to retrieve the key options attached to the room, reservation and profile. These key options are preferences that correspond to the Door Lock System in use that control the access to areas with the room key. Key option preferences can be configured and saved on profiles, rooms, and reservations to be included when requesting a room key. <p><strong>OperationId:</strong>getKeyOptions</p>
      operationId: getKeyOptions
      parameters:
      - name: reservationId
        in: path
        required: true
        description: Unique identifier of the reservation
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Name of the resort.
        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})*'
          description: Response of fetch keyOptions operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/keyOptionsInfo'
        '204':
          description: keyOptions 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/{reservationId}/linked:
    get:
      summary: Get linked reservations
      description: Use this API to view the reservations  that are linked to the specified reservation. <p><strong>OperationId:</strong>getLinkedReservations</p>
      operationId: getLinkedReservations
      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: additionalReservationId
        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: additionalReservationIdContext
        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: additionalReservationIdType
        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
      - $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 of fetch room keys operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/linkedReservations'
        '204':
          description: LinkedReservations 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/{reservationId}/priority:
    put:
      summary: Change the reservation queue priority
      description: This API can be used to change the resrevations Queue Priority. <p><strong>OperationId:</strong>putReservationQueuePriority</p>
      operationId: putReservationQueuePriority
      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 for the Change Queue Priority request.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reservationQueuePriority'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/reservationQueuePriorityNumber'
        description: Request to change the current priority of a reservation in Queue for Check-In.
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/roomAssignments:
    post:
      summary: Assign a Room to a Reservation
      description: This API will allow you to assign a room to a reservation in reserved status. Override instructions are available to assign a room despite warnings returned in the response message. <p><strong>OperationId:</strong>postRoomAssignment</p>
      operationId: postRoomAssignment
      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: 'Possible errors that the operation will generate: The reservation is not in Reserved state. The room being requested does not exist.'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/assignedRoom'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/room'
        description: The reservation must still be reserved to use this operation.
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/roomKeys:
    get:
      summary: Fetch the room keys
      description: You can use this API to retrieve any existing room key information for a reservation. <p><strong>OperationId:</strong>getRoomKeys</p>
      operationId: getRoomKeys
      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: includeInactiveRoomKeys
        in: query
        required: false
        description: Setting this to true will include inactive rooms keys details. This is supported when OPERA Control Multiple Guest Room Key is active.
        schema:
          type: boolean
      - name: interfaceId
        in: query
        required: false
        description: Unique DB internal number of a Hotel Interface record.
        schema:
          type: string
          maxLength: 80
          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})*'
          description: Response of fetch room keys operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomKeyInfo'
        '204':
          description: RoomKeys 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:
      - FrontDeskOperations
    post:
      summary: Requests room key(s)
      description: You can use this API to create a room key request for a reservation to the active Door Locking System Property Interface. <p><strong>OperationId:</strong>postRoomKey</p>
      operationId: postRoomKey
      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: Response for room key creation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomKeyDetails'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomKey'
        description: Request for generation of room key.
        required: true
    delete:
      summary: Delete room key
      description: This API will delete room keys on a reservation. <p><strong>OperationId:</strong>deleteRoomKey</p>
      operationId: deleteRoomKey
      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: 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:
      - FrontDeskOperations
    put:
      summary: Update room keys.
      description: When MUTIPLE_GUEST_KEY is active this methods can be used to update information on the room keys such as balance amount and keyOptions. reservationId and hotelId are required path parameters. The body parameter roomKeys includes information about the encoder, room, key type, key validity, key options  and   guests information for multiple keys
      operationId: putRoomKeys
      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 updated resource
              schema:
                type: string
          description: <description>
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/updateRoomKeys'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/roomKeyMultipleGuests'
        description: Room key information
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/roomMoveHistory:
    get:
      summary: Get room move history of a reservation
      description: This API will return the history of room change/room moves for a specified reservation. <p><strong>OperationId:</strong>getRoomMoveHistory</p>
      operationId: getRoomMoveHistory
      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
      - $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 move history of a reservation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomMoveHistory'
        '204':
          description: RoomMoveHistory 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/{reservationId}/rooms:
    put:
      summary: Remove an assigned room
      description: This API will allow you to remove an assigned room from a reservation in reserved status. <p><strong>OperationId:</strong>deleteAssignRoom</p>
      operationId: deleteAssignRoom
      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/unAssignedRoom'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/unAssignRoomCriteria'
        description: Request to the remove a room(unassign) from a reserved reservation.
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/rooms/{roomId}/roomMoves:
    put:
      summary: Move in-house guest
      description: This API will allow you to change rooms for an in-house guest. <p><strong>OperationId:</strong>moveInHouseGuest</p>
      operationId: moveInHouseGuest
      parameters:
      - name: roomId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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: 'Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room''s occupancy level has been compromised. - The room''s pricing is NOT available.'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/movedInHouseGuest'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/moveInHouseGuest'
        description: To move a reservation, the reservation needs to be in Checked-In state.
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/suggestedRooms:
    get:
      summary: Get Suggested Rooms
      description: You can use this API to fetch the suggested rooms. <p><strong>OperationId:</strong>getSuggestedRooms</p>
      operationId: getSuggestedRooms
      parameters:
      - name: reservationId
        in: path
        required: true
        description: Unique reservation identifier for the reservation.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Property where the reservation exists.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: roomType
        in: query
        required: false
        description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
        schema:
          type: string
      - name: startDate
        in: query
        required: false
        description: Date of arrival.
        schema:
          type: string
          format: date
      - name: nights
        in: query
        required: false
        description: Number of nights that guest will be staying.
        schema:
          type: integer
      - name: suggestedRoomsInstructions
        in: query
        description: Instruction to include commponent room.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - ComponentRoom
          uniqueItems: true
      - name: roomFeatureCode
        in: query
        description: A code representing a room feature.
        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})*'
          description: List of suggested rooms for room assignment.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/suggestedRooms'
        '204':
          description: SuggestedRooms 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/{reservationId}/textMessages/{messageType}:
    put:
      summary: Deliver Queue rooms text message
      description: This API will deliver Queue rooms text message. <p><strong>OperationId:</strong>deliverQueueRoomsTextMessage</p>
      operationId: deliverQueueRoomsTextMessage
      parameters:
      - name: messageType
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - 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 for delivering a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/QueueRoomsTextMessage'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/deliverQueueRoomsTextMessage'
        description: Request to deliver a text message via Queue Reservations (for a guest) or Queue Rush (for housekeeping).
        required: true
  /hotels/{hotelId}/reservations/{reservationId}/verifyCheckIns:
    get:
      summary: Verify checkin reservation
      description: Use this API to verify checkin reservations. <p><strong>OperationId:</strong>verifyCheckinReservation</p>
      operationId: verifyCheckinReservation
      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: verifyCheckinInstructions
        in: query
        description: Instructions for including in the request when retrieving reservation information. Voucher - indicates to generate vouchers,if reservation matches voucher rule.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - AuthorizationInfo
            - ExcludeRoomSuggestion
            - Keys
            - Voucher
            - ScheduledRoomMoves
            - TotalCostOfStay
            - TotalDepositPaid
          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: Reservation record showing the current state of the reservation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/verifiedCheckinReservation'
        '204':
          description: verifyCheckinReservation 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:
      - FrontDeskOperations
  /hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls:
    get:
      summary: Get Wake Up Call
      description: Use thisAPI to get existing wake up call on an in-house reservation. <p><strong>OperationId:</strong>getWakeUpCall</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getWakeUpCall
      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: fetchCancelled
        in: query
        required: false
        description: Specifies whether we should fetch wake up calls with pending status.
        schema:
          type: boolean
      - name: fetchCompleted
        in: query
        required: false
        description: Specifies whether we should fetch wake up calls with pending status.
        schema:
          type: boolean
      - name: fetchNoAnswer
        in: query
        required: false
        description: Specifies whether we should fetch wake up calls with pending status.
        schema:
          type: boolean
      - name: fetchPending
        in: query
        required: false
        description: Specifies whether we should fetch wake up calls with pending status.
        schema:
          type: boolean
      - name: idExtension
        in: query
        required: false
        description: Additional identifying value assigned by the creating system.
        schema:
          type: integer
      - 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 wake up calls.
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        description: End date from which to start fetching wake up calls.
        schema:
          type: string
          format: date
      - name: beginTime
        in: query
        required: false
        description: Begin time from which to start fetching wake up calls.
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        required: false
        description: End time from which to start fetching wake up calls.
        schema:
          type: string
          format: date-time
      - name: room
        in: query
        description: Hotel room(s) for which wake up calls are to be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: blockId
        in: query
        required: false
        description: Block code for which wake up calls are to be fetched.
        schema:
          type: string
      - name: guestName
        in: query
        required: false
        description: Name with which wake up call may be associated.
        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: Fetch wake up calls response.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/wakeUpCalls'
        '204':
          description: WakeUpCall 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:
      - FrontDeskOperations
    put:
      summary: Change Wake Up Call
      description: Update an existing wake up call.  Wake up call can only be added to in-house reservations. <p><strong>OperationId:</strong>putWakeUpCall</p>
      operationId: putWakeUpCall
      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/changedWakeUpCalls'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/wakeUpCalls'
        description: Request to change a wake up call.
        required: true
    delete:
      summary: Delete Wake Up Call
      description: Use this API to cancel a wake up call on a reservation. <p><strong>OperationId:</strong>deleteWakeUpCall</p>
      operationId: deleteWakeUpCall
      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: callTime
        in: query
        description: Time on which wake up call is set.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date-time
      - name: followUpCallTime
        in: query
        description: Follow up call time.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date-time
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: newCallTime
        in: query
        description: New Time on which wake up call is set. Used to change the Followup Call time
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date-time
      - name: newFollowUpCallTime
        in: query
        description: New Follow up call time.Used to change the Followup Call time.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date-time
      - $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:
      - FrontDeskOperations
    post:
      summary: Create Wake Up Call
      description: You can set, view, and cancel wake up call for individual reservations. The reservation must be in-house (checked-in) status to set a wake up call. <p><strong>OperationId:</strong>postWakeUpCall</p>
      operationId: postWakeUpCall
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/wakeUpCalls'
        description: Request to create a wake up call.
        required: true
  /hotels/{hotelId}/reservationsKeyOptions:
    get:
      summary: Fetch keysOptions for the reservation and the guest profile
      description: This API is used to retrieve the key options attached to the room, reservation and profile for all the reservations in reservationIdList. These key options are preferences that correspond to the Door Lock System in use that control the access to areas with the room key. Key option preferences can be configured and saved on profiles, rooms, and reservations to be included when requesting a room key. <p><strong>OperationId:</strong>getKeyOptions</p>
      operationId: getReservationsKeyOptions
      parameters:
      - name: reservationIdList
        in: query
        description: A list of reservation ids to fetch key options for.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: hotelId
        in: path
        required: true
        description: Name of the resort.
        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
      - $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 of fetch keyOptions operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/keyOptionsInfoListType'
        '204':
          description: keyOptions 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:
      - FrontDeskOperations
  /hotels/{hotelId}/roomKeysDetails:
    get:
      summary: Read room key
      description: This API can be used to read the Room Key. <p><strong>OperationId:</strong>readRoomKey</p>
      operationId: readRoomKey
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: encoderTerminal
        in: query
        required: false
        schema:
          type: string
      - name: interfaceId
        in: query
        required: false
        description: Unique DB internal number of a Hotel Interface record.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: encoderId
        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: encoderIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: encoderIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        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: Respose for the reading of room key.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomKeyStatus'
        '204':
          description: readRoomKey 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:
      - FrontDeskOperations
  /hotels/{hotelId}/roomKeysExternal:
    post:
      summary: Requests room key(s)
      description: "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud PMS connected to external Door Lock Systems systems via Outbound Systems configuration: \n\n<strong>OPERA Cloud utilizes this operation </strong>\n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservation but valid for a defined time - (for show rooms, repair) - One Shot Key.\n\n- to request to re-encode a key whereby other keys for this room remain active.\n\n- to request to read a key data from a room key and display it to the user in the PMS.\n\n- to request to modify existing key data - upon room move or change of departure date. (online key systems only!!)\n\n- to request to remove / delete a room key from a room on. Usually sent with check out of a reservation.\n\nUse this API to post a room key action to the active Door Lock System.\n\n<strong>Notes on keyType values:</strong>\n\n<strong>keyType = New\n\nkeyType = Lost </strong>\n\nIt is expected that all previous active keys for the room will become invalid.\n\nIt is expected that partner system handles multiple keys being active in case numberOfKeys is >1.\n\n<strong>keyType = Duplicate\n\nkeyType = ReEncode</strong>\n\nIt is expected that existing active keys for this room remain active.\n\n<strong>keyType = OneShot</strong>\n\nIt is expected that the room key is only valid for a room for specific time (for maintenance or Show room).\n\nIt is never related to a reservation.\n\n<strong>keyType = Read</strong> A request to the Key Card system to read Key Card information from requested Key Encoder/reader.\n\nThe Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only for display to the user.\n\n<strong>keyType = Remove</strong>\n\nIt is expected that with this request all active keys for a room or reservation will become inactive or invalid so they will not be able to open the room after defined validityEnd time.\n\n<strong>Additional KeyType actions used by Online Door Lock Systems:</strong>\n\n<strong>Online Key card Systems</strong> are systems which do not write guest data to the room key directly but do store guest data internally and send the information to the related door lock.\n\n<strong>keyType = ModifyStay</strong>\n\nFor Online Door Lock Systems - Request to adjust Room key data when guest changes length of stay (validityEnd)\n\n<strong>keyType = RoomMove</strong>\n\nFor Online Door Lock Systems - adjust Room key data when guest performs room move. \n\n<p><strong>OperationId:</strong> postRoomKeysExternal</p>"
      operationId: postRoomKeysExternal
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel
        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})*'
          description: 'Response from the active Door Locking System Property Interface to the post request.<p><strong>Note on Response messages:</strong>


            It is necessary to specify both the PMS ''encoderTerminal'' and the Key Service system''s coder (encoderId) in cases where more than one PMS workstation may be addressing one key coder. ORACLE PMS will NOT send another Request command automatically should a negative response be received. The user sees the response and decides if another try should be made.<p>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/roomKeysExternalDetails'
        '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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/roomKeysExternal'
        description: Request for generation of room key.
        required: true
  /hotels/{hotelId}/rooms:
    get:
      summary: Get hotel rooms
      description: This API will allow you to search for available rooms based on various search criteria such as hotelId, hotelRoomStatus, roomType, roomFeatureCode, etc.. This is to find suitable rooms to assign them to a reservation in the next step. This is not to search for hotel availability in order to make a reservation. <p><strong>OperationId:</strong>getHotelRooms</p> <p>This API allows a time span of <strong>180</strong> days.</p>
      operationId: getHotelRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        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: roomNumberWildcard
        in: query
        required: false
        schema:
          type: string
      - name: hotelRoomStatus
        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: hotelFORoomStatus
        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. When sending Occupied, also send includeDueOut = true to return all Due Out rooms (occupied) along with the vacant rooms.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Vacant
            - Occupied
          uniqueItems: true
      - name: fromRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: toRoomNumber
        in: query
        required: false
        schema:
          type: string
      - name: hotelRoomStartDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: hotelRoomEndDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: duration
        in: query
        required: false
        schema:
          type: string
      - name: roomType
        in: query
        description: The room types of hotel rooms to be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomClass
        in: query
        required: false
        description: The room class of hotel rooms to be fetched.
        schema:
          type: string
      - name: floor
        in: query
        required: false
        description: The floor of room to be fetched.
        schema:
          type: string
      - name: includeDueOut
        in: query
        required: false
        description: This flag when set to true will include rooms assigned to due out reservations.
        schema:
          type: boolean
      - name: departureTime
        in: query
        required: false
        description: When IncludeDueOut is enable,it is the departure time before which to search.
        schema:
          type: string
          format: date-time
      - name: roomFeatureCode
        in: query
        description: A code representing a room feature.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: description
        in: query
        description: A code representing a room feature.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: orderSequence
        in: query
        description: Display Order sequence.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: quantity
        in: query
        description: Indicates quantity.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: smokingPreference
        in: query
        required: false
        description: The smoking preference of room to be fetched.
        schema:
          type: string
      - name: includeAllRoomConditions
        in: query
        required: false
        description: This flag when set to true will include all room conditions, when set to false then room with "General Assignment" condition type will be excluded from the result.
        schema:
          type: boolean
      - name: includeComponentRooms
        in: query
        required: false
        description: This flag when set to true will include all component rooms
        schema:
          type: boolean
      - name: includePseudoRooms
        in: query
        required: false
        description: This flag when set to true will include all pseudo rooms
        schema:
          type: boolean
      - name: includeOORoomCheck
        in: query
        required: false
        description: This flag when set to true will work for Available Rooms functionality
        schema:
          type: boolean
      - name: connectingRoomsOnly
        in: query
        required: false
        description: This flag when set to true will include only connecting rooms.
        schema:
          type: boolean
      - name: reservationId
        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: 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: pseudoRoomsOnly
        in: query
        required: false
        description: This flag when set to true will include only pseudo rooms
        schema:
          type: boolean
      - name: includeAttendentInRoom
        in: query
        required: false
        description: This flag when set to true will includes attendent in Rooms
        schema:
          type: boolean
      - name: includeRotationRoom
        in: query
        required: false
        description: This flag when set to true will return the rotation room when room roation parameter is active and the room type is configured for rotation.
        schema:
          type: boolean
      - name: ownerRoomsOnly
        in: query
        required: false
        description: When this flag is set to true, this API will fetch rooms which are contracted with owner profiles. This is supported when OPERA Control Room Rotation is active.
        schema:
          type: boolean
      - name: ownerExclusiveRoomsOnly
        in: query
        required: false
        description: When this flag is set to true, this API will fetch rooms can only be used by the reservation's profile (owner) of the room. This is supported when OPERA Control Room Rotation is active.
        schema:
          type: boolean
      - name: eligiblePseudoRoomsOnly
        in: query
        required: false
        description: 'If set to true, only pseudo rooms that meet ALL of the following conditions are included in the results:

          - Not configured in the OPERA Control Setting for POS Accounts.

          - Not checked out on the current business day (ensures a ''clean'' pseudo room).

          - Excludes rooms named ''Lost Postings Interface Room'' and ''Default Deposit Tax Room''.

          A pseudo room is a room record used for non-inventory or system purposes, such as posting masters or special billing scenarios. Apply this filter to ensure only fully eligible/assignable pseudo rooms are returned.'
        schema:
          type: boolean
      - name: perfectFitRoomsOnly
        in: query
        required: false
        description: When this flag is set to true, this API will fetch only those rooms that have exactly Y nights free with the reservation guest(s) points.
        schema:
          type: boolean
      - name: orderBy
        in: query
        description: A collection of supported sorting for available rooms search results.
        required: false
        schema:
          type: string
          enum:
          - ForecastRotationPoints
          - VacantDays
          - LastStayDate
          - NightsToNextStay
          - NextStayDate
          - RoomNumber
          - RoomType
          uniqueItems: true
      - name: sortOrder
        in: query
        required: false
        schema:
          type: string
          enum:
          - Asc
          - Desc
          uniqueItems: true
      - name: unitGradeCodes
        in: query
        required: false
        description: Fetches rooms that matches requested unit grade codes. Only returns when Room Rotation and Unit Grade are active.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ownerExclusiveRoomProfileId
        in: query
        required: false
        description: ': This OPERA profile?s internal Id will be used with ownerExclusiveRoomOnly flag to return the room which own by this profile. This query parameter is supported when OPERA Control Room Rotation is active.'
        schema:
          type: string
      - name: excludeRoomFeatures
        in: query
        description: It indicates to exclude rooms with the selected Room Feature(s).It allows alphanumeric values(e.g.,TUB,BOLCONY,MV)
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            minLength: 0
            maxLength: 20
          maxItems: 4000
      - name: excludeFloorPreferences
        in: query
        description: It indicates to exclude rooms with the selected Floor(s) which are comma separated values.It allows alphanumeric values(e.g.,01,02,03,GROUND,five)
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            minLength: 0
            maxLength: 20
          maxItems: 4000
      - name: includeScheduledMoveOutRoom
        in: query
        required: false
        description: This flag when set to true will include rooms assigned to move out reservations. This query parameter is supported when OPERA Control Advanced Daily Details is active.
        schema:
          type: boolean
      - name: scheduledRoomMoveOutTime
        in: query
        required: false
        description: When IncludeMoveOut is enabled, it is the move out time before which to search. It will return rooms assigned to moving reservations that have a scheduled move out time before the entered time. This query parameter is supported when OPERA Control Advanced Daily Details is active
        schema:
          type: string
          format: date-time
      - name: exactMatchRoomNumber
        in: query
        required: false
        description: When this flag is set to true, this API will fetch the exact match of the room number entered in the Move Room screen, in case the move in room is marked as Do Not Move. Do Not Move functionality is available when the Do Not Move OPERA Control is active. Scheduled Room Move functionality is available when the Advance Daily Detail OPERA Control is active.
        schema:
          type: boolean
      - name: includeNextStayInfo
        in: query
        required: false
        description: When true, the response will include 'nightsToNextStay' and 'nextStayDate' for each room inside 'roomOccupancyInfo'.
        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: List of suggested rooms for room assignment.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/hotelRooms'
        '204':
          description: HotelRooms 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:
      - FrontDeskOperations
  /hotels/{hotelId}/rooms/onHold:
    post:
      summary: Place Rooms On Hold
      description: You can use this API to place Rooms On Hold. <p><strong>OperationId:</strong>placeRoomsOnHold</p>
      operationId: placeRoomsOnHold
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/holdRooms'
        description: Request to place rooms on hold.
        required: true
  /hotels/{hotelId}/rooms/onHold/release:
    post:
      summary: Release Rooms On Hold
      description: You can use this API to release Rooms On Hold. <p><strong>OperationId:</strong>releaseRoomsOnHold</p>
      operationId: releaseRoomsOnHold
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/holdRooms'
        description: Request to release rooms from being held.
        required: true
  /hotels/{hotelId}/serviceRequests:
    get:
      summary: Get Service Requests
      description: Use this API to retrieve any service requests that exist on a reservation. <p><strong>OperationId:</strong>getServiceRequests</p> <p>This API allows a time span of <strong>30</strong> days.</p>
      operationId: getServiceRequests
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: code
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: status
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Open
            - PendingFollowUp
            - Closed
            - DoNotDisturb
            - MakeUpRoom
          uniqueItems: true
      - name: priorityCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: departmentCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: reservationId
        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: 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: profileId
        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: profileIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: profileIdType
        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: The room number in which the service request was created.
        schema:
          type: string
      - name: creationEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: creationStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: closedEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: closedStartDate
        in: query
        required: false
        description: The starting 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 object for service requests.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/serviceRequestsInfo'
        '204':
          description: ServiceRequests 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:
      - FrontDeskOperations
    put:
      summary: Change Service Requests
      description: Use this API to modify any service requests that exist on a reservation. <p><strong>OperationId:</strong>putServiceRequests</p>
      operationId: putServiceRequests
      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/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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/serviceRequestsInfo'
        description: Change service requests.
        required: true
    post:
      summary: Create Service Requests
      description: Service Request functionality provides the ability to define, track and report Service Requests on a reservation.  They go through a preset flow including creating the request, completing it and then following up on the resolution with the guest. <p><strong>OperationId:</strong>postServiceRequests</p>
      operationId: postServiceRequests
      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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/serviceRequestsInfo'
        description: Add new service request.
        required: true
  /hotels/{hotelId}/serviceRequests/{serviceRequestId}:
    delete:
      summary: Delete Service Requests
      description: Use this API to delete any service requests that exist on a reservation. <p><strong>OperationId:</strong>deleteServiceRequests</p>
      operationId: deleteServiceRequests
      parameters:
      - name: serviceRequestId
        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:
      - FrontDeskOperations
  /hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/shiftRooms:
    put:
      summary: Operation for Shift Rooms between two reservations
      description: This API will allow you to quickly shift rooms for two reservations. <p><strong>OperationId:</strong>shiftRooms</p>
      operationId: shiftRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: sourceReservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: targetReservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: overrideBackToBackRoomSkip
        in: query
        required: false
        description: Specifies if the Swap/Shift action should continue regardless of the reservation having a Back to Back Linked Reservation assigned to the same room. Swap/Shift functionality is available when the Swap/Shift Rooms OPERA Control is active. Back to Back Reservation handling is available when the Back to Back Handling for Linked Reservations OPERA Control is active.
        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})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: 'Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room''s occupancy level has been compromised. - The room''s pricing is NOT available.'
          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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/shiftRooms'
        description: Request to Shift Rooms between two selected reservations (from the same property), that are for the same arrival date and room type.
        required: true
  /hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/swapRooms:
    put:
      summary: Operation for Swap/Shift Rooms between two reservations
      description: This API will allow you to quickly swap rooms for two reservations. <p><strong>OperationId:</strong>swapRooms</p>
      operationId: swapRooms
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: sourceReservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: targetReservationId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: overrideBackToBackRoomSkip
        in: query
        required: false
        description: Specifies if the Swap/Shift action should continue regardless of the reservation having a Back to Back Linked Reservation assigned to the same room. Swap/Shift functionality is available when the Swap/Shift Rooms OPERA Control is active. Back to Back Reservation handling is available when the Back to Back Handling for Linked Reservations OPERA Control is active.
        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})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: 'Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room''s occupancy level has been compromised. - The room''s pricing is NOT available.'
          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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/swapRooms'
        description: Request to Swap Rooms between two selected reservations (from the same property), that are for the same arrival date and room type.
        required: true
  /hotels/{hotelId}/textMessages/{messageType}:
    get:
      summary: Get Queue room text message
      description: You can use this API to get Queue room text message. <p><strong>OperationId:</strong>getQueueRoomsTextMessage</p>
      operationId: getQueueRoomsTextMessage
      parameters:
      - name: messageType
        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: reservationId
        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: 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: mobileNumber
        in: query
        required: false
        description: Mobile number that the text message will be delivered to.
        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 predefined text message, for Queue Reservations or Queue Rush.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/queuedRoomsTextMessage'
        '204':
          description: QueueRoomsTextMessage 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:
      - FrontDeskOperations
  /hotels/{hotelId}/wakeUpCalls:
    get:
      summary: Get Wake Up Calls
      description: Use thisAPI to get existing wake up calls on an in-house reservation. <p><strong>OperationId:</strong>getWakeUpCalls</p>
      operationId: getWakeUpCalls
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: ''
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: fetchCancelled
        in: query
        required: false
        description: Specifies whether we should fetch wake up calls with pending status.
        schema:
          type: boolean
      - name: fetchCompleted
        in: query
        required: false
        description: Specifies whether we should fetch wake up calls with pending status.
        schema:
          type: boolean
      - name: fetchNoAnswer
        in: query
        required: false
        description: Specifies whether we should fetch wake up calls with pending status.
        schema:
          type: boolean
      - name: fetchPending
        in: query
        required: false
        description: Specifies whether we should fetch wake up calls with pending status.
        schema:
          type: boolean
      - name: reservationId
        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: idExtension
        in: query
        required: false
        description: Additional identifying value assigned by the creating system.
        schema:
          type: integer
      - 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 wake up calls.
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        description: End date from which to start fetching wake up calls.
        schema:
          type: string
          format: date
      - name: beginTime
        in: query
        required: false
        description: Begin time from which to start fetching wake up calls.
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        required: false
        description: End time from which to start fetching wake up calls.
        schema:
          type: string
          format: date-time
      - name: room
        in: query
        description: Hotel room(s) for which wake up calls are to be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: blockId
        in: query
        required: false
        description: Block code for which wake up calls are to be fetched.
        schema:
          type: string
      - name: guestName
        in: query
        required: false
        description: Name with which wake up call may be associated.
        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: Fetch wake up calls response.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/wakeUpCalls'
        '204':
          description: WakeUpCalls 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:
      - FrontDeskOperations
  /hotels/{hotelId}/wakeUpCalls/searches:
    post:
      summary: Get Wake Up Calls
      description: Use thisAPI to get existing wake up calls on an in-house reservation. <p><strong>OperationId:</strong>searchWakeUpCalls</p>
      operationId: searchWakeUpCalls
      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})*'
          description: Fetch wake up calls response.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/wakeUpCalls'
        '204':
          description: WakeUpCalls 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:
      - FrontDeskOperations
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchWakeUpCallsRequest'
        description: searchWakeUpCalls Request
  /services/frontDeskOperations/status:
    get:
      summary: Ping Front Desk Service
      description: Ping front desk service <p><strong>OperationId:</strong>pingFrontDeskOperationsService</p>
      operationId: pingFrontDeskOperationsService
      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/operaVersion'
        '204':
          description: pingFrontDeskOperationsService 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:
      - FrontDeskOperations
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
    prepaidCardsType:
      type: array
      description: Holds fixed charge detail.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/prepaidCardType'
    cardReIssueType:
      type: string
      description: Request to re issue a new card.
      enum:
      - Pending
      - NotApplicable
      - Requested
    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 pseudo 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
        childAges:
          description: Defines Children's Ages. Number of children ages mentioned may mot match with children counts.
          $ref: '#/components/schemas/childAgesType'
    entityType:
      type: string
      description: Indicates the rule is based on Minutes associated with the charge.
      enum:
      - ThresholdCount
      - ThresholdQuantity
      - ThresholdMinutes
    reservationECertificatesType:
      type: array
      description: Collection of ECertificateType object.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationECertificateType'
    configPackageUsageDetailType:
      type: object
      description: A Config Package Usage Detail type.
      properties:
        source:
          description: Indicates if the source of the product is Rate header, Rate Detail or Reservation.
          $ref: '#/components/schemas/productSourceType'
        usedInReservations:
          description: Indicates if the package is used in, reserved or prospect reservations.
          type: boolean
        usedInRates:
          description: Indicates if the package is used in any rate code.
          type: boolean
        usedInHouseReservations:
          description: Indicates if any checked in reservations are using this product.
          type: boolean
    policyBasisTypeType:
      type: string
      description: Full Amount.
      enum:
      - FlatAmount
      - Percentage
      - Nights
      - NightPercentage
      - FullAmount
    salesInfoType:
      type: object
      description: Provides sales information about the profiles of type company, travel agent, source and contact.
      properties:
        scope:
          description: Defines the scope.
          type: string
          minLength: 0
          maxLength: 2000
        scopeCity:
          description: Defines the scope city.
          type: string
          minLength: 0
          maxLength: 2000
        accountType:
          description: Defines the account type.
          type: string
          minLength: 0
          maxLength: 20
        accountSource:
          description: Defines the account source.
          type: string
          minLength: 0
          maxLength: 2000
        industryCode:
          description: Defines the industry code.
          type: string
          minLength: 0
          maxLength: 2000
        businessSegments:
          description: Defines the Business segments.
          type: string
          minLength: 0
          maxLength: 2000
        priority:
          description: Defines the priority.
          type: string
          minLength: 0
          maxLength: 4000
        roomsPotential:
          description: Defines the rooms potential.
          type: string
          minLength: 0
          maxLength: 4000
        actionCode:
          description: Defines the action code.
          type: string
          minLength: 0
          maxLength: 4000
        competitionCode:
          description: Defines the competition code.
          type: string
          minLength: 0
          maxLength: 4000
        influence:
          description: Defines the influence for the contact profile.
          type: string
          minLength: 0
          maxLength: 2000
        preferredRoom:
          description: Defines the Preferred Room for profile.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel Code used to filter the sales information.
          type: string
          minLength: 0
          maxLength: 20
    folioStatusType:
      type: string
      description: 'The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.'
      enum:
      - Deposit
      - Void
      - Ok
      - Zero
      - Compress
      - Converted
      - Internal
    colorType:
      type: string
      description: Color configuration type. This color configuration provides a visual category of entities.
      enum:
      - Red
      - DarkRed
      - Green
      - DarkGreen
      - LightGreen
      - Orange
      - White
      - Yellow
      - DarkYellow
      - Purple
      - Brown
      - Gray
      - Aqua
      - Chocolate
      - Blue
      - LightBlue
      - DarkBlue
      - Cyan
      - DarkCyan
      - Magenta
      - DarkMagenta
      - Black
      - Deepteal
      - Sunsetorange
      - Aquasky
      - Mochabrown
      - Mossgreen
      - Rosewood
      - Claybrown
      - Softlavender
      - Olivegold
      - Plumpurple
      - Mistblue
      - Forestgreen
      - Dustyviolet
      - Oceanblue
      - Copper
    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
    dailyRatesType:
      type: array
      description: Defines room rate information on a daily basis.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/dailyRateType'
    reservationsSummaryType:
      type: object
      description: Type which shows all fetched reservations summary depends on Fetch Summary Instruction.
      properties:
        roomSummary:
          description: Room Summary of the reservations.
          $ref: '#/components/schemas/roomSummaryType'
        paymentMethodSummary:
          description: Payment methods summary of the reservations.
          $ref: '#/components/schemas/paymentMethodsSummaryType'
        blockSummary:
          description: Holds reservation information related to block(s) searched.
          $ref: '#/components/schemas/blockResvSummaryType'
    profileSubscriptionListType:
      type: array
      description: Details of the OPERA Profile subscription to external system
      maxItems: 4000
      items:
        $ref: '#/components/schemas/profileSubscriptionType'
    pkgInventoryItemType:
      type: object
      properties:
        articleNumber:
          description: Article Number of the inventory item.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the inventory item.
          type: string
          minLength: 0
          maxLength: 200
        quantity:
          description: Quantity of the inventory item allocated to the package.
          type: integer
        itemId:
          description: Identifier for the inventory item.
          type: integer
    negotiatedType:
      type: object
      description: This holds a list of NegotiatedInfoType.
      properties:
        negotiatedInfoList:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/negotiatedInfoType'
        hotelId:
          description: Hotel code for the negotiated rate.
          type: string
          minLength: 0
          maxLength: 20
        rateCode:
          description: Rate plan code for the negotiated rate.
          type: string
          minLength: 0
          maxLength: 20
    roomsAI:
      type: object
      description: Request to run AI Room Assignment and allocate rooms to incoming reservations.
      properties:
        hotelCodes:
          description: List of resorts for which the room assignment algorithm needs to run.
          $ref: '#/components/schemas/codeListType'
        warnings:
          $ref: '#/components/schemas/warningsType'
    massAdvanceCheckInReservations:
      type: object
      description: Request object to Submit Batch job for Mass Advance Check In of Reservations.
      properties:
        criteria:
          description: Criteria for Submiting a request for Mass Advance Check In of Reservations.
          $ref: '#/components/schemas/massAdvanceCheckInCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    wakeUpCalls:
      type: object
      description: Fetch wake up calls response.
      properties:
        calls:
          description: List of the wake up calls.
          $ref: '#/components/schemas/wakeUpCallsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    characterUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Character/String Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/characterUDFType'
    alertType:
      type: object
      properties:
        code:
          description: Code identifying the type of alert.
          type: string
          minLength: 0
          maxLength: 20
        global:
          description: Indicate whether the alert is a global that is automatically and dynamically attached to all reservations that meet the alert criteria.
          type: boolean
        area:
          description: The Area where the alert will be attached and shown.
          $ref: '#/components/schemas/alertAreaType'
        description:
          description: The alert message.
          type: string
        screenNotification:
          description: Notify by showing the alert on the screen
          type: boolean
        printerNotification:
          description: Notify by sending the message to the printer.
          type: boolean
        printerName:
          description: Printer used to print the alert notification.
          type: string
        reportId:
          description: The module id of the report. This is used to printer the alert.
          $ref: '#/components/schemas/uniqueID_Type'
        reportName:
          description: Report name of the report type.
          type: string
        reportDescription:
          description: Report description. Mainly used for as a parameter for printing the alerts.
          type: string
          minLength: 0
          maxLength: 1000
        guestInfo:
          description: Contains information regarding the guest.
          $ref: '#/components/schemas/alertGuestInfoType'
        userDefinedFields:
          description: Collections of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
        welcomeOffer:
          description: Contains information regarding welcome offer.
          $ref: '#/components/schemas/welcomeOfferType'
        stopCheckInCheckOut:
          description: Indicates the Reservation Stop Check In/Check Out Global Alert.
          type: boolean
        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
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    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
    assignedRoom:
      type: object
      description: 'Possible errors that the operation will generate: The reservation is not in Reserved state. The room being requested does not exist.'
      properties:
        oldRates:
          description: Collection of old room rate information on a daily basis.
          $ref: '#/components/schemas/dailyRatesType'
        newRates:
          description: Collection of new room rate information on a daily basis.
          $ref: '#/components/schemas/dailyRatesType'
        effectiveRates:
          description: Collection of effective rates per stay dates per guest to be applied on reservation including its shares.
          $ref: '#/components/schemas/effectiveRatesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    roomKeyGuest:
      type: object
      description: Information about the guest for whom a key can be created.
      properties:
        firstName:
          description: First Name of the guest.
          type: string
          minLength: 0
          maxLength: 80
        lastName:
          description: Last Name of the guest.
          type: string
          minLength: 0
          maxLength: 80
        isAdult:
          description: Flag to indicate wheter the guest is an Adult or a child.
          type: boolean
        originalBalance:
          description: Original Balance on the Key card.
          type: number
        remainingBalance:
          description: Remaining Balance on the Key card.
          type: number
        keyNumber:
          description: Key Number of the card.
          type: number
        guestNameId:
          description: Guest unique identifier to which the instruction will be routed.
          $ref: '#/components/schemas/uniqueID_Type'
        isInactive:
          description: Flag to indicate wheter the guest is an Adult or a child.
          type: boolean
        guestKeyOptions:
          type: string
          minLength: 0
          maxLength: 4000
    fixedChargesType:
      type: array
      description: Holds fixed charge detail.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/fixedChargeType'
    imageStyleType:
      type: string
      description: An enumeration of image styles.
      enum:
      - Full
      - Thumbnail
      - Icon
      - Square
      - Banner
      - Button
      - Lowres
      - Highres
    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
    keyTrackType:
      type: object
      properties:
        keyTrack1:
          type: string
          minLength: 0
          maxLength: 200
        keyTrack2:
          type: string
          minLength: 0
          maxLength: 200
        keyTrack3:
          type: string
          minLength: 0
          maxLength: 200
        keyTrack4:
          type: string
          minLength: 0
          maxLength: 200
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    roomKeysExternalDetails:
      type: object
      description: Response for the key request made to DLS from OPERA Cloud.
      properties:
        encoderId:
          type: string
          description: Unique Id as defined by Door Lock System.
          maxLength: 2000
        encoderTerminal:
          type: string
          description: The Unique PMS encoder name linked with the encoderId
          minLength: 1
          maxLength: 2000
        reservationIdList:
          description: Collection of unique reservation identifiers for the reservation we are trying to make a room key for.
          $ref: '#/components/schemas/uniqueIDListType'
        roomId:
          description: The PMS room number to generate a key for.
          type: string
          maxLength: 2000
        keyTrack:
          description: KeyTrack Data.
          type: array
          items:
            $ref: '#/components/schemas/keyTrackType'
        keyValidityStart:
          type: string
          description: 'Date/Time Key is valid from - only send in response for keyType: ''Read'' request. Uses the hotel''s time zone.'
          format: date-time
        keyValidityEnd:
          type: string
          description: 'Date/Time Key is valid to - only send in response for keyType: ''Read'' request. Uses the hotel''s time zone.'
          format: date-time
        noOfKeys:
          type: integer
          description: Number of keys to be created.The value is always 1
        responseText:
          type: string
          description: A user-friendly text with information on why a request is not successful
          maxLength: 2000
        responseCode:
          $ref: '#/components/schemas/roomKeyResponseCodeType'
        additionalRooms:
          description: Collection of additional rooms to be included in key creation of reservation room.
          type: array
          maxItems: 999
          items:
            type: string
            minLength: 0
            maxLength: 20
        keyOptions:
          description: Lists all PMS access areas.
          type: array
          maxItems: 1000
          items:
            $ref: '#/components/schemas/keyOptionsResponseType'
        userId:
          type: string
          description: Unique identifier for the PMS user.
          maxLength: 2000
        digitalKeyData:
          description: 'Base64 format of Mobile Key data provided by DLS System which the external system requested - only send in response for roomKeyType: ''MobileKey'''
          type: string
          format: byte
        keyImage:
          description: 'Image of the created key - only send in response for roomKeyType: ''KeyPayload'''
          type: string
          format: byte
        cardSerialNumber:
          description: 'Unique identifier of RFID card used for KeyPayload generation - only send in response for roomKeyType: ''KeyPayload''.'
          type: string
          maxLength: 80
        keyCreationTime:
          type: string
          description: Date/Time the key has been generated by Door Locking system. Uses the hotel's time zone.
          format: date-time
        roomKeyType:
          $ref: '#/components/schemas/externalRoomKeyType'
        keyUserType:
          $ref: '#/components/schemas/keyUserType'
        keyPin:
          description: PIN provided in keyTrack3 from the Door Lock System that is used to unlock a room. This is supported when Key Pin handling is active for the property and the Door Lock System in use.
          type: string
          minLength: 0
          maxLength: 20
      required:
      - roomId
      - responseCode
      - encoderTerminal
      - roomKeyType
      - keyUserType
      - keyValidityStart
      - keyValidityEnd
      - keyCreationTime
    roomKeyMultipleGuests:
      type: object
      description: Short room key information containing  information about the multiple guests and room key options .
      properties:
        reservationIdList:
          description: Collection of unique reservation identifiers for the reservation we are trying to make a room key for.
          $ref: '#/components/schemas/uniqueIDListType'
        roomNumber:
          description: A room number to generate a key for. When creating keys using just the room number, the interface may allow only one-shot keys.
          type: string
          maxLength: 2000
        keyOptions:
          type: string
          maxLength: 2000
        roomKeyGuests:
          type: array
          description: Collection of of Room key guests for multiple guest room key functionality.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomKeyGuest'
    transactionDiversionDailyDetailType:
      type: object
      description: List of daily details for Transaction Diversion rule.
      properties:
        posted:
          description: Transaction diversion rules that are posted.
          type: integer
        diverted:
          description: Transaction diversion rules that are diverted .
          type: integer
        date:
          description: Daily details Date about when the rules are posted or diverted.
          type: string
          format: date
          maxLength: 8
    cardNumberTypeType:
      type: string
      description: Simple type for indicating if credit card number is tokenized.
      enum:
      - CardNumber
      - Token
    eCertificateInfoType:
      type: object
      description: E-Certificates details.
      properties:
        certificateType:
          description: User defined certificate code.
          type: string
          minLength: 0
          maxLength: 20
        membershipType:
          description: Membership type to which the certificate is linked to.
          type: string
          minLength: 0
          maxLength: 20
        awardCode:
          description: Award type to which the certificate is linked to.
          type: string
          minLength: 0
          maxLength: 20
        promotionCode:
          description: Promotion code to which certificate is attached to.
          type: string
          minLength: 0
          maxLength: 20
        voucherBenefitCode:
          description: Voucher benefit code attached to the certificate.
          type: string
          minLength: 0
          maxLength: 40
        hotels:
          description: Hotel to which certificate is attached to.
          type: object
          properties:
            code:
              type: array
              maxItems: 4000
              items:
                type: string
                minLength: 0
                maxLength: 20
            scope:
              description: 'Scope of e-cert: global,single property or multi property.'
              $ref: '#/components/schemas/eCertificateScopeType'
        description:
          description: Description about the certificate.
          type: string
          minLength: 0
          maxLength: 200
        longDescription:
          description: Detail description about the certificate.
          type: string
          minLength: 0
          maxLength: 4000
        label:
          description: Label for the certificate.
          type: string
          minLength: 0
          maxLength: 40
        maxExtensionAllowed:
          description: Number of times e-certificate can be extended.
          type: integer
        usageCriteria:
          $ref: '#/components/schemas/eCertificateUsageCriteriaType'
        value:
          description: Value of the certificate for the guest.
          $ref: '#/components/schemas/currencyAmountType'
        cost:
          description: Cost of certificate.
          $ref: '#/components/schemas/currencyAmountType'
        benefitSummary:
          description: Summary of Benefits attached to this ECertificate.
          type: string
          minLength: 0
          maxLength: 4000
    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
    customerType:
      type: object
      description: Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
      properties:
        personName:
          description: Detailed name information for the customer.
          type: array
          maxItems: 5
          items:
            $ref: '#/components/schemas/personNameType'
        anonymization:
          description: Provides information about the guest's anonymization status
          $ref: '#/components/schemas/anonymizationType'
        citizenCountry:
          description: Name of the (self-professed) country that is claimed for citizenship.
          $ref: '#/components/schemas/countryNameType'
        identifications:
          description: List of identification of the customer.
          type: object
          properties:
            identificationInfo:
              description: Collection of detailed information on the identification of the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/identificationInfoType'
            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
        profession:
          description: Profession of a person.
          type: string
          minLength: 0
          maxLength: 80
        alienInfo:
          description: Immigration/visa information of a foreign person.
          $ref: '#/components/schemas/alienInfoType'
        birthCountry:
          description: Country of birth.
          $ref: '#/components/schemas/countryNameType'
        legalCompany:
          description: Name Of the company the individual is associated with.
          type: string
          minLength: 0
          maxLength: 80
        companyInfo:
          description: Company Information of the Profile.
          $ref: '#/components/schemas/companyInfoType'
        businessTitle:
          description: Business Title.
          type: string
          minLength: 0
          maxLength: 80
        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
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        nationality:
          description: Nationality code identification
          type: string
          minLength: 0
          maxLength: 20
        nationalityDescription:
          description: Nationality code description
          type: string
          minLength: 0
          maxLength: 80
        customerValue:
          description: The supplier's ranking of the customer (e.g., VIP, numerical ranking).
          type: string
          minLength: 0
          maxLength: 20
        creditRating:
          description: Credit Rating of the customer.
          type: string
          minLength: 0
          maxLength: 20
        vipStatus:
          description: VIP status of the customer.
          type: string
          minLength: 0
          maxLength: 20
        vipDescription:
          description: Description of the VIP status.
          type: string
          minLength: 0
          maxLength: 2000
        birthPlace:
          description: Place of birth.
          type: string
          minLength: 0
          maxLength: 80
        privateProfile:
          description: This element tells profile is property exclusive or not.
          type: boolean
        blacklist:
          description: This element tells if profile is blacklisted or not.
          type: boolean
    callType:
      type: object
      description: Holds call information.
      properties:
        dateTimeSpan:
          description: Call Time Span. Start Date and End Date is used for the Call duration.
          $ref: '#/components/schemas/dateTimeSpanType'
        caller:
          description: Holds caller information.
          $ref: '#/components/schemas/callerType'
        reservation:
          description: Holds Reservation Id and Hotel Code.
          type: object
          properties:
            reservationIdList:
              description: Holds Reservation related Ids.
              $ref: '#/components/schemas/reservationIdList'
            hotelId:
              description: Holds Hotel Code.
              type: string
              minLength: 0
              maxLength: 20
        turnawayCode:
          description: Call turn away code.
          type: string
          minLength: 0
          maxLength: 20
        comments:
          description: Call comments.
          type: string
          minLength: 0
          maxLength: 200
        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
    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
    dateTimeRangeType:
      type: object
      description: Date Range with Start and End dates.
      properties:
        start:
          description: The starting value of the time span. Uses the hotel's time zone.
          type: string
          format: date-time
        end:
          description: The ending value of the time span. Uses the hotel's time zone.
          type: string
          format: date-time
    excludedDateType:
      type: object
      description: Specifies all the enabled dates.
      properties:
        date:
          description: Contains exclusion date.
          type: string
          format: date
          maxLength: 8
        reason:
          description: Contains reason for exclusion.
          $ref: '#/components/schemas/exclusionReasonType'
    profileSubscriptionType:
      type: object
      description: Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular external system
      properties:
        profileId:
          description: OPERA Profile ID that this subscription record corresponds to.
          $ref: '#/components/schemas/profileId'
        externalProfileId:
          description: Profile ID within the external system.
          $ref: '#/components/schemas/uniqueID_Type'
        profileInfo:
          description: This provides name information for a person.
          type: object
          properties:
            name:
              description: Family name, last name or Company Name.
              type: string
              minLength: 0
              maxLength: 40
            fullName:
              description: Full display Name.
              type: string
              minLength: 0
              maxLength: 200
            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
            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
            nameType:
              description: Type of name of the individual, such as former, nickname, alternate or alias name.
              $ref: '#/components/schemas/personNameTypeType'
            profileType:
              description: OPERA profile type such as Individual or Company
              $ref: '#/components/schemas/profileTypeType'
        distributed:
          description: Indicates if the profile was distributed to the external system.
          type: boolean
        force:
          description: Indicates if the profile information should be overwritten by the external system.
          type: boolean
        subscriptionDate:
          description: Timestamp when the profile was subscribed to.
          type: string
          format: date-time
        lastDistributionDate:
          description: Timestamp of the most recent distribution of this profile to the external system.
          type: string
          format: date-time
        lastExternalUpdateDate:
          description: Timestamp of the most recent update of the subscription information by the external system.
          type: string
          format: date-time
        inactive:
          description: Indicates whether this subscription is active or inactive.
          type: boolean
        systemCode:
          description: Code of system where profile is subscribed to.
          type: string
          minLength: 0
          maxLength: 40
        systemType:
          description: Type of system where profile is subscribed to.
          type: string
          minLength: 0
          maxLength: 40
    profileDeliveryModuleType:
      type: string
      description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..'
      enum:
      - EfolioExport
    discountType:
      type: object
      description: Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.
      properties:
        discountReason:
          type: string
          minLength: 0
          maxLength: 2000
        percent:
          description: Percentage discount.
          type: number
        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
        discountCode:
          description: Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).
          type: string
          minLength: 0
          maxLength: 20
    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
    reservationPaymentMethodsType:
      type: array
      description: Defines reservation payment methods.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationPaymentMethodType'
    cardProcessingType:
      type: string
      enum:
      - Eft
      - Manual
    reservationHistoryFutureInfoType:
      type: object
      description: Information of History and Future Reservation details attached to Profiles.
      properties:
        historyList:
          description: Refer to History list type document.
          $ref: '#/components/schemas/historyListType'
        futureList:
          description: Refer to Future list type document.
          $ref: '#/components/schemas/futureListType'
    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
    changeInterfaceStatusType:
      type: object
      description: This will contain reservation id and corresponding interface information for which the interface status needs to be updated.
      properties:
        reservationId:
          description: Unique identifier of the reservation.
          $ref: '#/components/schemas/reservationId'
        roomExtension:
          description: Unique identifier for the room extension
          type: string
          minLength: 0
          maxLength: 20
        interfaceRights:
          description: Contains a list of status/rights for the various services under this interface
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/interfaceRightsStatusType'
    QueueRoomsTextMessage:
      type: object
      description: Response for delivering a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).
      properties:
        guestTextInfo:
          description: Information regarding the message sent to guest.
          $ref: '#/components/schemas/queueTextInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    packageConsumptionType:
      type: object
      description: Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
      properties:
        defaultQuantity:
          description: The default quantity attached in the package.
          type: integer
        excludedQuantity:
          description: The quantity which has been excluded in the package.
          type: integer
        totalQuantity:
          description: The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType.
          type: integer
        allowanceConsumed:
          description: Indicates if Allowance(for POS packages) has been consumed/posted for today.
          type: boolean
    errorType:
      type: object
      description: Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.
      properties:
        value:
          type: string
          description: Property Value
        shortText:
          description: An abbreviated version of the error in textual format.
          type: string
        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
        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
        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
        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
        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})*'
        nodeList:
          description: An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.
          type: string
    prepaidCardType:
      type: object
      description: Holds fixed charge information.
      properties:
        hotelId:
          description: Hotel context for the Reservations.
          type: string
          minLength: 0
          maxLength: 20
        reservationId:
          description: The unique ID of the reservation to which this record applies.
          $ref: '#/components/schemas/reservationId'
        name:
          description: Family name, last name or Company Name.
          type: string
          minLength: 0
          maxLength: 80
        firstName:
          description: Given name, first name or names.
          type: string
          minLength: 0
          maxLength: 80
        profileId:
          description: Card / Account holder name ID
          $ref: '#/components/schemas/profileId'
        cardNo:
          description: Prepaid card / account number.
          type: string
          minLength: 0
          maxLength: 80
        cardNumberMasked:
          description: Masked Prepaid card / account number.
          type: string
          minLength: 0
          maxLength: 80
        amount:
          description: Prepaid Card Amount.
          $ref: '#/components/schemas/currencyAmountType'
        pinCode:
          description: Prepaid card pin code.
          type: string
          minLength: 0
          maxLength: 10
        interfaceId:
          description: The unique ID for the Interface.
          $ref: '#/components/schemas/uniqueID_Type'
        cardDetails:
          description: Prepaid Card details from vendor.
          $ref: '#/components/schemas/prepaidCardDetailsType'
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
        giftCard:
          description: Indicates a gift card type.
          type: boolean
    blockId:
      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
    searchWakeUpCallsRequest:
      type: object
      properties:
        fetchCancelled:
          type: boolean
          description: Specifies whether we should fetch wake up calls with pending status.
        fetchCompleted:
          type: boolean
          description: Specifies whether we should fetch wake up calls with pending status.
        fetchNoAnswer:
          type: boolean
          description: Specifies whether we should fetch wake up calls with pending status.
        fetchPending:
          type: boolean
          description: Specifies whether we should fetch wake up calls with pending status.
        reservationId:
          type: string
          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.
        idExtension:
          type: integer
          description: Additional identifying value assigned by the creating system.
        reservationIdContext:
          type: string
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        reservationIdType:
          type: string
          description: A reference to the type of object defined by the UniqueID element.
        beginDate:
          type: string
          format: date
          description: Begin date from which to start fetching wake up calls.
        endDate:
          type: string
          format: date
          description: End date from which to start fetching wake up calls.
        beginTime:
          type: string
          format: date-time
          description: Begin time from which to start fetching wake up calls.
        endTime:
          type: string
          format: date-time
          description: End time from which to start fetching wake up calls.
        room:
          type: array
          maxItems: 4000
          items:
            type: string
          description: Hotel room(s) for which wake up calls are to be fetched.
        blockId:
          type: string
          description: Block code for which wake up calls are to be fetched.
        guestName:
          type: string
          description: Name with which wake up call may be associated.
    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
    resAccompanyGuestListType:
      type: array
      description: Collection of accompany guests
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resAccompanyGuestInfoType'
    resSharedGuestListType:
      type: array
      description: Collection of shared guest reservations.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resSharedGuestInfoType'
    shareDistributionInstructionType:
      type: string
      description: The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -> Full Rate for each Sharer. SPLIT-> Split the Rate amount between Sharer Reservations. ENTIRE -> This Sharer will get the total amount of the rate code for all the Sharer Reservations.
      enum:
      - Full
      - Entire
      - Split
      - CustomSplit
    benefitsType:
      type: array
      description: Basic information about membership benefit.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/benefitType'
    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'
    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
    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
    reservationPoliciesType:
      type: object
      description: A collection of reservation deposit and cancellation policies.
      properties:
        cancellationPolicies:
          description: A collection of reservation cancellation policies..
          $ref: '#/components/schemas/resCancellationPoliciesType'
        depositPolicies:
          description: A collection of reservation deposit policies.
          $ref: '#/components/schemas/resDepositPoliciesType'
        reservationIdList:
          description: A list of Ids for reservation.
          $ref: '#/components/schemas/uniqueIDListType'
        name:
          description: Name identifier for the reservation.
          type: string
    downgradeType:
      type: string
      description: Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
      enum:
      - Grace
      - Never
      - Period
    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
    productSourceType:
      type: string
      description: Sources of Products
      enum:
      - Reservation
      - RateHeader
      - RateDetail
    roomSectionType:
      type: object
      properties:
        daySectionCode:
          type: string
          minLength: 0
          maxLength: 20
        eveningSectionCode:
          type: string
          minLength: 0
          maxLength: 20
    reservationQueuePriority:
      type: object
      description: Response to the request to add a reservation to the Queue for Check-In.
      properties:
        queueInfo:
          description: Queue Information for this reservation.
          $ref: '#/components/schemas/reservationQueueInformationType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    resAwardsType:
      type: object
      description: Membership Awards code applied on the reservation.
      properties:
        membershipNo:
          description: Membership program under which the award is applied.
          $ref: '#/components/schemas/uniqueID_Type'
        awardVouchers:
          $ref: '#/components/schemas/awardVouchersType'
        originalRoomType:
          description: Room Type before the Upgrade Award.
          type: string
          minLength: 0
          maxLength: 20
        upgradeRoomType:
          description: Room Type after the Upgrade Award.
          type: string
          minLength: 0
          maxLength: 20
    roomKeysExternal:
      type: object
      description: Request for generation of room key used for OutBound.
      properties:
        encoderId:
          type: string
          description: Unique Id as defined by Door Lock System.
          minLength: 1
          maxLength: 2000
        encoderTerminal:
          type: string
          description: The Unique PMS encoder name linked with the encoderId
          minLength: 1
          maxLength: 2000
        roomId:
          description: The PMS room number to generate a key for.
          type: string
          maxLength: 2000
        oldRoomId:
          description: Old Room Number is used when a room move (keyType RoomMove) is performed.
          type: string
          maxLength: 2000
        noOfKeys:
          type: integer
          description: Number of keys to be created.
          minimum: 1
          maximum: 1
        reservationIdList:
          description: Collection of unique reservation identifiers for the reservation we are trying to make a room key for.
          $ref: '#/components/schemas/uniqueIDListType'
        guestShareFlag:
          type: boolean
          description: Indicates if Guest is a sharer or not
        OldGuestShareFlag:
          type: boolean
          description: Indicates if old Guest room is a sharer or not when a room move (keyType RoomMove) is performed.
        keyValidityStart:
          type: string
          description: The date/time the room key is valid from.
          format: date-time
        keyValidityEnd:
          type: string
          description: The date/time the room key is valid to.
          format: date-time
        keyType:
          $ref: '#/components/schemas/roomKeyOutBoundType'
        keyTrack:
          description: KeyTrack Data.
          $ref: '#/components/schemas/keyTrackType'
        outBoundCode:
          description: OutBound Code of the Door Lock System (DLS).
          type: string
        additionalRooms:
          description: Collection of additional rooms to be included in key creation of reservation room.
          type: array
          maxItems: 999
          items:
            type: string
            minLength: 0
            maxLength: 20
        oldAdditionalRooms:
          description: Collection of old additional rooms in key creation of reservation room when a room move (keyType RoomMove) is performed.
          type: array
          maxItems: 999
          items:
            type: string
            minLength: 0
            maxLength: 20
        userId:
          type: string
          description: Unique identifier for the PMS user.
          maxLength: 2000
        roomKeyGuests:
          type: array
          description: Collection of of Room key guests for multiple guest room key functionality.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomKeyGuest'
        keyOptions:
          description: Lists the access areas defined in PMS valid for the room key.
          type: array
          maxItems: 1000
          items:
            $ref: '#/components/schemas/keyOptionsType'
        keyRequestTime:
          type: string
          description: The date/time the room key is requested.
          format: date-time
        roomKeyType:
          $ref: '#/components/schemas/externalRoomKeyType'
        keyUserType:
          $ref: '#/components/schemas/keyUserType'
        cardSerialNumber:
          description: Unique identifier of RFID card used for KeyPayload generation. Required when roomKeyType is KeyPayload.
          type: string
          maxLength: 80
        printData:
          $ref: '#/components/schemas/printDataType'
        interfaceId:
          description: Unique DB internal number of a Hotel Interface record.
          type: string
          maxLength: 80
      required:
      - keyType
      - encoderTerminal
      - encoderId
      - roomKeyType
      - keyUserType
      - keyRequestTime
    massAdvanceCheckInCriteriaType:
      type: object
      description: Criteria for performing Mass Advance Check In of Reservations
      properties:
        hotelId:
          description: Resort to which the Reservation belongs.
          type: string
          minLength: 0
          maxLength: 20
        reservationIdList:
          description: Collection of IDs of Reservations that should be Mass Advance Checked In
          $ref: '#/components/schemas/reservationIdList'
        expectedReturnTime:
          description: Time when the guest is expected to return to perform Check In
          type: string
          format: date-time
        eTRComments:
          description: Comments relating to the Advance Checked In guest's return to the property to perform Check In
          type: string
          minLength: 0
          maxLength: 2000
    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
    postingRhythmType:
      type: string
      description: Simple type for posting Rhythm types.
      enum:
      - EveryNight
      - ArrivalNight
      - EveryXNightsStartingNightY
      - CertainNightsOfTheWeek
      - LastNight
      - EveryNightExceptArrivalNight
      - EveryNightExceptLast
      - EveryNightExceptFirstAndLast
      - CustomStaySchedule
      - CustomNightSchedule
      - FloatingAllowancePerStay
      - TicketPosting
    room:
      type: object
      description: The reservation must still be reserved to use this operation.
      properties:
        criteria:
          description: Criteria for assigning a room to a reservation.
          $ref: '#/components/schemas/reservationRoomSelectionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    surnameType:
      type: string
      description: Family name, last name.
      minLength: 0
      maxLength: 80
    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
    ownerType:
      type: object
      description: Generic type for information about an owner.
      properties:
        hotel:
          description: Hotel to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        userId:
          description: Unique application user ID.
          $ref: '#/components/schemas/uniqueID_Type'
        userName:
          description: Unique application user name of the owner.
          type: string
          minLength: 0
          maxLength: 40
        ownerCode:
          description: Unique Code to identify the owner.
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: Unique owner profile information.
          $ref: '#/components/schemas/profileId'
        name:
          description: Provides name information of the owner.
          $ref: '#/components/schemas/personNameType'
        department:
          description: Department to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        email:
          description: Email information of the owner.
          $ref: '#/components/schemas/emailInfoType'
        phone:
          description: Information on the telephone number of the owner.
          $ref: '#/components/schemas/telephoneInfoType'
        relationship:
          description: Relationship of the owner within the profile or block.
          $ref: '#/components/schemas/codeDescriptionType'
        primary:
          description: When true, this is a primary owner.
          type: boolean
    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
    reservationECertificateType:
      type: object
      description: Reservation ECertificate Type Information.
      properties:
        eCertificateNo:
          description: ECertificate Number for the reservation.
          type: string
          minLength: 0
          maxLength: 40
        actionType:
          description: ECertificate status for the reservation.
          $ref: '#/components/schemas/requestActionType'
        eCertificateType:
          description: ECertificate Type where value can be PROMOTION,AWARD,BENEFIT and OTHER
          $ref: '#/components/schemas/eCertificateClassficationType'
    confDeliveryMethod:
      type: string
      enum:
      - Print
      - Email
      - Fax
      - Text
      - NotConfigured
    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
    reservationsInfo:
      type: object
      description: Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
      properties:
        reservationInfoList:
          description: Collection of Reservations and their information.
          type: object
          properties:
            reservationInfo:
              description: Contains details of the reservation.
              type: array
              items:
                $ref: '#/components/schemas/reservationInfoType'
        masterInfoList:
          description: Refer to Generic common types document
          type: array
          items:
            $ref: '#/components/schemas/masterInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    attendantType:
      type: object
      properties:
        attendantId:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    unAssignedRoom:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    hotelReservationsType:
      type: object
      description: A collection of Reservation objects and Unique IDs of Reservation.
      properties:
        reservation:
          description: A collection of Reservations.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/hotelReservationType'
        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
    prepaidCardTrxTypeType:
      type: string
      description: Reload transaction.
      enum:
      - Activate
      - Cancel
      - Cashout
      - Inquiry
      - Issue
      - Redeem
      - Reload
    profileDeliveryMethod:
      type: object
      description: Delivery Information type to the profile.
      properties:
        deliveryId:
          description: Delivery ID. It will be empty in case of new delivery method.
          $ref: '#/components/schemas/uniqueID_Type'
        deliveryType:
          description: Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.
          type: string
          minLength: 0
          maxLength: 20
        deliveryValue:
          description: Delivery value holds the corresponding value of the delivery type..
          type: string
          minLength: 0
          maxLength: 2000
        hotelId:
          description: Property that has delivery methods configured.
          type: string
          minLength: 0
          maxLength: 20
        deliveryModule:
          description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..'
          $ref: '#/components/schemas/profileDeliveryModuleType'
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    uniqueIDListType:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    roomKeyResponseCodeType:
      type: string
      description: Response Code
      enum:
      - OK
      - BY
      - UR
      - RY
    commissionPaymentMethods:
      type: string
      description: Check
      enum:
      - Cent
      - Eft
      - Chk
    operaVersionNumberType:
      type: string
      description: Current Opera Version Number
      minLength: 0
      maxLength: 40
    compRoutingStatusType:
      type: string
      description: Status which indicates that the Request of Comp Routing was declined
      enum:
      - Request
      - Comp
      - Declined
    errorsType:
      type: array
      description: An error that occurred during the processing of a message.
      maxItems: 99
      items:
        $ref: '#/components/schemas/errorType'
    confirmationsType:
      type: array
      description: List of confirmation letters.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/confirmationType'
    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.
          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.
          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
    autoRoomAssignType:
      type: object
      description: Collection of error and warning if any.
      properties:
        warnings:
          description: Details of the warnings.
          $ref: '#/components/schemas/warningsType'
        errors:
          description: Details of the errors.
          $ref: '#/components/schemas/errorsType'
        reservationId:
          description: Unique identifiers for the reservation for auto assign room.
          $ref: '#/components/schemas/reservationId'
        arrivalDate:
          description: Arrival date of the reservation. Uses the hotel's time zone.
          type: string
          format: date-time
        departureDate:
          description: Departure date of the reservation. Uses the hotel's time zone.
          type: string
          format: date-time
        guestName:
          description: Guest name associated to the reservation.
          type: string
          minLength: 0
          maxLength: 200
        roomId:
          description: Room number associated to the reservation.
          type: string
          minLength: 0
          maxLength: 20
        confirmationNo:
          description: Reservation confirmation number.
          $ref: '#/components/schemas/uniqueID_Type'
        roomStatus:
          description: Status of the room (Dirty/Clean/Inspected/Pickup).
          $ref: '#/components/schemas/housekeepingRoomStatusType'
    folioShortInfoType:
      type: object
      description: This type contains information of generated bills.
      properties:
        folioNo:
          description: Folio No of the bill generated.
          type: number
        folioType:
          description: Folio type of the bill generated.
          type: string
          minLength: 0
          maxLength: 200
        folioView:
          description: The folio window where the settlement is applied.
          type: integer
        autoGenerated:
          description: Flag to indicate if the folio is auto generated or not.
          type: boolean
        internalFolioWindowID:
          description: Internal window ID which is unique to the reservation. This ID can only be used for reference.
          type: string
          minLength: 0
          maxLength: 20
        invoiceNo:
          description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios
          type: number
        folioDate:
          description: Date of Folio Generation.
          type: string
          format: date
          maxLength: 8
        folioStatus:
          $ref: '#/components/schemas/folioStatusType'
    nameValueDetailType:
      type: object
      description: Detailed information returned during name value search.
      properties:
        nameValues:
          description: Name Value List.
          $ref: '#/components/schemas/nameValuesType'
    serviceRequests:
      type: array
      description: Service request.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/serviceRequest'
    totalType:
      type: object
      description: The total amount charged for the service including additional amounts and fees.
      properties:
        taxes:
          description: A collection of taxes.
          $ref: '#/components/schemas/taxesType'
        fees:
          description: A collection of fees or service charges.
          $ref: '#/components/schemas/feesType'
        description:
          type: string
          minLength: 0
          maxLength: 2000
        amountBeforeTax:
          description: The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
          type: number
        amountAfterTax:
          description: The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
          type: number
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        code:
          description: Type of charge.
          type: string
          minLength: 0
          maxLength: 20
        rateOverride:
          description: When true indicates that the rate amount has been overridden.
          type: boolean
        baseAmount:
          description: The rate's base price. Amount excluding price for any add to rate combine line package attached to the rate.Also excludes any discounts
          type: number
    taxesType:
      type: object
      description: A collection of taxes.
      properties:
        tax:
          description: An individual tax.
          type: array
          maxItems: 99
          items:
            $ref: '#/components/schemas/taxType'
        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
    rateByAgeBucketType:
      type: object
      description: Rate amount by age bucket.
      properties:
        rateAmount:
          description: Rate amount by age bucket.
          type: number
        minimumAge:
          description: Minimum age for age bucket.
          type: integer
        maximumAge:
          description: Maximum age for age bucket.
          type: integer
    overrideInstructionsType:
      type: array
      description: List of override actions done.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/overrideInstructionType'
    sentConfirmationStatus:
      type: string
      enum:
      - Pending
      - Succeeded
      - Failed
    stayFutureListType:
      type: object
      description: A collection of reservation history details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : Future reservation details'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayReservationInfoType'
        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
    countryNameType:
      type: object
      description: Code for a country or a nationality.
      properties:
        value:
          type: string
          description: Used for Character Strings, length 0 to 200 - It indicates country/nationality description.
          minLength: 0
          maxLength: 200
        code:
          description: Code for a country or a nationality.
          type: string
          minLength: 0
          maxLength: 20
        displayCountryFlag:
          description: Setting this to true will display the guest profile's country flag in the OPERA Cloud user interface, if it is configured.
          type: boolean
        isoCode:
          description: ISO standard code for country.
          type: string
          minLength: 0
          maxLength: 20
    dailyRateType:
      type: object
      description: The total amount charged for the service including additional amounts and fees.
      properties:
        taxes:
          description: A collection of taxes.
          $ref: '#/components/schemas/taxesType'
        fees:
          description: A collection of fees or service charges.
          $ref: '#/components/schemas/feesType'
        description:
          type: string
          minLength: 0
          maxLength: 2000
        amountBeforeTax:
          description: The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
          type: number
        amountAfterTax:
          description: The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
          type: number
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        code:
          description: Type of charge.
          type: string
          minLength: 0
          maxLength: 20
        rateOverride:
          description: When true indicates that the rate amount has been overridden.
          type: boolean
        baseAmount:
          description: The rate's base price. Amount excluding price for any add to rate combine line package attached to the rate.Also excludes any discounts
          type: number
        discount:
          description: Room rate discount percentage or amount, code and textual reason for discount.
          $ref: '#/components/schemas/discountType'
        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
    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
    queueReservation:
      type: object
      description: Request to add a reservation to the Queue for Check-In. A reservation can be added to the queue prior to Check-In on the day of arrival.
      properties:
        hotelId:
          description: Property where the reservation exists.
          $ref: '#/components/schemas/codeType'
        reservationId:
          description: Reservation ID of the reservation which is to be added to the queue.
          $ref: '#/components/schemas/reservationId'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    userDefinedFieldsType:
      type: object
      description: A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
      properties:
        characterUDFs:
          description: Collection of user defined fields of Character/String Type.
          $ref: '#/components/schemas/characterUDFsType'
        numericUDFs:
          description: Collection of user defined fields of Numeric Type.
          $ref: '#/components/schemas/numericUDFsType'
        dateUDFs:
          description: Collection of user defined fields of Date Type.
          $ref: '#/components/schemas/dateUDFsType'
    relationshipAddressType:
      type: object
      description: Provides address information for a Relationship.
      properties:
        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
        city:
          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).
          type: string
          minLength: 0
          maxLength: 200
    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
    additionalGuestAmountType:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/totalType'
        ageQualifyingCode:
          type: string
          enum:
          - ADULT
          - CHILD
          - OTHER
          - CHILDBUCKET1
          - CHILDBUCKET2
          - CHILDBUCKET3
          - CHILDBUCKET4
          - CHILDBUCKET5
    hotelRoomsOrderBy:
      type: string
      description: This type is used to support various sortings for available rooms search results.
      enum:
      - ForecastRotationPoints
    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
    messageDeliveryType:
      type: object
      description: Holds the Delivery Information of the Message
      properties:
        deliveryStatus:
          description: Status of the Message (Received or Not Received)
          $ref: '#/components/schemas/messageStatusType'
        deliveryDate:
          description: Date the message has been delivered (marked as received)
          type: string
          format: date-time
        deliveredBy:
          description: User who delivered the message (who marked message as received)
          type: string
          minLength: 0
          maxLength: 40
        printDate:
          description: Date when message has been printed
          type: string
          format: date-time
        textMessageSentDate:
          description: Date when message has been sent via SMS
          type: string
          format: date-time
        textMessageSentBy:
          description: User who sent the message
          type: string
          minLength: 0
          maxLength: 40
        textMessageSentById:
          description: User Id of who sent the message
          type: integer
        textMessageRecipientNo:
          description: Number in which the message is to be sent.
          type: string
          minLength: 0
          maxLength: 2000
    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
    serviceRequestStatusType:
      type: string
      enum:
      - Open
      - PendingFollowUp
      - Closed
      - DoNotDisturb
      - MakeUpRoom
    benefitType:
      type: object
      description: Basic information about membership benefit.
      properties:
        code:
          description: Benefit code associated with a membership.
          type: string
          minLength: 0
          maxLength: 20
        message:
          description: Processing message for membership benefit.
          type: string
          minLength: 0
          maxLength: 4000
        inactive:
          description: Indicates whether membership benefit is active or inactive.
          type: boolean
    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 pseudo 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
    compAccountingType:
      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
        aRNumber:
          description: AR Account Number of the authorizer
          type: string
          minLength: 0
          maxLength: 20
        compTypeCode:
          description: The Comp Type for this Account. Used when using the Comp types functionality
          type: string
          minLength: 0
          maxLength: 20
        compVoucherNo:
          description: The coupon or voucher number used by the external gaming system to track postings made to this routing.
          type: string
          minLength: 0
          maxLength: 30
        dateRange:
          description: Arrival date range for comp routing
          $ref: '#/components/schemas/dateRangeType'
        membershipId:
          description: Membership number
          type: string
          minLength: 0
          maxLength: 100
        membershipIdNo:
          description: Unique Id of membership
          type: integer
        membershipNameOnCard:
          description: Name displayed on the membership card
          type: string
          minLength: 0
          maxLength: 80
    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
    dailyDocket:
      type: object
      description: Response object for fetching log book entries.
      properties:
        dailyDocketEntries:
          description: List of log book entries.
          $ref: '#/components/schemas/dailyDocketType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    trackItLogType:
      type: object
      description: Individual activity log related to the Track It ticket.
      properties:
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        trackItLogId:
          $ref: '#/components/schemas/uniqueID_Type'
        trackItId:
          $ref: '#/components/schemas/trackItId'
        type:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 200
        businessDate:
          type: string
          format: date
          maxLength: 8
        logUserId:
          type: integer
        logUserName:
          type: string
        logDate:
          type: string
          format: date-time
    roomKeysInfoListType:
      type: array
      description: Contains details of Room key.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomKeyInfoType'
    privacyInfoType:
      type: object
      description: Defines Privacy related information for the profile.
      properties:
        marketResearchParticipation:
          description: Indicates if the profile participates in market research.
          type: boolean
        lastPrivacyPromptDate:
          description: Indicate the last privacy prompt date of the guest.
          type: string
          format: date
          maxLength: 8
        infoFromThirdParty:
          description: Indicates if the profile is ok getting info from third parties.
          type: boolean
        autoEnrollLoyaltyProgram:
          description: Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.
          type: boolean
        allowPhone:
          description: Indicates if the profile wishes to allow phone calls.
          type: boolean
        allowSMS:
          description: Indicates if the profile wishes to allow SMS.
          type: boolean
        allowEmail:
          description: Indicates if the profile wishes to allow Email.
          type: boolean
        optInMailingList:
          description: Indicates if the profile wishes to opt in for Mailing List.
          type: boolean
        optInMarketResearch:
          description: Indicates if the profile wishes to opt in for Market Research.
          type: boolean
        optInThirdParty:
          description: Indicates if the profile wishes to opt in for Third Party.
          type: boolean
        optInAutoEnrollmentMember:
          description: Indicates if the profile wishes to opt in for Auto Enrolment Member.
          type: boolean
        optInPhone:
          description: Indicates if the profile wishes to opt in for Phone.
          type: boolean
        optInSms:
          description: Indicates if the profile wishes to opt in for SMS.
          type: boolean
        optInEmail:
          description: Indicates if the profile wishes to opt in for Email.
          type: boolean
    mealPlanCodeType:
      type: object
      description: Meal plan codes associated with the rate codes.
      properties:
        code:
          description: Meal plan code.
          type: string
          minLength: 0
          maxLength: 40
        included:
          description: Represents if the meal plan code is included in rate code or not.
          type: boolean
        breakfastIncluded:
          description: Represents if the meal plan code is available for breakfast or not.
          type: boolean
        lunchIncluded:
          description: Represents if the meal plan code is available for lunch or not.
          type: boolean
        dinnerIncluded:
          description: Represents if the meal plan code is available for dinner or not.
          type: boolean
    formattedTextTextType:
      type: object
      description: Provides text and indicates whether it is formatted or not.
      properties:
        value:
          type: string
          description: Property Value
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
    operaVersion:
      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'
    resCancellationPolicyType:
      type: object
      description: A cancellation policy attached with the reservation.
      properties:
        revenueType:
          description: Type of reservation.
          $ref: '#/components/schemas/depositCancelRevenueType'
        policy:
          description: Cancellation policy details.
          $ref: '#/components/schemas/resCancelPenaltyType'
        percentageDue:
          description: The percentage amount due for reservation cancellation.
          type: number
          minimum: 0
          maximum: 100
        comments:
          description: Comments attached with the reservation cancellation.
          type: string
          minLength: 0
          maxLength: 2000
        policyId:
          description: Unique ID of the Reservation Policy.
          $ref: '#/components/schemas/uniqueID_Type'
    profileCashieringType:
      type: object
      description: Contains cashiering related details for the profile
      properties:
        directBillingList:
          description: Contains the direct billing related information for the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/directBillingType'
        autoFolioSettlementType:
          description: Contains the auto folio settlement type for the profile.
          type: string
          minLength: 0
          maxLength: 40
        paymentDueDays:
          description: Ability to define on the account, the number of days after which the invoice should be paid.
          type: integer
        taxPercent1:
          description: Tax1 Percentage for Collecting Agent.
          type: integer
        taxPercent2:
          description: Tax2 Percentage for Collecting Agent.
          type: integer
        taxPercent3:
          description: Tax3 Percentage for Collecting Agent.
          type: integer
        taxPercent4:
          description: Tax4 Percentage for Collecting Agent.
          type: integer
        taxPercent5:
          description: Tax5 Percentage for Collecting Agent.
          type: integer
        arNoCentral:
          description: Account Receivables Central Number.
          type: string
          minLength: 0
          maxLength: 20
        referenceCurrency:
          description: Reference Currency.
          type: string
          minLength: 0
          maxLength: 20
        vATOffsetYN:
          description: VAT Offset Flag.
          type: string
          minLength: 0
          maxLength: 1
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
    keyOptionsInfoType:
      type: object
      description: Response of fetch keyOptions operation.
      properties:
        reservationId:
          $ref: '#/components/schemas/reservationId'
        profileKeyOptions:
          type: array
          description: Key option preferences currently attached to a profile associated with the reservation.
          items:
            $ref: '#/components/schemas/profileKeyOptionsType'
        reservationKeyOptions:
          type: string
          description: Key option preferences currently attached to the reservation.
          minLength: 0
          maxLength: 200
        roomKeyOptions:
          type: string
          description: Key option preferences currently attached to the room assigned to the reservation.
          minLength: 0
          maxLength: 200
    roomKeyStatus:
      type: object
      description: Respose for the reading of room key.
      properties:
        room:
          type: string
          maxLength: 2000
        guestLastName:
          type: string
          maxLength: 2000
        guestFirstName:
          type: string
          maxLength: 2000
        validUntil:
          type: string
          format: date-time
          description: Uses the hotel's time zone.
        keyOptions:
          type: string
          maxLength: 2000
        guestDepartureDate:
          $ref: '#/components/schemas/dateRangeType'
        guestDepartureTime:
          $ref: '#/components/schemas/dateTimeRangeType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    relationshipInfoType:
      type: object
      description: Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
      properties:
        changeRelationship:
          description: Information about the changes in relationship for the profile
          $ref: '#/components/schemas/changeRelationsType'
        relationshipProfile:
          description: Refer to Relationship Profile type document.
          $ref: '#/components/schemas/relationshipProfileType'
        masterAccountInfo:
          description: Refer to Master Profile type document.
          $ref: '#/components/schemas/masterAccountInfoType'
        id:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        relation:
          description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 20
        relationDescription:
          description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetRelation:
          description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 20
        targetRelationDescription:
          description: Displays the description of the target relation(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
    depositCancelRevenueType:
      type: string
      description: The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
      enum:
      - Rooms
      - Catering
      - All
    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
    transactionDiversionRuleTypeType:
      type: string
      description: The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that reservation
      enum:
      - Vip
      - Membership
    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
    bookingTimeSpanType:
      type: object
      description: The booking time span of the reservation, only applicable when time increments are being used.
      properties:
        startDateTime:
          type: string
          description: The start time of the reservation booking
          format: date-time
        endDateTime:
          type: string
          description: The end time of the reservation booking
          format: date-time
    guestHousekeepingServiceRequestType:
      type: string
      description: Possible values for the Guest Service Status.
      enum:
      - DoNotDisturb
      - MakeUpRoom
      - NoStatusSelected
      - ServiceDeclined
    nameValueType:
      type: object
      description: Contains name value pair.
      properties:
        name:
          description: Contains unique key which represents for record field.
          type: string
          minLength: 0
          maxLength: 100
        value:
          description: Contains value for the record/column.
          type: string
          minLength: 0
          maxLength: 4000
        formatString:
          description: Contains format string for values.
          type: string
          minLength: 0
          maxLength: 100
        dataType:
          description: Contains data type for values.
          $ref: '#/components/schemas/nameValueDataTypeType'
        origin:
          description: Contains Origin information.
          $ref: '#/components/schemas/nameValueOriginType'
        usageInstruction:
          description: Contains value(s) to identify the reports to include the collected information in e.g. PFH=Print Folio Header, PFD=Print Folio Detail.
          $ref: '#/components/schemas/codeListType'
    roomKeyInterfaceDetailsType:
      type: array
      description: Configuration details of room key interface.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomKeyInterfaceDetailType'
    webUserHistoryType:
      type: object
      description: Creation date time, Creator Id, last modification date time and last Modifier Id.
      properties:
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
        lastLogin:
          description: Last login date.
          type: string
          format: date
          maxLength: 8
        lastPasswordChange:
          description: Last Password change date.
          type: string
          format: date
          maxLength: 8
        inactiveDate:
          description: Inactive date.
          type: string
          format: date
          maxLength: 8
    keyOptionsInfoListType:
      type: object
      properties:
        keyOptions:
          description: List of reservation key options.
          type: array
          items:
            $ref: '#/components/schemas/keyOptionsInfoType'
        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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    alertAreaType:
      type: string
      enum:
      - CheckIn
      - CheckOut
      - Reservation
      - Billing
      - InHouse
    negotiatedInfoType:
      type: object
      description: This provides information for a profile negotiated rate.
      properties:
        corporateAgreementId:
          description: The master identifier for multiple offices/locations under the same company profile. This is optional
          type: string
          minLength: 0
          maxLength: 80
        comissionCode:
          description: Informational purposes only in numeric format.
          type: string
          minLength: 0
          maxLength: 20
        order:
          description: The sell order.
          type: integer
        inactive:
          description: Negotiated Rate is inactive or not
          type: boolean
        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
    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'
        roomStatus:
          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.
          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.
          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: Back to Back functionality is available when the Back to Back Handling of Linked Reservations OPERA Control is active.
          type: boolean
    roomKey:
      type: object
      description: Request for generation of room key.
      properties:
        reservationIdList:
          description: Collection of unique reservation identifiers for the reservation we are trying to make a room key for.
          $ref: '#/components/schemas/uniqueIDListType'
        roomNumber:
          description: A room number to generate a key for. When creating keys using just the room number, the interface may allow only one-shot keys.
          type: string
          maxLength: 2000
        originalRoomNumber:
          description: Old Room Number is used when a room move is performed.
          type: string
          maxLength: 2000
        keyTrack:
          description: KeyTrack Data.
          $ref: '#/components/schemas/keyTrackType'
        resort:
          type: string
          maxLength: 2000
        noOfKeys:
          type: integer
        keyValidityStart:
          type: string
          format: date-time
        keyValidityEnd:
          type: string
          format: date-time
        encoderTerminal:
          type: string
          maxLength: 2000
        encoderId:
          $ref: '#/components/schemas/uniqueID_Type'
        keyType:
          $ref: '#/components/schemas/roomKeyType'
        keyCardType:
          $ref: '#/components/schemas/keyCardType'
        keyCardUId:
          type: string
          maxLength: 2000
        keyOptions:
          type: string
          maxLength: 2000
        additionalRooms:
          description: Collection of additional rooms to be included in key creation of reservation room.
          $ref: '#/components/schemas/codeListType'
        interfaceId:
          description: Unique DB internal number of a Hotel Interface record.
          type: string
          maxLength: 80
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
        roomKeyGuests:
          type: array
          description: Collection of of Room key guests for multiple guest room key functionality.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomKeyGuest'
    membershipEarningPreferenceType:
      type: string
      description: The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.
      enum:
      - Points
      - Miles
    fetchActivityBookingsType:
      type: object
      description: Used in the request message to describe the "filtering Criteria" when executing an activity lookup.
      properties:
        profileId:
          description: ProfileID associated with the Activity under lookup.
          $ref: '#/components/schemas/uniqueIDListType'
        personName:
          description: Detailed name information for the customer.
          $ref: '#/components/schemas/personNameType'
        address:
          description: Detailed Address information for the customer.
          $ref: '#/components/schemas/addressType'
        activities:
          description: The specific activity information to be used for filtering the Look-up.
          $ref: '#/components/schemas/activityList'
        hotelId:
          description: Hotel Code, It is used to filter hotel specific children to this specific hotel code.
          type: string
          minLength: 0
          maxLength: 20
    reservationTransactionDiversionsType:
      type: array
      description: List of Transaction Diversion rules.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationTransactionDiversionType'
    reservationPackageScheduleType:
      type: object
      description: A HotelPackageSchedule type.
      properties:
        consumptionDate:
          description: The date the package was used or can be used.
          type: string
          format: date
          maxLength: 8
        unitPrice:
          description: The price per unit of the package.
          type: number
        totalQuantity:
          description: The total quantity of the package for this date, calculated based on the calculation rule as defined in the PackageHeaderType
          type: integer
        computedResvPrice:
          description: Computed Reservation Price of the package. Calculation Will Be Performed Based On Other Parameters.
          type: number
        unitAllowance:
          description: The allowance per unit of the package.
          type: number
        reservationDate:
          description: The date of the Reservation when this package is applicable. This can be different from the date the package will be consumed. Example are next day packages. Reservation date is when the package is applied to the guest and Consumption date is when the guest can consume the package.
          type: string
          format: date
          maxLength: 8
        originalUnitPrice:
          description: The original price per unit of the package if it has been changed.
          type: number
        originalUnitAllowance:
          description: The original allowance per unit of the package if it has been changed.
          type: number
    foreignExchangeType:
      type: object
      description: Foreign Exchange info.
      properties:
        type:
          description: Exchange Type for the postings.
          type: string
          minLength: 0
          maxLength: 20
        effectiveDate:
          description: Effective Exchange date for the foreign currency posting.
          type: string
          format: date
          maxLength: 8
    resCashieringType:
      type: object
      description: Cashiering Information for the reservation.
      properties:
        revenuesAndBalances:
          description: Revenues and Balances Amount summary for the reservation.
          $ref: '#/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
    eCertificateType:
      type: object
      description: E-Certificates details.
      properties:
        certificateId:
          description: System generated unique certificate id.
          type: integer
        voucherNo:
          description: System generated unique voucher number.
          type: string
          minLength: 0
          maxLength: 40
        certificateNo:
          description: Printed certificate no. This has to be unique.
          type: string
          minLength: 0
          maxLength: 40
        eCertificateInfo:
          $ref: '#/components/schemas/eCertificateInfoType'
        expiryDate:
          description: Date of expiry.
          type: string
          format: date
          maxLength: 8
        newExpiryDate:
          description: New Date of expiry to extend e-certificate.
          type: string
          format: date
          maxLength: 8
        profileId:
          description: NameId.
          $ref: '#/components/schemas/profileId'
        consumptionDetail:
          $ref: '#/components/schemas/eCertificateConsumptionType'
        status:
          description: Status of the certificate.
          $ref: '#/components/schemas/eCertificateStatusType'
        printed:
          description: Print status of the certificate.
          type: boolean
        inactiveDate:
          description: Date the record was marked as inactive.
          type: string
          format: date
          maxLength: 8
        awardId:
          description: AwardID.
          $ref: '#/components/schemas/awardId'
        databaseId:
          description: External reference from which the record is created.
          type: string
          minLength: 0
          maxLength: 20
        source:
          description: Source of e-certificate.
          $ref: '#/components/schemas/eCertificateIssueSourceType'
        issueType:
          description: Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p).
          $ref: '#/components/schemas/eCertificateIssueType'
        issueDate:
          description: Date when certificate was issued.
          type: string
          format: date
          maxLength: 8
        awardPoints:
          description: Award points if any in case of certificate use membership award.
          type: integer
        generationDetail:
          $ref: '#/components/schemas/eCertificateGenerationType'
        originalVoucherNo:
          description: In case of in lieu of certificate this will contain the original voucher no.
          type: string
          minLength: 0
          maxLength: 40
        originalCertificateNo:
          description: In case of in lieu of certificate this will contain the original certificate no.
          type: string
          minLength: 0
          maxLength: 40
        inLieuSequence:
          description: Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.
          type: integer
        cancelRequestDate:
          description: Date on which the cancellation was requested.
          type: string
          format: date
          maxLength: 8
        extensionCount:
          description: Number of times e-certificate is already extended.
          type: integer
    swapShiftOverrideInstructionType:
      type: object
      description: Contains information for the override actions performed while swapping or shifting rooms.
      properties:
        overrideRoomFeatures:
          description: This flag indicates true/false. When this is true, it will allow to override the room feature preference validation while swapping or shifting rooms. The Reservation Room Features OPERA Control will determine which room feature preferences will be validated. When Reservation Room Features is on, the validation will be against the Room Feature preferences attached to the reservation. If the parameter is off, the validation will be against the Room Feature preferences attached to the profile. This is applicable when the Room Feature Validation OPERA Control is on.
          type: boolean
    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
    hotelReservationType:
      type: object
      description: The Reservation class contains the current reservation being created or altered.
      properties:
        reservationIdList:
          description: Used to provide PMS and/or CRS identifiers.
          $ref: '#/components/schemas/reservationIdList'
        externalReferences:
          description: External Reference information for Reservation.
          $ref: '#/components/schemas/externalReferencesType'
        associatedReservations:
          description: Information regarding associated reservations.
          $ref: '#/components/schemas/associatedResType'
        sourceOfSale:
          description: Point of Sale of reservation. Identifies the entity/channel who made the reservation.
          $ref: '#/components/schemas/sourceOfSaleType'
        roomStay:
          description: Room stays information.
          $ref: '#/components/schemas/roomStayType'
        compAuthorizer:
          description: Reservation Comp Authorizer.
          $ref: '#/components/schemas/compAuthorizerInfoType'
        reservationGuests:
          description: Collection of guests associated with the reservation.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/resGuestType'
        sharedGuests:
          description: Collection of guests who share this reservation.
          $ref: '#/components/schemas/resSharedGuestListType'
        additionalGuestInfo:
          description: Entry Date into the country. (Croatian Requirements).
          $ref: '#/components/schemas/resGuestAdditionalInfoType'
        reservationProfiles:
          description: Collection of guests associated with the reservation.
          type: object
          properties:
            reservationProfile:
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/reservationProfileType'
            commissionPayoutTo:
              description: If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.
              $ref: '#/components/schemas/commissionPayoutToType'
        reservationCommunication:
          description: Collection of reservation communication details.
          $ref: '#/components/schemas/resCommunicationType'
        reservationAwards:
          description: Collection of Awards,Certificates for the guest profile.
          $ref: '#/components/schemas/awardsType'
        trackItItems:
          description: Collection of TrackIt Items available for that reservation
          $ref: '#/components/schemas/trackItItemsType'
        shares:
          description: Collection of share reservation available for that reservation
          $ref: '#/components/schemas/hotelReservationsType'
        locators:
          description: Collection of Locators available for that reservation
          $ref: '#/components/schemas/reservationLocatorsType'
        attachments:
          description: Collection of attachments available for that reservation
          $ref: '#/components/schemas/attachmentsType'
        webRegistrationCards:
          description: Collection of Web Registration Cards available for that reservation
          $ref: '#/components/schemas/attachmentsType'
        serviceRequests:
          description: Collection of Service Requests available for that reservation
          $ref: '#/components/schemas/serviceRequests'
        reservationActivities:
          description: Collection of Reservation Activities available for that reservation
          $ref: '#/components/schemas/activityLookUpList'
        scheduledActivities:
          description: Collection of Scheduled Activities available for that reservation
          $ref: '#/components/schemas/activityLookUpList'
        prepaidCards:
          description: Collection of Prepaid Cards available for that reservation
          $ref: '#/components/schemas/prepaidCardsType'
        profileAwards:
          description: Collection of profile awards available for that reservation
          $ref: '#/components/schemas/awardsType'
        reservationPackages:
          description: A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationPackageType'
        inventoryItems:
          description: A collection of inventory items attached to a reservation.
          $ref: '#/components/schemas/resInventoryItemsType'
        comments:
          description: List of Notes for the Guest related to the reservation.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/commentInfoType'
        guestComments:
          description: List of Notes for the Guest related to the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/commentInfoType'
        guestMemberships:
          description: List of Memberships for the Guest related to the reservation.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/membershipType'
        preferenceCollection:
          description: Collection of reservation preferences.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/preferenceTypeType'
        reservationMemberships:
          description: List of reservation memberships.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationMembershipType'
        reservationPaymentMethods:
          description: A collection of Payment Method objects.
          $ref: '#/components/schemas/reservationPaymentMethodsType'
        routingInstructions:
          description: Set of Routing Instructions.
          $ref: '#/components/schemas/routingInfoListType'
        reservationPolicies:
          description: A collection of Cancellation Penalties objects.
          $ref: '#/components/schemas/reservationPoliciesType'
        cashiering:
          description: Holds cashiering related information for the reservation.
          $ref: '#/components/schemas/resCashieringType'
        housekeeping:
          description: Holds rooms housekeeping information.
          $ref: '#/components/schemas/resHousekeepingType'
        linkedReservation:
          description: Reservations related to the current Reservation.
          $ref: '#/components/schemas/linkedReservationsInfoType'
        extSystemSync:
          type: boolean
        userDefinedFields:
          description: Collections of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
        reservationIndicators:
          description: Indicators of additional information attached to the reservation
          $ref: '#/components/schemas/indicatorsType'
        waitlist:
          description: Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is no more in Waitlist status.
          $ref: '#/components/schemas/waitlistResType'
        cancellation:
          description: Information regarding why reservation has been/was cancelled. This could hold information as history even if reservation is no more in in Cancelled status.
          type: object
          properties:
            description:
              type: string
              minLength: 0
              maxLength: 2000
            code:
              type: string
              minLength: 0
              maxLength: 20
            cancellationNo:
              description: Cancellation Number given when reservation was last cancelled.
              $ref: '#/components/schemas/uniqueID_Type'
            date:
              description: Date when reservation was last cancelled.
              type: string
              format: date
              maxLength: 8
        catering:
          description: Catering event information if reservation is associated with the catering event.
          $ref: '#/components/schemas/cateringResInfoType'
        statisticalClassification:
          description: Catering event information if reservation is associated with the catering event.
          $ref: '#/components/schemas/resStatClassificationType'
        alerts:
          description: List of reservation alerts.
          $ref: '#/components/schemas/alertsType'
        traces:
          description: List of reservation Traces.
          $ref: '#/components/schemas/hotelReservationTracesType'
        confirmationLetters:
          description: List of reservation confirmation letters.
          $ref: '#/components/schemas/confirmationsType'
        callHistory:
          description: List of reservation calls.
          $ref: '#/components/schemas/callHistoryType'
        fixedCharges:
          description: List of reservation fixed charges.
          $ref: '#/components/schemas/fixedChargesType'
        guestMessages:
          description: List of Messages.
          $ref: '#/components/schemas/guestMessagesType'
        lockHandle:
          description: An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.
          type: number
        overrideInstructions:
          description: List of overrides done for the reservation.
          $ref: '#/components/schemas/overrideInstructionsType'
        queue:
          description: Information about the time and duration this reservation was on Queue for Checkin.
          $ref: '#/components/schemas/reservationQueueInformationType'
        allowedActions:
          description: Collection of allowed actions for the reservation.
          $ref: '#/components/schemas/reservationAllowedActionsType'
        eCoupons:
          description: List of eCoupons.
          $ref: '#/components/schemas/eCouponsType'
        transactionDiversions:
          description: List of transaction diversions attached to the reservation.
          type: object
          properties:
            transactionDiversions:
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/reservationTransactionDiversionsType'
            actionType:
              type: string
              maxLength: 2000
        advanceCheckIn:
          description: Information relating to Reservation's Advance Checked In state and Expected Time of Return
          $ref: '#/components/schemas/advanceCheckInType'
        tickets:
          description: List of Reservation Tickets.
          $ref: '#/components/schemas/ticketsType'
        accessRestrictionMessage:
          description: Configurable Access Restriction Message for Excluded Block or Rate Code.
          type: string
          minLength: 0
          maxLength: 4000
        eCertificates:
          description: List of ECertificates attached to the reservation.
          $ref: '#/components/schemas/reservationECertificatesType'
        customNameValueDetail:
          description: List of Custom Name Value Information attached to the reservation.
          $ref: '#/components/schemas/nameValueDetailType'
        customChargeExemptionDetails:
          description: List of Custom Charge Exemptions attached to the reservation.
          $ref: '#/components/schemas/customChargeExemptionsType'
        folios:
          description: This element returns any automatically generated folios during check-in, based on the Fetch Instruction "AutoFolios". When the parameter "Auto Generate Credit Bill for Deposit upon Check In" is enabled, during check-in credit bills are automatically generated for the deposits. The generated credit bill details are returned so that user can preview/print the folio. For some countries like Portugal, it is mandatory to print the folio and hence this information is needed
          $ref: '#/components/schemas/foliosShortInfoType'
        autoBorrowFromHouse:
          description: This flag will force to borrow from house if borrow required for number of rooms requested, this will only applicable when reservation is attached to a Block.
          type: boolean
        overrideExternalChecks:
          description: Forcefully override the create/update action on the Reservation. For real-time CRS interfaces, this element is used as force selling indicator in case of Create or Update Reservation
          type: boolean
        hotelId:
          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
        reservationStatus:
          description: Indicates the Actual status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
        computedReservationStatus:
          description: Indicates the Computed status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
        walkIn:
          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
        printRate:
          description: Indicates whether to show the rate or not on a printed document which includes the rate.
          type: boolean
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
        createBusinessDate:
          description: Business Date when the reservation was created.
          type: string
          format: date
          maxLength: 8
        reinstateDate:
          description: Business Date when the reservation was last reinstated.
          type: string
          format: date
          maxLength: 8
        party:
          description: Party/PartyCode when reservation is part of a party(a small group).
          type: string
          minLength: 0
          maxLength: 50
        primaryEnrollmentResort:
          description: Name Of the Resort/Hotel for the primary enrollment
          type: string
          minLength: 0
          maxLength: 80
        primaryEnrollmentChain:
          description: Name of the Chain for the primary enrollment
          type: string
          minLength: 0
          maxLength: 80
        customReference:
          description: Custom Reference to identify reservation.
          type: string
          minLength: 0
          maxLength: 50
        displayColor:
          description: The color to display this reservation on room grid displays.
          type: string
          minLength: 0
          maxLength: 20
        displayColorDetails:
          description: 'Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION '
          $ref: '#/components/schemas/reservationDisplayColorInfoType'
        markAsRecentlyAccessed:
          description: Mark this reservation as recently accessed.
          type: boolean
        overrideInventoryCheck:
          description: Indicates to Override the Room Inventory Check if applicable.
          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'
        preRegistered:
          description: Is the reservation pre-registered.
          type: boolean
        upgradeEligible:
          description: Indicates whether the reservation is eligible for upgrade.
          type: boolean
        overrideBlockRestriction:
          type: boolean
        allowAutoCheckin:
          description: Flag to allow auto checkin
          type: boolean
        hasOpenFolio:
          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
        allowPreRegistration:
          description: Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.
          type: boolean
        optedForCommunication:
          description: Flag containing true or false value to determine if the guest has opted for communications pertaining to this reservation.Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is marked for communication. Upon fetch, the current state of the flag will show true or false.
          type: boolean
        chargeCardNumber:
          description: This attribute represents Hotel charge card number. This number is generated automatically in OPERA when a reservation is created in OPERA. It is part of a functionality that provide the guest with the convenience of placing all their charges directly on their reservation folio.
          type: string
          minLength: 0
          maxLength: 100
        overrideOutOfServiceCheck:
          description: Indicates to Override the Room Out Of Service Check if applicable.
          type: boolean
        hasVoucher:
          description: This flag value true indicates the reservation matches a Voucher Rule. It is supported only if OPERA Control Vouchers is active.
          type: boolean
        scheduledRoomMoves:
          description: Scheduled Moves
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/scheduledRoomMoveType'
        backToBack:
          description: This attribute indicates if the linked reservation is marked as Back to Back or not. Back to Back functionality is available when the Back to Back Handling of Linked Reservations OPERA Control is active.
          type: boolean
        backToBackSequence:
          description: This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1,2' i.e, 1 indicates Sequence Position and 2 indicates total count of linked Back to Back reservations with consecutive Stay Dates). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active.
          $ref: '#/components/schemas/backToBackResSequenceType'
        backToBackGroupId:
          description: This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.
          type: string
          minLength: 0
          maxLength: 80
    suggestedRoomType:
      type: object
      description: List of suggested rooms and component rooms.
      properties:
        componentRoomNumber:
          description: List of component Room number belongs to a room.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        roomId:
          description: Code of the room.
          type: string
          minLength: 0
          maxLength: 20
    routingInstructionType:
      type: object
      description: 'Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit'
      properties:
        duration:
          description: Duration of this instruction.
          type: object
          properties:
            timeSpan:
              $ref: '#/components/schemas/timeSpanType'
            sunday:
              type: boolean
            monday:
              type: boolean
            tuesday:
              type: boolean
            wednesday:
              type: boolean
            thursday:
              type: boolean
            friday:
              type: boolean
            saturday:
              type: boolean
            daily:
              description: Flag to indicate if the routing instruction is a daily instruction.
              type: boolean
        transactionCodes:
          description: Set of Transaction Codes configured in this time span.
          $ref: '#/components/schemas/trxCodesInfoType'
        billingInstructions:
          description: Set of Billing Instructions configured in this time span.
          $ref: '#/components/schemas/billingInstructionsType'
        creditLimit:
          description: Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero.
          type: number
        percentageLimit:
          description: The routing limit percentage allowed for this routing instruction.
          type: number
        covers:
          description: Number of covers for this routing instruction.
          type: number
        limitUsed:
          description: Amount of Credit used for this routing instruction.
          type: number
        routingLinkId:
          description: Internal Routing Link Id identifier to which limit group the instruction belongs.
          $ref: '#/components/schemas/uniqueID_Type'
    profileMembershipType:
      type: object
      description: Detailed information of the memberships.
      properties:
        comment:
          description: Additional comments regarding to the membership.
          $ref: '#/components/schemas/paragraphType'
        newMembershipNumber:
          description: Card Number of the membership.
          type: string
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
        programDescription:
          description: Description of the membership program.
          type: string
        membershipLevel:
          description: Indicates the membership level.
          type: string
        membershipLevelDescription:
          description: Indicates the membership level description.
          type: string
          minLength: 0
          maxLength: 200
        membershipClass:
          description: Indicates the membership class.
          type: string
        earningPreference:
          description: Earning preference to the membership.
          $ref: '#/components/schemas/membershipEarningPreferenceType'
        inactive:
          description: Indicates whether membership is active or inactive.
          type: boolean
        benefits:
          description: benefits for the membership.
          $ref: '#/components/schemas/benefitsType'
        tierAdministration:
          description: Defines the degree of participation for this membership in the tier management portion of the program.
          $ref: '#/components/schemas/tierAdministrationType'
        downgrade:
          description: Defines how downgrading will be handled for this membership.
          $ref: '#/components/schemas/downgradeType'
        reIssueNewCard:
          description: The status of issuing new membership card to the member.
          $ref: '#/components/schemas/cardReIssueType'
        excludeFromBatch:
          description: True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.
          type: boolean
        upgradeDescription:
          description: Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.
          type: string
          minLength: 0
          maxLength: 32000
        downgradeDescription:
          description: Indicates information regarding the member's possible downgrades.
          type: string
          minLength: 0
          maxLength: 32000
        rating:
          description: Value Rating Type Description for this membership.
          type: string
        membershipEnrollmentCode:
          description: Indicates how the guest enrolled in the program.
          type: string
          minLength: 0
          maxLength: 20
        memberStatus:
          description: Indicates where the guest is in the membership enrollment process.
          type: string
          minLength: 0
          maxLength: 20
        currentPoints:
          description: Profile MemberShip Points.
          type: number
        pointsLabel:
          description: Label used to refer to points for this membership type
          type: string
          minLength: 0
          maxLength: 20
        enrollmentSource:
          description: Source from where the enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        enrollmentResort:
          description: Resort/CRO where enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        preferredCard:
          description: Preferred Card.
          type: boolean
        membershipId:
          description: Card Number of the membership.
          type: string
        membershipType:
          description: Type of membership.
          type: string
        primaryMembershipYn:
          description: Indicator if Membership is a Primary Membership.
          type: string
          minLength: 0
          maxLength: 1
        primaryMembership:
          description: Boolean indicator set to True implies membership is a Primary Membership.
          type: boolean
        membershipIdNo:
          description: Membership ID Number.
          type: integer
        playerRanking:
          description: Ranking assigned to the Player Profile by the Gaming system.
          type: integer
        centralSetup:
          description: Indicates how the award points for this membership type will be managed.
          type: boolean
        signupDate:
          description: Indicates when the member signed up for the loyalty program.
          type: string
          format: date
          maxLength: 8
        effectiveDate:
          description: Indicates the starting date.
          type: string
          format: date
          maxLength: 8
        expireDate:
          description: Indicates the ending date.
          type: string
          format: date
          maxLength: 8
        expireDateExclusiveIndicator:
          description: When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    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
        confidential:
          type: boolean
          description: Flag indicating a billing window (2-8) as confidential. Applied only when Confidential Billing Window Opera Control is active.
    mealPlansType:
      type: array
      description: Meal plan codes associated with the rate codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/mealPlanCodeType'
    roomKeyExternalDetails:
      type: object
      description: Response for the key request made to DLS from Opera PMS.
      properties:
        encoderId:
          type: string
          description: Unique Id as defined by Door Lock System.
          maxLength: 2000
        encoderTerminal:
          type: string
          description: The Unique PMS encoder name linked with the encoderId
          minLength: 1
          maxLength: 2000
        reservationIdList:
          description: Collection of unique reservation identifiers for the reservation we are trying to make a room key for.
          $ref: '#/components/schemas/uniqueIDListType'
        roomId:
          description: The PMS room number to generate a key for.
          type: string
          maxLength: 2000
        keyTrack:
          description: KeyTrack Data.
          type: array
          items:
            $ref: '#/components/schemas/keyTrackType'
        keyOptions:
          type: string
          maxLength: 200
          description: 'Lists all PMS access areas - only send in response for keyType: ''Read'' request'
        keyValidityStart:
          type: string
          description: 'Date/Time Key is valid from - only send in response for keyType: ''Read'' request'
          format: date-time
        keyValidityEnd:
          type: string
          description: 'Date/Time Key is valid to - only send in response for keyType: ''Read'' request'
          format: date-time
        responseText:
          type: string
          description: A user-friendly text with information on why a request is not successful
          maxLength: 2000
        responseCode:
          $ref: '#/components/schemas/roomKeyResponseCodeType'
        additionalRooms:
          description: Collection of additional rooms to be included in key creation of reservation room.
          type: array
          maxItems: 999
          items:
            type: string
            minLength: 0
            maxLength: 20
      required:
      - roomId
      - responseCode
      - encoderTerminal
    wakeUpCallResvInfoType:
      type: object
      description: Criteria to search and retrieve wake up calls.
      properties:
        reservationIdList:
          description: Collection of reservation identifiers like Reservation Name ID, Confirmation Number, etc.
          $ref: '#/components/schemas/reservationIdList'
        hotelId:
          description: Hotel Code where wake up call is set.
          type: string
          minLength: 0
          maxLength: 20
        timezone:
          description: Timezone of hotel.
          type: string
        guestName:
          description: Guest Name.
          type: string
        profileId:
          description: ID of the Guest profile.
          $ref: '#/components/schemas/profileId'
        vip:
          description: Guest Name.
          type: string
          minLength: 0
          maxLength: 20
        membershipLevel:
          description: Membership Level of the guest.
          type: string
          minLength: 0
          maxLength: 20
        membershipType:
          description: Membership Type of the guest.
          $ref: '#/components/schemas/codeDescriptionType'
        arrival:
          description: Reservation arrival date.
          type: string
          format: date
          maxLength: 8
        departure:
          description: Reservation departure date.
          type: string
          format: date
          maxLength: 8
        room:
          description: Hotel room in which wake up call is to ring.
          type: string
          minLength: 0
          maxLength: 20
        roomPhoneNumber:
          description: Room phone number which wake up call is to ring.
          type: string
          minLength: 0
          maxLength: 20
        extensionNumber:
          description: Room Phone Extension Number.
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          description: Block id with which wake up call is associated.
          $ref: '#/components/schemas/blockId'
        blockCode:
          description: Block code with which wake up call is associated.
          type: string
          minLength: 0
          maxLength: 20
        reservationStatus:
          description: Indicates the Actual status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
    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
    linkedReservations:
      type: object
      properties:
        linkedReservationList:
          description: Set of reservations linked to the requested Reservation.
          $ref: '#/components/schemas/linkedReservationsInfoType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    colorDefinitionType:
      type: string
      description: 'Color definition type. This color definition type is used to determine the defintion of color '
      enum:
      - RESERVATION
      - MARKET_CODE
      - VIP_LEVEL
      - MEMBERSHIP_LEVEL
    reservationList:
      type: object
      description: A collection of reservation details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : History,Future reservations'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationInfoType'
        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
    reservationInterface:
      type: object
      description: Request to change the interface status for a reservation.
      properties:
        reservationInterfaceStatus:
          description: Contains collection of reservation and interface information
          type: object
          properties:
            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.
              $ref: '#/components/schemas/codeType'
            interfaceStatusList:
              description: Collection of reservation and interface information.
              type: array
              items:
                $ref: '#/components/schemas/changeInterfaceStatusType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    queuedRoomsTextMessage:
      type: object
      description: Response for retrieving a predefined text message, for Queue Reservations or Queue Rush.
      properties:
        messageText:
          description: Predefined message text, based on the message type defined in the request.
          $ref: '#/components/schemas/stringLength200'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    reservationKeyInfoType:
      type: object
      description: Holds the room key information provided by the Door Lock System.
      properties:
        keyPin:
          description: PIN provided in keyTrack3 from the Door Lock System that is used to unlock a room. This is supported when Key Pin handling is active for the property and the Door Lock System in use.
          type: string
          minLength: 0
          maxLength: 200
    effectiveRatesType:
      type: array
      description: Collection of effective rate amount per guest on specific dates.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/effectiveRateType'
    dateTimeStampGroupType:
      type: object
      properties:
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    trackItActionType:
      type: object
      description: Identifies the response expected from staff or other parties relative to a Track It ticket.
      properties:
        trackItAction:
          $ref: '#/components/schemas/codeDescriptionType'
        status:
          $ref: '#/components/schemas/actionStatusType'
    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
    activityLogListType:
      type: object
      properties:
        activityLog:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/activityLogType'
        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
    floorPlans:
      type: object
      description: Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
      properties:
        floorPlansDetails:
          type: array
          items:
            $ref: '#/components/schemas/floorPlanType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    awardType:
      type: object
      description: Detailed information of the awards.
      properties:
        awardCode:
          description: Award category.
          type: string
          minLength: 0
          maxLength: 20
        awardType:
          description: Can be P (Paper) or E (E-Certificate).
          $ref: '#/components/schemas/awardKindType'
        description:
          description: Description of the award/certificate.
          type: string
        certificateNo:
          description: Certificate No.
          type: string
          minLength: 0
          maxLength: 20
        masterCertificiateNo:
          description: Master Certificate No.
          type: string
          minLength: 0
          maxLength: 20
        membershipNo:
          description: Membership No.
          type: string
        hotelId:
          description: Hotel Code for which the routing instructions are provided for a profile.
          type: string
          minLength: 0
          maxLength: 20
        hotelCategory:
          description: Indicates the lowest hotel category for which the certificate is valid.
          type: string
          minLength: 0
          maxLength: 20
        externalHotelCode:
          description: Hotel Code of the CRS application that this certificate belongs to.
          type: string
          minLength: 0
          maxLength: 20
        externalConfirmationNo:
          description: Confirmation Number given by a CRS application for this reservation.
          type: string
          minLength: 0
          maxLength: 20
        categoryValid:
          description: Indicates whether the category of certificate is valid or not for this resort.
          type: boolean
        reservationCertificateType:
          description: '[R]=Reward, [I]=Incentive.'
          $ref: '#/components/schemas/reservationCertificateType'
        rewardCertificateType:
          description: '[RE]=Regular Certificate, [SA]=Stay Anytime Certificate, [PS]=Point Saver Certificate.'
          $ref: '#/components/schemas/rewardCertificateType'
        status:
          description: Status of the award aka available.
          $ref: '#/components/schemas/awardStatusType'
        expirationDate:
          description: Expiration Date.
          type: string
          format: date
          maxLength: 8
        gift:
          description: Signifies whether award is gift or not.
          type: boolean
        upgrade:
          description: Signifies whether upgrade award or not.
          type: boolean
        package:
          description: Signifies whether upgrade is package or not.
          type: boolean
        instantlyRedeemable:
          description: Indicates if the award is an Instant Redemption award.
          type: boolean
        paidUpgrade:
          description: Indicates if this certificate was ordered using the "Paid Upgrade" option in the E-Certs screen.
          type: boolean
        detailedCertificate:
          description: Indicates if this certificate is detailed or not.
          type: boolean
        nights:
          description: Award Nights.
          type: integer
        sourceType:
          description: 'MRW : From MRW MAN:Entered manually.'
          type: string
        points:
          description: No. of points used to order this award.
          type: number
        fBAInfo:
          description: FBA related fields.
          $ref: '#/components/schemas/fBAInfoType'
        reservationId:
          description: Reservation IDs will be empty if award is not attached.
          $ref: '#/components/schemas/reservationId'
        profileId:
          description: Unique profile identifier requested to be fetched.
          $ref: '#/components/schemas/profileId'
        quantity:
          description: Quantity of such awards needed to be ordered.
          type: integer
        displaySequence:
          description: Indicates the order in which the certificates received from MRW.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    eventId:
      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
    nameValueOriginType:
      type: object
      description: Contains origin details.
      properties:
        originName:
          description: Contains origin i.e. Reseravtion, Profile, Folio or FinTrx.
          $ref: '#/components/schemas/nameValueModuleType'
        destination:
          description: Contains destination column for Origin.
          type: string
          minLength: 0
          maxLength: 200
        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
    identificationInfoType:
      type: object
      description: Information on the identification of the customer.
      properties:
        identification:
          description: Detailed information on the identification of the customer.
          $ref: '#/components/schemas/identificationType'
        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
    wakeUpCallsType:
      type: array
      description: List of the wake up calls
      maxItems: 4000
      items:
        $ref: '#/components/schemas/wakeUpCallType'
    masterInfoCodeDetailType:
      type: string
      enum:
      - LongDescription
      - ShortDescription
    status:
      type: object
      description: Response Body.
      properties:
        warnings:
          $ref: '#/components/schemas/warningsType'
        links:
          $ref: '#/components/schemas/links'
    profileRestrictions:
      type: object
      properties:
        reason:
          description: Restriction reason associated with the current profile.
          type: string
          minLength: 0
          maxLength: 20
        reasonDescription:
          description: Description of restriction reason.
          type: string
          minLength: 0
          maxLength: 2000
        restricted:
          description: True indicates there are restrictions associated with the current profile.
          type: boolean
    promotionType:
      type: object
      description: Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
      properties:
        promotionCode:
          description: Promotion code associated with the rate plan.
          type: string
          minLength: 0
          maxLength: 20
        promotionName:
          description: Promotion code Name associated with the rate plan.
          type: string
          minLength: 0
          maxLength: 20
        couponCode:
          description: Promotion Coupon Code when promotion is setup to have a valid coupon code.
          type: string
          minLength: 0
          maxLength: 40
    holdRooms:
      type: object
      description: Request to place rooms on hold.
      properties:
        holdRoomsDetails:
          description: List of rooms, hold reason, and comments.
          $ref: '#/components/schemas/roomsHoldsType'
        overrideRoomHold:
          description: If trying to hold a room, which is held by a different user, then this flag will allow the current request to override that hold.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    advanceCheckInReservation:
      type: object
      description: Request object to perform Advance Check In of a Reservation.
      properties:
        reservation:
          description: Information required for performing Advance Check In.
          $ref: '#/components/schemas/advanceCheckInReservationType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    resvForBatchCCAut:
      type: object
      description: Response which contains a listing of reservations, and associated payment methods, that require credit card authorization.
      properties:
        hotelId:
          $ref: '#/components/schemas/codeType'
        reservations:
          $ref: '#/components/schemas/reservationsForCCAuthType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomKeyOutBoundType:
      type: string
      description: Simple type for representing room key type.
      enum:
      - New
      - Duplicate
      - Lost
      - OneShot
      - RoomMove
      - ReEncode
      - Remove
      - ModifyStay
      - Read
    fixedChargeScheduleType:
      type: object
      description: Holds schedule of fixed charge.
      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
        frequency:
          description: Frequency of a fixed charge.
          $ref: '#/components/schemas/fixedChargeFrequencyType'
        dayToExecute:
          description: Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.
          type: string
          minLength: 0
          maxLength: 3
        dateToExecute:
          description: Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.
          type: string
          format: date
          maxLength: 8
    customChargeQuantityType:
      type: object
      description: Contains quantity of custom charge exemptions.
      properties:
        quantity:
          description: Contains number of Custom Charge Exemption for a day.
          type: integer
        available:
          description: Indicates if Custom Charges Exemption information is editable.
          type: boolean
    configPackageTransactionType:
      type: object
      description: A HotelPackageTransaction type.
      properties:
        allowance:
          description: Package is marked as an allowance, in case charge is expected back to the guest account from external interface eg. POS. which need to be offset against a consumption allowance.
          type: boolean
        currency:
          description: The currency code for this package.
          type: string
          minLength: 0
          maxLength: 20
        postingType:
          description: The posting frequency for this package, e.g., daily, arrival, departure, etc.
          type: string
          minLength: 0
          maxLength: 20
        calculationRule:
          description: The price calculation rule for this package.
          type: string
          minLength: 0
          maxLength: 80
        packagePostingRules:
          description: The package posting rule details.
          $ref: '#/components/schemas/packagePostingRulesType'
    linkedReservationType:
      type: string
      description: Enumeration of the different Linked Reservation Types.
      enum:
      - Linked
      - Shared
      - Default
    trxInfoType:
      type: object
      description: Transaction codes info.
      properties:
        description:
          description: Transaction codes info.
          type: string
          minLength: 0
          maxLength: 2000
        transactionGroup:
          description: Category of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        transactionSubGroup:
          description: Sub category of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        universalProductCode:
          description: Unique Universal product code of the transaction code.
          type: string
          minLength: 0
          maxLength: 20
        routingInstructionsId:
          description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.
          type: number
        articles:
          description: The List of Articles defined for this transaction code, when using the Articles functionality.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/articleInfoType'
        trxServiceType:
          description: Contains service type for transaction code.
          type: string
          minLength: 0
          maxLength: 20
        transactionCode:
          description: Unique identifier for the Transaction code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel context of the Transaction code.
          type: string
          minLength: 0
          maxLength: 20
        printTrxReceipt:
          description: Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.
          type: boolean
    roomKeyInterfaceRightType:
      type: object
      properties:
        rightsCode:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 80
        right:
          type: integer
    relationshipInfoSummaryType:
      type: object
      description: RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
      properties:
        relationshipProfile:
          description: Refer to Relationship Profile Summary type document.
          $ref: '#/components/schemas/relationshipProfileSummaryType'
        masterAccountDetails:
          description: Refer to Master Profile type document.
          $ref: '#/components/schemas/masterAccountInfoType'
        relationshipID:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        sourceRelation:
          description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 20
        sourceRelationDescription:
          description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetRelation:
          description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 20
        targetRelationDescription:
          description: Displays the description of the target relation(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
    callHistoryType:
      type: array
      description: Holds call information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/callType'
    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
    resAttachedProfileListType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resAttachedProfileType'
    eCertificateConsumptionType:
      type: object
      description: E-Certificates details.
      properties:
        hotelId:
          description: Property where certificate was consumed for.
          type: string
          minLength: 0
          maxLength: 20
        source:
          description: Source of consumption.
          $ref: '#/components/schemas/eCertificateConsumeSourceType'
        surname:
          description: Last name of the person who consumed the certificate..
          type: string
          minLength: 0
          maxLength: 40
        firstName:
          description: First name of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 40
        middleName:
          description: Middle name of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 40
        email:
          description: Email of the person who consumed the certificate.
          type: string
          minLength: 0
          maxLength: 2000
        date:
          description: Date the certificate was consumed.
          type: string
          format: date
          maxLength: 8
        userName:
          description: Application user who created the consumption.
          type: string
          minLength: 0
          maxLength: 2000
        userNotes:
          description: Any notes on the certificate entered at time of consumption.
          type: string
          minLength: 0
          maxLength: 4000
        referenceId:
          description: Any reference like reservation no etc against which the certificate was consumed.
          $ref: '#/components/schemas/uniqueID_Type'
        locationType:
          description: Consumption location type.
          type: string
          minLength: 0
          maxLength: 20
        authorizationCode:
          description: Authorization code for consumption.
          type: string
          minLength: 0
          maxLength: 100
        serviceDate:
          description: Date on which the service is due (arrival date in case of reservation).
          type: string
          format: date
          maxLength: 8
    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'
    relationshipProfileSummaryType:
      type: object
      properties:
        customerName:
          description: Name of the customer
          type: string
          minLength: 0
          maxLength: 40
        companyName:
          description: Name of the company.
          type: string
          minLength: 0
          maxLength: 40
        telephoneNumber:
          description: Telephone number assigned to a single location
          type: string
          minLength: 0
          maxLength: 40
        address:
          description: Information on address details for the customer/company
          $ref: '#/components/schemas/relationshipAddressType'
        emailAddress:
          description: Defines the e-mail address.
          type: string
          minLength: 0
          maxLength: 2000
        ownerCode:
          description: Unique Code to identify the owner.
          type: string
          minLength: 0
          maxLength: 20
        profileIdList:
          description: Original profile details for which the relationships was created
          $ref: '#/components/schemas/uniqueIDListType'
        primary:
          description: Indicates if this relationship is the primary relationship.
          type: boolean
        profileStatus:
          description: Status of the profile. Active/Inactive
          $ref: '#/components/schemas/profileStatusType'
        primaryOwnerCode:
          description: When true, this is a primary owner.
          type: boolean
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
    awardsType:
      type: array
      description: List of awards.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/awardType'
    ownerResTypeType:
      type: string
      enum:
      - Owner
      - AuthorizedUser
    rateChangeInstructionType:
      type: object
      description: Defines override rate type.
      properties:
        discount:
          description: Discount percentage and/or amount, code and textual reason for discount.
          $ref: '#/components/schemas/discountType'
        rateChange:
          description: Rate change type.
          $ref: '#/components/schemas/rateChangeType'
    givenNameType:
      type: string
      description: Given name, first name or names
      minLength: 0
      maxLength: 40
    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
    eCouponType:
      type: object
      description: Reservation eCoupon Type Information.
      properties:
        eCouponId:
          description: ECouponID to attach the eCoupon to Reservation.
          $ref: '#/components/schemas/uniqueID_Type'
        code:
          description: Code to attach the eCoupon to Reservation.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the eCoupon attached to the Reservation.
          type: string
          minLength: 0
          maxLength: 2000
        autoAttached:
          description: Determines whether the eCoupon is attached through the Rate Code or not.
          type: boolean
        issuedQuantity:
          description: Assigned Quantity for the eCoupon when attached to Reservation.
          type: integer
        usedQuantity:
          description: Used Quantity of the eCoupon for the Reservation.
          type: integer
        reason:
          description: Reason for attaching/modifing eCoupon.
          type: string
          minLength: 0
          maxLength: 4000
        ratePlanCode:
          description: Rate plan of the attached eCoupon to Reservation.
          type: string
          minLength: 0
          maxLength: 20
        welcomeOffer:
          description: Determines whether this eCoupon is eligible for welcome offer or not.
          type: boolean
    companyInfoType:
      type: object
      description: Company Information of the Profile.
      properties:
        legalCompany:
          description: Legal Company.
          type: string
          minLength: 0
          maxLength: 20
        department:
          description: Department of the Profile.
          type: string
          minLength: 0
          maxLength: 20
        position:
          description: Business Title or Position of the profile.
          type: string
          minLength: 0
          maxLength: 40
    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 of all payments on the guest ledger 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'
        totalDepositPaid:
          description: Total of all deposit payment posted to the reservation.
          $ref: '#/components/schemas/currencyAmountType'
    changedWakeUpCalls:
      type: object
      description: Response Body.
      properties:
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    imageSetType:
      type: object
      description: Represents on image set record.
      properties:
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        imageSet:
          description: The image set name.
          type: string
          minLength: 0
          maxLength: 800
        sequenceId:
          description: The image set sequence ID.
          type: integer
        imageStyle:
          description: The image set enumerated style.
          $ref: '#/components/schemas/imageStyleType'
        imageType:
          description: The image set type.
          type: string
          minLength: 0
          maxLength: 80
        hotelId:
          description: The image set hotel code.
          type: string
          minLength: 0
          maxLength: 20
        chainCode:
          description: The image set chain code.
          type: string
          minLength: 0
          maxLength: 20
        imageURL:
          description: The image set URL.
          type: string
          minLength: 0
          maxLength: 2000
        description:
          description: The image set description.
          type: string
          minLength: 0
          maxLength: 2000
        imageOrder:
          description: The image set order.
          type: integer
        website:
          description: The image set website.
          type: string
          minLength: 0
          maxLength: 2000
    customChargeExemptionDateType:
      type: object
      description: Contains Custom Charge Exemption information for a day.
      properties:
        date:
          description: Contains Custom Charge Exemption date.
          type: string
          format: date
          maxLength: 8
        quantity:
          description: Contains number of Custom Charge Exemption for a day.
          type: integer
    linkedReservationsInfoType:
      type: object
      description: Linked Reservations.
      properties:
        reservationInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/linkedReservationInfoType'
        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
    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'
    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
    exclusionReasonType:
      type: string
      description: Custom Charge has already been Processed for this date within the reservation stay.
      enum:
      - NotConfigured
      - CustomChargeProcessed
    messageType:
      type: object
      description: Holds the Message Information
      properties:
        messageText:
          description: Message Content
          type: string
          minLength: 0
          maxLength: 2000
        messageDate:
          description: Date the message was created
          type: string
          format: date-time
        typeOfMessage:
          description: Type of message (Voice/Text)
          $ref: '#/components/schemas/typeOfMessageType'
        recipient:
          description: Recipient of the Message
          type: string
          minLength: 0
          maxLength: 80
        operator:
          description: User who created the Message
          type: string
          minLength: 0
          maxLength: 40
    floorPlanType:
      type: object
      description: Floor information containing collection of Room records that contain Housekeeping and Out Of Order information.
      properties:
        rooms:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/floorPlanRoomType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        siteCode:
          type: string
          minLength: 0
          maxLength: 20
        siteDescription:
          type: string
    eCertificateUsageCriteriaType:
      type: object
      description: E-Certificates details.
      properties:
        reservation:
          description: Indicates if certificate is to be used against reservation or not.
          type: boolean
        web:
          description: Indicates if web certificate can be consumed in OWS.
          type: boolean
        webAllowed:
          description: Indicates if certificate consumption allowable on the web.
          type: boolean
        benefit:
          description: Indicates to attach a rate code to the e-certificate as a benefit.
          type: boolean
        hotel:
          description: Indicates if web certificate can be consumed in hotel.
          type: boolean
        verifyCertificateNo:
          description: Specify if the certificate number verification is required at time of consumption or not.
          type: boolean
        cancelAllowed:
          description: Identify if cancel is allowed or not.
          type: boolean
        generateInLieuCertificate:
          description: Identify if in lieu of certificate can be generated or not.
          type: boolean
    alienInfoType:
      type: object
      description: immigration/visa information of a foreign person.
      properties:
        alienRegistrationNo:
          description: Alien Registration Number.
          type: string
        immigrationStatus:
          description: Immigration Status on an Alien.
          type: string
          minLength: 0
          maxLength: 40
        visaValidityType:
          description: Visa Type of an Alien.
          type: string
          minLength: 0
          maxLength: 40
    requestType:
      type: string
      description: Simple type for representing request type.
      enum:
      - R1
      - R2
      - R3
      - R4
    eCouponsType:
      type: array
      description: Collection of ECouponType object.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/eCouponType'
    currentRoomInfoType:
      type: object
      description: Room information of the reservation for the current day.
      properties:
        roomType:
          description: Current room type.
          type: string
          minLength: 0
          maxLength: 20
        roomId:
          description: Current room number.
          type: string
          minLength: 0
          maxLength: 20
        roomOwnershipType:
          description: Provides the information of the assigned reservation room is an Owner,Referral or Regular room. This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation.
          $ref: '#/components/schemas/reservationRoomOwnershipType'
        suggestedRoomNumbers:
          description: Suggested room numbers.
          $ref: '#/components/schemas/codeListType'
        roomDescription:
          description: Current room description.
          type: string
          minLength: 0
          maxLength: 2000
        roomViewCode:
          description: Represents the room view code like City view, River view, Ocean view etc.
          type: string
          minLength: 0
          maxLength: 40
        assignedByAI:
          description: Represents the room was assigned by AI Room Assignment.
          type: boolean
        upgradedByAI:
          description: Represents the room was upgraded by AI Room Assignment.
          type: boolean
    floorPlanRoomType:
      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'
        accessible:
          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'
        componentRoomNumbers:
          description: List of component room numbers.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        guests:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/floorPlanRoomGuestType'
      description: This type represents the primary room attributes.
    typeOfMessageType:
      type: string
      description: The type of Message for Guest Messages.
      enum:
      - Tm
      - Vm
    queueRoomsTextCriteriaType:
      type: object
      description: Text message criteria type, used to deliver a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).
      properties:
        hotelId:
          description: Resort context of the text message.
          type: string
          minLength: 0
          maxLength: 20
        reservationId:
          description: Reservation ID, necessary if the text message will be delivered based on a queued reservation.
          $ref: '#/components/schemas/uniqueID_Type'
        mobileNumber:
          description: Mobile number that the text message will be delivered to.
          type: string
          minLength: 0
          maxLength: 40
        messageType:
          description: Type of text message to be delivered.
          $ref: '#/components/schemas/queueRoomsTextMessageType'
    compAuthorizerInfoType:
      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
    rateRangeType:
      type: object
      description: Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
      properties:
        base:
          description: The base amount charged for the accommodation or service.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/totalType'
        rateChange:
          description: Rate Change Indicator.
          type: boolean
    confirmationStyle:
      type: object
      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
        style:
          description: Name of the confirmation letter style.
          type: string
    amountType:
      type: object
      description: Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.
      properties:
        base:
          description: 'The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.'
          $ref: '#/components/schemas/totalType'
        additionalGuestAmounts:
          description: Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/additionalGuestAmountType'
        discount:
          description: Discount percentage and/or Amount, code and textual reason for discount
          $ref: '#/components/schemas/discountType'
        shareRatePercentage:
          description: Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.
          type: number
          minimum: 0
          maximum: 100
        shareDistributionInstruction:
          description: Last rate share distribution instruction applied on share reservation daily rate segment.
          $ref: '#/components/schemas/shareDistributionInstructionType'
        total:
          description: The total amount charged for this rate including additional occupant amounts and fees.
          $ref: '#/components/schemas/totalType'
        requiredPoints:
          description: The Points contains the number of points required to book a particular room type.
          $ref: '#/components/schemas/pointsType'
        effectiveRate:
          description: The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time
          $ref: '#/components/schemas/totalType'
        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
    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
    eCertificateIssueSourceType:
      type: string
      description: Indicates that OPERA E-Certificate is issued by external system.
      enum:
      - Opera
      - Web
      - Interface
    batchCCAuth:
      type: object
      description: Request to start a batch job that will process a list of reservation, and their associated payment methods, that require credit card authorizations.
      properties:
        hotelId:
          $ref: '#/components/schemas/codeType'
        reservations:
          $ref: '#/components/schemas/reservationsForCCAuthType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    serviceRequestsInfo:
      type: object
      description: Response object for service requests.
      properties:
        serviceRequestsDetails:
          description: List of service requests.
          $ref: '#/components/schemas/serviceRequests'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    guestMessageType:
      type: object
      description: Holds the Message information for a Reservation
      properties:
        message:
          description: Holds the Message Information
          $ref: '#/components/schemas/messageType'
        delivery:
          description: Holds the Delivery Method Information
          $ref: '#/components/schemas/messageDeliveryType'
        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
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    compRoutingRequestType:
      type: object
      description: Type for the details of a Comp Routing Request
      properties:
        requestedBy:
          description: User who requested the Comp Routing
          $ref: '#/components/schemas/userInfoType'
        comments:
          type: string
          minLength: 0
          maxLength: 2000
        declinedBy:
          description: User information of user who declined comp routing request
          $ref: '#/components/schemas/userInfoType'
        status:
          description: Comp routing status
          $ref: '#/components/schemas/compRoutingStatusType'
    excludedDatesType:
      type: array
      description: Contains list of dates which are valid for custom charge exemptions.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/excludedDateType'
    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
    profileNameType:
      type: object
      description: This provides name information for a person.
      properties:
        name:
          description: Family name, last name or Company Name.
          type: string
          minLength: 0
          maxLength: 40
        fullName:
          description: Full display Name.
          type: string
          minLength: 0
          maxLength: 200
        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
        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
        nameType:
          description: Type of name of the individual, such as former, nickname, alternate or alias name.
          $ref: '#/components/schemas/personNameTypeType'
    traceTimeInfoType:
      type: object
      properties:
        dateTimeSpan:
          description: Time span for the trace.
          $ref: '#/components/schemas/dateTimeSpanType'
        traceOn:
          description: Date of the trace.
          type: string
          format: date-time
        traceTime:
          description: Time of the trace
          type: string
          minLength: 0
          maxLength: 20
        enteredBy:
          description: User that entered this trace.
          type: string
    roomOccupancyInfoType:
      type: object
      description: Information about room's recent and upcoming stays to help determine vacancy history and future occupancy.
      properties:
        vacantDays:
          type: integer
          description: Number of nights since this room was last occupied.
        lastStayDate:
          type: string
          format: date
          description: Departure date of the last stay, in the property's date format.
        nightsToNextStay:
          type: integer
          description: Number of nights until the next scheduled arrival in the room or room is in Out of Order / Out of Service status. Included only if 'includeNextStayInfo=true' is passed in request.
        nextStayDate:
          type: string
          format: date
          description: Date of the next scheduled arrival in the room or the room is in Out of Order / Out of Service status, in the property's date format. Included only if 'includeNextStayInfo=true' is passed in request.
    stayReservationInfoType:
      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'
        roomStay:
          description: Collection of room stays.
          $ref: '#/components/schemas/stayInfoType'
        attachedProfiles:
          description: List of attached profiles
          $ref: '#/components/schemas/resAttachedProfileListType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        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'
    mailingActionsType:
      type: object
      description: Defines mailing action list for the profile.
      properties:
        mailingAction:
          description: Defines mailing action code and description.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/codeDescriptionType'
        active:
          description: When true indicates that profile has subscribed to the mailing list.
          type: boolean
        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
    roomKeyExternal:
      type: object
      description: Request for generation of room key used for OutBound.
      properties:
        encoderId:
          type: string
          description: Unique Id as defined by Door Lock System.
          minLength: 1
          maxLength: 2000
        encoderTerminal:
          type: string
          description: The Unique PMS encoder name linked with the encoderId
          minLength: 1
          maxLength: 2000
        roomId:
          description: The PMS room number to generate a key for.
          type: string
          maxLength: 2000
        oldRoomId:
          description: Old Room Number is used when a room move (keyType RoomMove) is performed.
          type: string
          maxLength: 2000
        noOfKeys:
          type: integer
          description: Number of keys to be created.The value is always 1
          minimum: 1
          maximum: 1
          default: 1
        reservationIdList:
          description: Collection of unique reservation identifiers for the reservation we are trying to make a room key for.
          $ref: '#/components/schemas/uniqueIDListType'
        guestShareFlag:
          type: boolean
          description: Indicates if Guest is a sharer or not
        OldGuestShareFlag:
          type: boolean
          description: Indicates if old Guest room is a sharer or not when a room move (keyType RoomMove) is performed.
        keyOptions:
          type: string
          maxLength: 2000
          description: Lists the access areas defined in PMS valid for the room key.
        keyValidityStart:
          type: string
          description: The date/time the room key is valid from.
          format: date-time
        keyValidityEnd:
          type: string
          description: The date/time the room key is valid to.
          format: date-time
        keyType:
          $ref: '#/components/schemas/roomKeyOutBoundType'
        keyTrack:
          description: KeyTrack Data.
          $ref: '#/components/schemas/keyTrackType'
        outBoundCode:
          description: OutBound Code of the Door Lock System (DLS).
          type: string
        additionalRooms:
          description: Collection of additional rooms to be included in key creation of reservation room.
          type: array
          maxItems: 999
          items:
            type: string
            minLength: 0
            maxLength: 20
        oldAdditionalRooms:
          description: Collection of old additional rooms in key creation of reservation room when a room move (keyType RoomMove) is performed.
          type: array
          maxItems: 999
          items:
            type: string
            minLength: 0
            maxLength: 20
        userId:
          type: string
          description: Unique identifier for the PMS user.
          maxLength: 2000
        requestType:
          $ref: '#/components/schemas/requestType'
        roomKeyGuests:
          type: array
          description: Collection of of Room key guests for multiple guest room key functionality.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomKeyGuest'
      required:
      - keyType
      - encoderTerminal
      - encoderId
    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
    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
    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
    hotelReservationTracesType:
      type: array
      description: List of Reservation Traces.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/hotelReservationTraceType'
    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
    profileStatusType:
      type: string
      enum:
      - Active
      - Inactive
    visaInfoType:
      type: object
      properties:
        visaIssueDate:
          type: string
          format: date
          maxLength: 8
        visaExpiryDate:
          type: string
          format: date
          maxLength: 8
        visaNumber:
          type: string
          minLength: 0
          maxLength: 40
    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'
    billingInstructionsType:
      type: array
      description: Set of Billing Instruction codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/billingInstructionType'
    blockResvSummaryType:
      type: object
      description: Indicates summary of the Total reservations for the block.
      properties:
        totalReservations:
          description: Number of reservations with block.
          type: integer
    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
    depositPolicyType:
      type: object
      description: Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
      properties:
        amountPercent:
          description: Payment expressed as a fixed amount, or a percentage of/or room nights.
          $ref: '#/components/schemas/policyAmountPercentType'
        deadline:
          description: Payment deadline, absolute or relative.
          $ref: '#/components/schemas/policyDeadlineType'
        description:
          description: Text description of the Payment in a given language.
          type: string
          minLength: 0
          maxLength: 2000
        depositReceiptNo:
          description: Receipt number associated with the deposit policy
          type: integer
        transactionDate:
          description: Transaction Date associated with the deposit policy
          type: string
          format: date
          maxLength: 8
        depositReqReversed:
          description: Flag to indicate if deposit policy is reversed
          type: boolean
        formattedRule:
          description: Formatted Text Rule of the deposit policy.
          type: string
          minLength: 0
          maxLength: 2000
        typeOfCharges:
          description: Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both
          $ref: '#/components/schemas/depositCancelRevenueType'
        policyCode:
          description: Deposit Policy Code
          type: string
          minLength: 0
          maxLength: 20
        manual:
          description: Flag to indicate if the cancellation policy is manual.
          type: boolean
    commissionPayoutToType:
      type: string
      enum:
      - TravelAgent
      - Source
      - TravelAgentSource
      - None
    childAgesType:
      type: array
      description: Age of a child in years.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/childAgeType'
    housekeepingType:
      type: object
      description: Identifies the Housekeeping information.
      properties:
        roomStatus:
          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'
    ticketType:
      type: object
      description: Reservation Ticket Type Information.
      properties:
        ticketId:
          description: Internal Unique ID.
          $ref: '#/components/schemas/uniqueID_Type'
        packageCode:
          description: Package Code.
          type: string
          minLength: 0
          maxLength: 20
        reservationProductId:
          description: Reference to the reservation product.
          $ref: '#/components/schemas/uniqueID_Type'
        ticketNumber:
          description: Ticket number.
          $ref: '#/components/schemas/uniqueID_Type'
        description:
          description: Package description.
          type: string
          minLength: 0
          maxLength: 2000
        issueDate:
          description: Tickets issue date.
          type: string
          format: date
          maxLength: 8
        price:
          description: Tickets price.
          type: number
        consumptionDate:
          description: Tickets comsumption date.
          type: string
          format: date
          maxLength: 8
        rateCode:
          description: The Rate Code to which tickets belong to.
          type: string
          minLength: 0
          maxLength: 20
        quantity:
          description: Number of tickets used to create multiple tickets.
          type: integer
        reference:
          description: Free text field for reference information.
          type: string
          minLength: 0
          maxLength: 2000
        status:
          description: The Status Code for outbound WS call.
          type: string
          minLength: 0
          maxLength: 20
        statusDescription:
          description: The Status Description for outbound WS call.
          type: string
          minLength: 0
          maxLength: 2000
    changeHistoryType:
      type: object
      description: Creation date time, Creator Id, last modification date time and last Modifier Id.
      properties:
        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
    rateByAgeBucketsType:
      type: array
      description: Rate amount by age bucket.
      maxItems: 3
      items:
        $ref: '#/components/schemas/rateByAgeBucketType'
    activityLog:
      type: object
      description: Fulfillment activity log response.
      properties:
        activityLogDetails:
          description: List of activity log entries.
          $ref: '#/components/schemas/activityLogListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    lastStayInfoType:
      type: object
      description: Contains last stay related details for the profile
      properties:
        lastVisit:
          description: Used to hold last stay information for the profile.
          type: string
          format: date
          maxLength: 8
        lastRoom:
          description: Used to hold last room information for the profile.
          type: string
        lastRate:
          description: Used to hold last rate information for the profile.
          $ref: '#/components/schemas/currencyAmountType'
        totalStay:
          description: The total number of previous stay of the profile.
          type: integer
    rewardCertificateType:
      type: string
      description: Point Saver reward.
      enum:
      - Regular
      - StayAnytime
      - PointSaver
    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
    backToBackResSequenceType:
      type: object
      description: Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.
      properties:
        position:
          description: Indicates the Sequence position of Back to Back Reservation.
          type: integer
        totalCount:
          description: Indicates the total count of Back To Back Reservations in the group of Linked Reservations.
          type: integer
    batchCCAuthReservationStatusType:
      type: string
      description: reservation statuses for credit card authorizations
      enum:
      - CheckedIn
      - InHouse
      - Arrival
      - Reserved
    profileSharedLevelType:
      type: string
      description: Simple types for Shared level.
      enum:
      - Global
      - Property
      - Cro
    reservationFolioWindowsType:
      type: array
      description: Collection of reservation folio windows.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationFolioWindowType'
    prepaidCardTransactionType:
      type: object
      description: Prepaid Card transaction.
      properties:
        transactionType:
          description: Transaction type enumeration.
          $ref: '#/components/schemas/prepaidCardTrxTypeType'
        transactionDate:
          description: Transaction number of the Prepaid card transaction.
          type: string
          format: date
          maxLength: 8
        transactionNo:
          description: Transaction number of the Prepaid card transaction.
          type: number
        amount:
          description: Prepaid Card Amount.
          $ref: '#/components/schemas/currencyAmountType'
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    activityList:
      type: array
      description: A collection of Activity objects.
      maxItems: 4000
      items:
        type: object
        properties:
          activityIds:
            description: A collection of reference ID values that identify this uniquely scheduled activity instance. May contain one ID per external system plus an internal identifier.
            $ref: '#/components/schemas/uniqueIDListType'
          type:
            description: 'The Type of the activity. Eg: SPA, Golf etc.'
            type: string
          location:
            description: 'The Location where the activity takes place. Eg: Salon'
            type: string
          name:
            description: Name of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons
            type: array
            maxItems: 4000
            items:
              type: string
              minLength: 0
              maxLength: 200
          numberOfPersons:
            description: The total number of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons
            type: integer
          timeSpan:
            description: The time with-in which an activity falls (Starts/Ends/Spans)
            $ref: '#/components/schemas/dateTimeSpanType'
          duration:
            description: The time span of the activity falls
            $ref: '#/components/schemas/dateTimeSpanType'
          description:
            description: Description of the activity
            type: array
            maxItems: 4000
            items:
              type: string
              minLength: 0
              maxLength: 2000
          note:
            description: Any additional notes or comments regarding the scheduled activity.
            type: array
            maxItems: 4000
            items:
              type: string
              minLength: 0
              maxLength: 2000
          groupCode:
            description: Any Block code associated with the activity if its a Group booking.
            type: string
          amount:
            description: The amount charged for the activity.
            $ref: '#/components/schemas/currencyAmountType'
          deposit:
            description: A monetary value expressed with a currency code.
            type: object
            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
              collectedBy:
                type: string
                enum:
                - Vendor
                - Agent
                - Other
          inactiveDate:
            description: The Date by which the activity is deemed Cancelled/Deleted.
            type: string
            format: date-time
          participants:
            description: The names of the participants.
            type: array
            maxItems: 4000
            items:
              $ref: '#/components/schemas/personNameType'
          uRLLink:
            description: The URL link to launch the Activity Reservation System to view or edit full details of this activity.
            type: string
          extensions:
            description: Vendor extensions to the activity record.
            type: array
            maxItems: 4000
            items:
              type: string
          status:
            description: Activity reservation status. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.
            type: string
          statusDescription:
            description: Activity reservation status description. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.
            type: string
          link:
            description: When true indicates that activity link only needs to be inserted or deleted for this record.
            type: boolean
        description: Represents a single instance of a scheduled activity.
    roomConditionAssigmentType:
      type: string
      description: Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.
      enum:
      - Available
      - NotAvailable
    packageCodeHeaderType:
      type: object
      properties:
        primaryDetails:
          description: Package code header primary details.
          $ref: '#/components/schemas/configPackagePrimaryDetailsType'
        transactionDetails:
          description: Package code header transaction information.
          $ref: '#/components/schemas/configPackageTransactionType'
        postingAttributes:
          description: Package code posting attributes.
          $ref: '#/components/schemas/configPostingAttributesType'
        usageDetails:
          description: Package code usage information.
          $ref: '#/components/schemas/configPackageUsageDetailType'
    resAccessRestrictionType:
      type: string
      description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
      enum:
      - Change
      - Cancel
      - ChangeOrCancel
    commentInfoType:
      type: object
      description: Comment related to the profile/reservation.
      properties:
        comment:
          description: Comment details for the comment. It will be empty in case of delete comment.
          $ref: '#/components/schemas/commentType'
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
        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
    nameValuesType:
      type: array
      description: List of name value pairs.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/nameValueType'
    reservationIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    routingInfoType:
      type: object
      description: A routing info object can either be of type Folio OR of type Room with its corresponding object.
      properties:
        folio:
          description: Folio routing type.
          type: object
          properties:
            guestInfo:
              description: Guest details
              type: object
              properties:
                profileIdList:
                  description: Unique identifiers for the Profile for both internal and external systems.
                  $ref: '#/components/schemas/profileIdList'
            payeeInfo:
              $ref: '#/components/schemas/payeeInfoType'
            aRNumber:
              description: Accounts Receivable.
              type: string
              minLength: 0
              maxLength: 20
            instructions:
              description: Set of routing instructions associated to this routing type.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/routingInstructionType'
            folioWindowNo:
              type: integer
            paymentMethod:
              type: string
              maxLength: 2000
        room:
          description: Room routing type.
          type: object
          properties:
            roomId:
              description: Room number to route the instructions.
              type: string
              minLength: 0
              maxLength: 20
            guestNameId:
              description: Guest unique identifier to which the instruction will be routed.
              $ref: '#/components/schemas/uniqueID_Type'
            guestDisplayName:
              description: Display Name for the guest.
              type: string
              minLength: 0
              maxLength: 80
            reservationNameId:
              description: Reservation name id to which the instruction will be routed.
              $ref: '#/components/schemas/uniqueID_Type'
            instructions:
              description: Set of routing instructions associated to this routing type.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/routingInstructionType'
        comp:
          description: Comp Accounting Routing Info
          type: object
          properties:
            compAccountingInfo:
              $ref: '#/components/schemas/compAccountingType'
            compRequestInfo:
              $ref: '#/components/schemas/compRoutingRequestType'
            payeeInfo:
              $ref: '#/components/schemas/payeeInfoType'
            instructions:
              description: Set of routing instructions associated to this routing type.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/routingInstructionType'
            folioWindowNo:
              type: integer
        request:
          description: Comp Accounting Request routing
          type: object
          properties:
            compRequestInfo:
              $ref: '#/components/schemas/compRoutingRequestType'
            instructions:
              description: Set of routing instructions associated to this routing type.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/routingInstructionType'
        refreshFolio:
          description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions.
          type: boolean
    directBillingType:
      type: object
      description: This is the preconfigured routing instruction type.
      properties:
        hotelId:
          description: Hotel Code for which the details of direct billing is provided for a profile.
          type: string
          minLength: 0
          maxLength: 20
        aRNumber:
          description: Hotel Code for which the details of direct billing is provided for a profile.
          type: string
          minLength: 0
          maxLength: 20
    eCertificateStatusType:
      type: string
      description: Indicates that OPERA E-Certificate is reserved.
      enum:
      - Cancelled
      - Consumed
      - Deleted
      - Expired
      - Issued
      - Reserved
    alertsType:
      type: array
      description: List of alerts.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/alertType'
    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
    eCertificateScopeType:
      type: string
      description: Indicates that OPERA E-Certificate is available for a specific list of hotels.
      enum:
      - Global
      - Hotel
      - MultiHotel
    actionStatusType:
      type: string
      description: Action status of the Track It item(Open, Closed, InProgress).
      enum:
      - Open
      - Closed
      - InProgress
    gdsNegotiatedInfoType:
      type: object
      description: This provides information for a channel negotiated rate.
      properties:
        accessCode:
          description: The GDS negotiated rate code.
          type: string
          minLength: 0
          maxLength: 20
        order:
          description: The sell order.
          type: integer
        inactive:
          description: The GDS Negotiated Rate is inactive or not
          type: boolean
        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
    thresholdDetailsType:
      type: object
      description: Type for the threshold elements.
      properties:
        entity:
          description: Diversion entity type associated with the charge for the transaction diversion rule .
          $ref: '#/components/schemas/entityType'
        scope:
          description: Diversion scope for the transaction diversion rule.
          $ref: '#/components/schemas/scopeType'
        minRequired:
          description: Minimum required number of quantities, counts or minutes that must be posted.
          type: integer
        complimentary:
          description: The number of quantities, counts or minutes for which transaction diversion is allowed .
          type: integer
        isEditable:
          description: Configuring this flag to be TRUE will make the thresholds editable.
          type: boolean
    roomKeyEncodersType:
      type: array
      description: Holds the key encoder right.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomKeyEncoderType'
    billingInstructionType:
      type: object
      description: Configured Billing Instruction which represents a set of Transaction Codes.
      properties:
        desc:
          description: Billing Instruction code description.
          type: string
          minLength: 0
          maxLength: 2000
        routingInstructionsId:
          description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.
          type: number
        billingCode:
          description: Unique identifier for the Billing Instruction.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel context of the Billing Instruction.
          type: string
          minLength: 0
          maxLength: 20
    eCertificateGenerationType:
      type: object
      description: E-Certificates details.
      properties:
        ruleId:
          description: Key to identify the generation rule id.
          $ref: '#/components/schemas/uniqueID_Type'
        generationDetail:
          description: Reason for which e-certificate was generated.
          type: string
          minLength: 0
          maxLength: 4000
        referenceValue:
          description: Type of value that is in the certificate.valid values are membership_level.
          type: string
          minLength: 0
          maxLength: 20
    resInventoryItemSourceType:
      type: object
      description: Defines whether the item is setup due to a Rate Plan, Package or a Block.
      properties:
        ratePlanCode:
          description: Rate Plan Code, If populated specifies that the item is setup due to a Rate Plan.
          type: string
          minLength: 0
          maxLength: 20
        packageCode:
          description: Package Code, If populated specifies that the item is setup due to a Package.
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          description: Block Unique ID, If populated specifies that the item is setup due to a Block.
          $ref: '#/components/schemas/blockId'
        welcomeOffer:
          description: If true, it implies that the item has been attached to the reservation as part of a Welcome Offer
          type: boolean
        packageInternalID:
          description: Source Reservation Package Opera Internal Unique Id. This is the unique Id used for the reservation package associated with this item.
          type: number
    assignedRoomsSummaryType:
      type: object
      description: Indicates summary of the assigned rooms.
      properties:
        count:
          description: Number of reservations with assigned rooms.
          type: string
          minLength: 4
          maxLength: 4
    eCertificatesType:
      type: array
      description: List of e-certificates for the profile.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/eCertificateType'
    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
    keywordType:
      type: object
      properties:
        keywordDetail:
          description: The keyword new value, in case keyword value is modified.
          $ref: '#/components/schemas/keywordDetailType'
        type:
          description: The type of keyword
          type: string
          minLength: 0
          maxLength: 20
        keyword:
          description: The keyword value.
          type: string
          minLength: 0
          maxLength: 80
    childBucketsType:
      type: object
      description: Defines children counts with Age Qualifying Group(Child Bucket) classification.
      properties:
        bucket1Count:
          description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
          type: integer
        bucket2Count:
          description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
          type: integer
        bucket3Count:
          description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
          type: integer
        bucket4Count:
          description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
          type: integer
        bucket5Count:
          description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
          type: integer
    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'
    rateChangeType:
      type: string
      description: Simple type for rate change type.
      enum:
      - Verify
      - OldRate
      - NewRate
    profileTaxInfoType:
      type: object
      description: Profile information related to tax.
      properties:
        tax1No:
          description: The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.
          type: string
          minLength: 0
          maxLength: 40
        tax2No:
          description: Tax 2 id of this profile.
          type: string
          minLength: 0
          maxLength: 40
        taxCategory:
          description: Tax Category to be changed.
          type: string
          minLength: 0
          maxLength: 20
        taxOffice:
          description: Tax Office to be changed.
          type: string
          minLength: 0
          maxLength: 30
        taxType:
          description: Tax type to be changed.
          type: string
          minLength: 0
          maxLength: 20
        businessId:
          description: Business ID. The maximum length of this element should not exceed 120 characters.
          type: string
          minLength: 0
          maxLength: 128
        businessRegistration:
          description: Business Registration Code. The maximum length of this element should not exceed 120 characters.
          type: string
          minLength: 0
          maxLength: 128
    reservationTransactionDiversionType:
      type: object
      description: A Transaction Diversion Rule Type
      properties:
        vipCode:
          description: VIP code to consider while applying Diversion Instruction.
          type: string
          minLength: 0
          maxLength: 20
        membership:
          description: Membership type to consider while applying Diversion Instruction.
          $ref: '#/components/schemas/membershipTypeLevelType'
        targetRoom:
          description: Room number to receive all the diverted transactions configured for this instruction.
          type: string
          minLength: 0
          maxLength: 20
        transactionCodes:
          description: Collection of Transaction Code List
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/codeDescriptionType'
        description:
          description: User defined message for the Transaction Diversion Rule.
          type: string
          minLength: 0
          maxLength: 2000
        level:
          description: Level of the Transaction Diversion rule that can be Property or Reservation.
          $ref: '#/components/schemas/transactionDiversionRuleLevelType'
        thresholds:
          description: Threshold Details related to the Transaction diversion rule.
          $ref: '#/components/schemas/thresholdDetailsType'
        type:
          description: Transaction Diversion Rule Types
          $ref: '#/components/schemas/transactionDiversionRuleTypeType'
        hotelId:
          description: Hotel code with which Transaction Diversion Rule is associated.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Transaction Diversion Code
          type: string
          minLength: 0
          maxLength: 20
        displaySequence:
          description: User configured Sequence number.
          type: number
        inactive:
          description: Indicator that tells whether the transaction diversion rule is active or not.
          type: boolean
        notes:
          description: The Note details related to the Transaction Diversion Rule.
          $ref: '#/components/schemas/commentInfoType'
        posted:
          description: Transaction diversions that are posted.
          type: integer
        diverted:
          description: Transaction diversions that are diverted .
          type: integer
        dailyDetails:
          description: Collection of daily details of a Transaction diversion rule for a particular reservation.
          $ref: '#/components/schemas/transactionDiversionDailyDetailsType'
    resInventoryItemsType:
      type: object
      description: Defines a collection of inventory items attached to a reservation.
      properties:
        item:
          description: Inventory item attached to a reservation.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/resInventoryItemType'
        itemClassCode:
          description: The Item Class ID which the item belongs to.
          type: string
          minLength: 0
          maxLength: 20
    shortReservation:
      type: object
      properties:
        reservationInfoList:
          description: Short reservation information response.
          type: array
          items:
            $ref: '#/components/schemas/reservationInfoType'
        reservationsSummary:
          description: Collection of Reservations summary and their information.
          $ref: '#/components/schemas/reservationsSummaryType'
        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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roleUserEntryType:
      type: object
      description: Role or User in which the log book entry belongs to.
      properties:
        role:
          $ref: '#/components/schemas/codeDescriptionType'
        user:
          type: string
          minLength: 0
          maxLength: 60
    profileRoutingInstructionsType:
      type: object
      description: The type contains routing instructions for the profile.
      properties:
        transactionCodes:
          description: Set of preconfigured transaction codes.
          $ref: '#/components/schemas/trxCodesInfoType'
        billingInstructions:
          description: Set of preconfigured Billing Instruction results.
          $ref: '#/components/schemas/billingInstructionsType'
        autoPopulateRouting:
          description: A flag which determines whether the instructions has to be automatically populated for this profile or not.
          type: boolean
    roomRateType:
      type: object
      properties:
        total:
          $ref: '#/components/schemas/totalType'
        totalPoints:
          $ref: '#/components/schemas/pointsType'
        rates:
          $ref: '#/components/schemas/ratesType'
        packages:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/packageElementType'
        stayProfiles:
          description: Profile associated with the room Stay.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationProfileType'
        guestCounts:
          description: A collection of Guest Counts associated with the room rate.
          $ref: '#/components/schemas/guestCountsType'
        taxFreeGuestCounts:
          description: A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.
          $ref: '#/components/schemas/guestCountsType'
        awards:
          description: Membership Awards code applied on the reservation.
          $ref: '#/components/schemas/resAwardsType'
        foreignExchange:
          description: Exchange Type information for the postings.
          $ref: '#/components/schemas/foreignExchangeType'
        reservationBlock:
          description: Key information about the block for this reservation.
          $ref: '#/components/schemas/reservationBlockType'
        roomRateInfo:
          description: Information about the Room Rate Combination.
          type: string
          minLength: 0
          maxLength: 2000
        mealPlans:
          description: Meal plan codes for rate plan code.
          $ref: '#/components/schemas/mealPlansType'
        roomType:
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          type: string
          minLength: 0
          maxLength: 20
        promotionCode:
          type: string
          minLength: 0
          maxLength: 20
        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
        availability:
          description: Used to specify an availability status for the room rate. When available value could be either not specified or "Available".
          $ref: '#/components/schemas/roomRateAvailReasonType'
        suppressRate:
          type: boolean
        marketCode:
          description: The code that relates to the market being sold to (e.g., the corporate market, packages).
          type: string
          minLength: 0
          maxLength: 20
        marketCodeDescription:
          description: Description of the market code.
          type: string
          minLength: 0
          maxLength: 4000
        sourceCode:
          description: To specify where the business came from e.g. radio, newspaper ad, etc.
          type: string
          minLength: 0
          maxLength: 20
        sourceCodeDescription:
          description: Description of the source of business.
          type: string
          minLength: 0
          maxLength: 4000
        numberOfUnits:
          description: The number of rooms.
          type: integer
        roomId:
          description: A string value representing the unique identification of a room.
          type: string
          minLength: 0
          maxLength: 20
        pseudoRoom:
          description: True indicates as pseudo room type. This is usually used for a posting master reservation.
          type: boolean
        roomTypeCharged:
          description: Room Type used for the Rate calculation.
          type: string
          minLength: 0
          maxLength: 20
        commissionCode:
          description: Commission Code applicable for commission calculation for Travel Agent/Company.
          type: string
          minLength: 0
          maxLength: 20
        commissionable:
          description: Indicates Commission is applicable for commission calculation for Travel Agent/Company.
          type: boolean
        houseUseOnly:
          description: Indicates this reservation is for House use.
          type: boolean
        complimentary:
          description: Indicates this reservation rate is complimentary.
          type: boolean
        inventoryLender:
          description: Indicates whether the room type inventory was taken from the allotment or House availability.
          type: string
        fixedRate:
          description: Fixed Rate Indicator.
          type: boolean
        barRanking:
          description: Best Available rates ranking.
          type: integer
        rateGroup:
          description: For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.
          type: string
          minLength: 0
          maxLength: 20
        discountAllowed:
          description: Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.
          type: boolean
        bogoDiscount:
          description: Indicates if the Rate Code has BOGO(Bye one Get one) indicator.
          type: boolean
        rateLevel:
          description: Rate plan type like Corporate,Regular,Military,Weekend etc.
          type: string
          minLength: 0
          maxLength: 20
        commissionPercentage:
          description: Indicates commission percentage used by the rate plan.
          type: integer
        commissionAmount:
          description: Indicates commission amount used by the rate plan.
          type: integer
        credentialsRequired:
          description: If true, indicates that credentials is required to sell the rate code.
          type: boolean
        taxIncluded:
          description: If true, indicates if tax is included in the rate code.
          type: boolean
        rateDescription:
          description: Rate code description.
          type: string
          minLength: 0
          maxLength: 4000
    reservationRoomSelectionType:
      type: object
      description: Defines search criteria needed to configure a room to a reservation.
      properties:
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        reservationIdList:
          $ref: '#/components/schemas/reservationIdList'
        roomId:
          description: Room identifier which the reservation will hold.
          type: string
          minLength: 0
          maxLength: 20
        overrideInstructions:
          description: If this element is present, override flags will be set when configuring the room to the reservation.
          $ref: '#/components/schemas/reservationRoomSelectionOverrideType'
        includedBackToBack:
          description: This list contains the Reservation IDs of the Back to Back Reservations that will be assigned to the same room. Back to Back Reservation functionality is available when the Back to Back Handling of Linked Reservations OPERA Control is active.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationIdList'
        includedSharers:
          description: Valid share reservation identifier.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationIdList'
        updateRoomTypeCharged:
          description: Update the Room Type used for the Rate calculation.
          type: boolean
        includeDepartureRooms:
          description: Indicates if departure rooms are to be included for room assignment.
          type: boolean
        ignoreMoveOutRooms:
          description: Indicates if scheduled move out rooms are to be ignored for room assignment.Scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.
          type: boolean
        roomNumberLocked:
          description: Update the do not move flag used to locking the reservation room number.
          type: boolean
        orderBy:
          description: When Forecast Rotation is checked, future reservation's point calculation will be considered while determing the room order for the assignment.
          $ref: '#/components/schemas/hotelRoomsOrderBy'
        scheduledRoomSegmentNumber:
          description: Indicates the Room Segment number the room is assigned to.
          type: number
        roomSegmentBeginDate:
          type: string
          description: Defines the start date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.
          format: date
        roomSegmentEndDate:
          type: string
          description: Defines the end date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.
          format: date
        applyUntilLastShareDepartureDate:
          description: Indicates whether the chosen Room changes will be made not only to overlapping dates of share reservations but also to non-overlapping dates after the departure date of the edited reservation. When false or omitted the chosen changes are applied only to overlapping dates of share reservations.
          type: boolean
        comments:
          description: Additional notes or remarks about the room assignment, such as room selection, special requests or issues encountered that can be used for AI-driven insights, such as sentiment analysis or predictive modeling.
          type: string
          minLength: 0
          maxLength: 4000
    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
    roomKeyType:
      type: string
      description: Simple type for representing room key type.
      enum:
      - New
      - Duplicate
      - Lost
      - OneShot
      - RoomMove
      - ReEncode
      - Remove
      - ModifyStay
    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'
    foliosShortInfoType:
      type: array
      description: This type contains a list of generated bills for a reservation.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/folioShortInfoType'
    reservationRoomSelectionOverrideType:
      type: object
      description: Define the override flag which will be used when configuring a room to a reservation.
      properties:
        dirtyRoom:
          description: Override the room selection even if the selected room has a "dirty" state.
          type: boolean
        outOfServiceRoom:
          description: Override the room selection even if the selected room has an "out-of-service" state.
          type: boolean
        sleepDiscrepantRoom:
          description: Override the room selection even when HouseKeeping configured the room to still be occupied.
          type: boolean
        occupancyRestriction:
          description: Override the room selection even when room occupancy is exceeded.
          type: boolean
        rateRestriction:
          description: Override the room selection even when there is rate restriction present for this room type.
          type: boolean
        inventoryRestriction:
          description: Override the room selection even when there is no inventory.
          type: boolean
        roomNumberLocked:
          description: Override the room number locked flag in the database and use the value passed.
          type: boolean
        holdRoom:
          description: Override the Hold Room flag in the database and use the value passed.
          type: boolean
        rateChange:
          description: Defines override rate type.
          $ref: '#/components/schemas/rateChangeInstructionType'
        overrideExternalChecks:
          description: Forcefully override update. For real-time CRS interfaces, this element is used as force selling indicator.
          type: boolean
        dayUseReserved:
          description: If the current reservation is a Day Use, then check on Reserved rooms can be overridden when assigning rooms.
          type: boolean
        overrideInstruction:
          description: Contains user information for the override action performed while booking a reservation.
          $ref: '#/components/schemas/overrideInstructionType'
        overrideRotationRoom:
          description: Override the rotation room with the selected room when assigning rooms.
          type: boolean
        overrideRoomOwnership:
          description: Override the room ownership indicator in the reservation when assigning rooms. This is applicable when Room Rotation OPERA Control is active.
          type: boolean
        roomOwnershipType:
          description: Indicates if the reservation room is an owner or referral or regular room. This is applicable when Room Rotation OPERA Control is active.
          $ref: '#/components/schemas/reservationRoomOwnershipType'
        overrideRoomFeatures:
          description: This flag indicates true/false. When this is true, it will allow to override the room feature preference validation while assigning rooms. The Reservation Room Features OPERA Control will determine which room feature preferences will be validated. When Reservation Room Features is on, the validation will be against the Room Feature preferences attached to the reservation. If the parameter is off, the validation will be against the room feature preferences attached to the profile. This is applicable when the Room Feature Validation OPERA Control is on.
          type: boolean
        skipDiscrepantRoom:
          description: This flag indicates true/false. When it is true, you will be allowed to override the room selection for a skip discrepancy. This flag is available when the Discrepant Rooms OPERA Control is active.
          type: boolean
        overrideSharesStayingPastDepartureCheck:
          description: Indicates to override the check on shared reservations to whom changes can be propagated until their departure date.
          type: boolean
    resProfileTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Group
      - TravelAgent
      - Source
      - ReservationContact
      - BillingContact
      - Addressee
    roomMoveDetailType:
      type: object
      description: Room move history information.
      properties:
        hotelId:
          description: Identifies the hotel code under which room is moved.
          type: string
          minLength: 0
          maxLength: 20
        reservationId:
          description: Unique identifier of the reservation.
          $ref: '#/components/schemas/reservationId'
        date:
          description: Business date on which room is moved.
          type: string
          format: date-time
        reasonCode:
          description: Identifies the room move reason code.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of why room is moved.
          type: string
          minLength: 0
          maxLength: 2000
        fromRoom:
          description: Room from which guest is moved.
          type: string
          minLength: 0
          maxLength: 20
        toRoom:
          description: Room to which guest is moved.
          type: string
          minLength: 0
          maxLength: 20
        movedBy:
          description: The user who moved the guest.
          type: string
          minLength: 0
          maxLength: 100
    airaLastRunStatusInfo:
      type: object
      description: Response of last execution status for AI Room Assignment
      properties:
        insertDate:
          description: When the AI Room Assignment starts execution
          type: string
          format: date-time
          maxLength: 8
        updateDate:
          description: Date time of updated status of an executions
          type: string
          format: date-time
        actionValue:
          type: string
          description: Actual run status of an AI room assignment
        runId:
          description: Uniquely generated run-id for each execution of an algorithmn
          type: string
        warnings:
          $ref: '#/components/schemas/warningsType'
        links:
          $ref: '#/components/schemas/links'
    codeListType:
      type: array
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    futureListType:
      type: object
      description: A collection of reservation history details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : Future reservation details'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationInfoType'
        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
    customChargeExemptionsType:
      type: array
      description: List of Custom Charge Exemptions.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/customChargeExemptionType'
    customChargeExemptionType:
      type: object
      description: Contains custom charges exemption information.
      properties:
        customChargesExemption:
          description: Contains exemption code and description.
          $ref: '#/components/schemas/codeDescriptionType'
        customChargeQuantity:
          description: Contains exemption quantity for the stay. When this value is configured, daily exemption quantities are not permitted.
          $ref: '#/components/schemas/customChargeQuantityType'
        customChargeDates:
          description: Contains exemption detail information for each date.
          $ref: '#/components/schemas/customChargeExemptionDatesType'
        excludedDates:
          description: Contains list of dates which are not valid for custom charge exemptions.
          $ref: '#/components/schemas/excludedDatesType'
        percentage:
          description: Exemption Percentage
          type: number
          minimum: 0
          maximum: 100
        propertyExemption:
          description: Flag specifying if custom charge exemptions is property level or not.
          type: boolean
    checkedInReservationInstructionType:
      type: string
      description: Fetch Instruction to indicate if any automatically generated folios information should be returned in the response. For example, in a scenario when automatic credit bills are generated during check-in for the deposits, this instruction can be used to get the credit bill folios which can be used for printing/previewing the folios.
      enum:
      - ReservationDetail
      - AutoFolios
      - ExcludeRoomSuggestion
    trackItGroup:
      type: string
      description: Group to which the Track It items belong.
      enum:
      - Parcel
      - Valet
      - Baggage
      - Lost
    checkedinReservation:
      type: object
      description: CheckIn response will commonly be errors over warnings. If a check has to be done before checking a reservation to a hotel, then the VerifyCheckinReservation operation can be utilized.
      properties:
        reservation:
          description: Reservation record showing the current state of the reservation.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/hotelReservationType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    activityLookUpList:
      type: array
      description: Criteria for fetching Activity Bookings.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/fetchActivityBookingsType'
    reservationStayHistoryFutureInfoType:
      type: object
      description: Information of History and Future Reservation details attached to Profiles.
      properties:
        historyList:
          description: Refer to History list type document.
          $ref: '#/components/schemas/stayHistoryListType'
        futureList:
          description: Refer to Future list type document.
          $ref: '#/components/schemas/stayFutureListType'
    associatedResType:
      type: object
      description: Information regarding associated reservations to the reservation.
      properties:
        parentReservation:
          description: Stores Unique ID of the parent reservation.
          $ref: '#/components/schemas/uniqueID_Type'
        originalMultiRoomRes:
          description: Stores Unique ID of the original multi room reservation from which this reservation is split off.
          $ref: '#/components/schemas/uniqueID_Type'
    packagePostingRhythmType:
      type: object
      description: Package Posting rhythm type.
      properties:
        everyXNightsStartingNightY:
          description: Post the package every X nights Staring from Night Y.
          type: object
          properties:
            startOnNightY:
              description: Starting night for consumption and posting prices.
              type: integer
            postEveryXNights:
              description: Occurance of nights when the package needs to be posted and consumed.
              type: integer
        certainNightsOfTheWeek:
          description: Post the package on certain nights of the week.
          type: object
          properties:
            sunday:
              type: boolean
            monday:
              type: boolean
            tuesday:
              type: boolean
            wednesday:
              type: boolean
            thursday:
              type: boolean
            friday:
              type: boolean
            saturday:
              type: boolean
        customStaySchedule:
          description: This user defined schedule lets you enter a posting rhythm over a 14-day period, starting with the arrival date, by assigning the day (number) within a guest stay for posting this package price.
          type: object
          properties:
            night1:
              description: Night 1 indicator.
              type: boolean
            night2:
              description: Night 2 indicator.
              type: boolean
            night3:
              description: Night 3 indicator.
              type: boolean
            night4:
              description: Night 4 indicator.
              type: boolean
            night5:
              description: Night 5 indicator.
              type: boolean
            night6:
              description: Night 6 indicator.
              type: boolean
            night7:
              description: Night 7 indicator.
              type: boolean
            night8:
              description: Night 8 indicator.
              type: boolean
            night9:
              description: Night 9 indicator.
              type: boolean
            night10:
              description: Night 10 indicator.
              type: boolean
            night11:
              description: Night 11 indicator.
              type: boolean
            night12:
              description: Night 12 indicator.
              type: boolean
            night13:
              description: Night 13 indicator.
              type: boolean
            night14:
              description: Night 14 indicator.
              type: boolean
        customNightSchedule:
          description: 'The start and end of the posting period is determined as follows: If the package is attached to a rate code: The period starts with the date when the rate code to which the package is attached becomes effective for the stay. The period ends with the date of the last night for that rate code (or the last night of the stay if the rate code remains in effect until the departure date). If the package is attached separately to the reservation: The Begin Date specified on the reservation when the package was attached is the start date for the period. The End Date specified on the reservation when the package was attached is the end date for the period. If no Begin Date and/or End Date are specified when the package is attached to the reservation, the Begin Date is assumed to be the arrival date and the End Date is assumed to be the departure date of the reservation, irrespective of when the package is attached to the reservation.'
          type: object
          properties:
            night1:
              description: Night 1 indicator.
              type: boolean
            night2:
              description: Night 2 indicator.
              type: boolean
            night3:
              description: Night 3 indicator.
              type: boolean
            night4:
              description: Night 4 indicator.
              type: boolean
            night5:
              description: Night 5 indicator.
              type: boolean
            night6:
              description: Night 6 indicator.
              type: boolean
            night7:
              description: Night 7 indicator.
              type: boolean
            night8:
              description: Night 8 indicator.
              type: boolean
            night9:
              description: Night 9 indicator.
              type: boolean
            night10:
              description: Night 10 indicator.
              type: boolean
            night11:
              description: Night 11 indicator.
              type: boolean
            night12:
              description: Night 12 indicator.
              type: boolean
            night13:
              description: Night 13 indicator.
              type: boolean
            night14:
              description: Night 14 indicator.
              type: boolean
        type:
          description: Posting Rhythm for the package.
          $ref: '#/components/schemas/postingRhythmType'
    commentType:
      type: object
      description: An indication of a new paragraph for a sub-section of a formatted text message.
      properties:
        text:
          description: Formatted text content.
          $ref: '#/components/schemas/formattedTextTextType'
        image:
          description: An image for this paragraph.
          type: string
        url:
          description: A URL for this paragraph.
          type: string
        commentTitle:
          description: Specifies Comment's Title.
          type: string
          minLength: 0
          maxLength: 4000
        notificationLocation:
          description: Notification Location associated with the Note.
          type: string
          minLength: 0
          maxLength: 20
        type:
          description: Specifies type of the comment.
          type: string
          minLength: 0
          maxLength: 20
        typeDescription:
          description: Comment type Description.
          type: string
          minLength: 0
          maxLength: 200
        internal:
          description: When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.
          type: boolean
        confidential:
          description: When true, the comment may be confidential.
          type: boolean
        overrideInternal:
          description: When true, the note internal could be modified.
          type: boolean
        protectDescription:
          description: When true, the note title will be populated from the note type description and couldn't be modified.
          type: boolean
        hotelId:
          description: If specified comment belongs to the Hotel, otherwise it is a global comment.
          type: string
          minLength: 0
          maxLength: 20
        actionType:
          description: Specifies type of action described in the comments.
          type: string
          minLength: 0
          maxLength: 20
        actionDate:
          description: Indicates at which date an action described in the comment must be taken.
          type: string
          format: date
          maxLength: 8
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    functionArgumentType:
      type: object
      description: This type provided details of a function argument and the value it holds.
      properties:
        name:
          description: Specifies the name of the function argument.
          type: string
          minLength: 0
          maxLength: 200
        value:
          description: Specifies the value held by the function argument.
          type: string
          minLength: 0
          maxLength: 200
        position:
          description: Specifies the position of the function argument in the argument list.
          type: integer
        dataType:
          description: Specifies the datatype of the function argument.
          type: string
          minLength: 0
          maxLength: 40
        required:
          description: Argument of the function mandatory or not.
          type: boolean
    scheduledRoomMoveType:
      description: Scheduled Room Move information.
      type: object
      properties:
        scheduledMoveInfo:
          description: Scheduled Room Move information for a reservation.
          $ref: '#/components/schemas/scheduledRoomMoveInfoType'
        roomAssignmentSegmentBegin:
          type: string
          description: Date Room Assignment Begins.
          format: date-time
        roomAssignmentSegmentEnd:
          type: string
          description: Date of the Scheduled Move Room.
          format: date-time
        roomAssignmentSegmentNo:
          type: integer
          description: Room Assignment Segment Number.
    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
    articlePostItType:
      type: object
      description: Post it information of an article.
      properties:
        availableForPostIt:
          description: Indicates whether the article is available for post it.
          type: boolean
        color:
          description: Color indicator which is only configurable if article is available for post it.
          $ref: '#/components/schemas/colorType'
    shiftRooms:
      type: object
      description: To quickly shift rooms for two reservations that are for the same arrival date and room type
      properties:
        sourceRoom:
          description: Source Room request which defines parameters needed to shift rooms.
          $ref: '#/components/schemas/stayRoominfo'
        targetRoom:
          description: Target Room request which defines parameters needed to shift rooms.
          $ref: '#/components/schemas/stayRoominfo'
        swapShiftOverrideInstruction:
          description: List of overrides available when swapping or shifting rooms.
          $ref: '#/components/schemas/swapShiftOverrideInstructionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    resDepositPolicyType:
      type: object
      description: A deposit policy attached with the reservation.
      properties:
        revenueType:
          description: Type of reservation.
          $ref: '#/components/schemas/depositCancelRevenueType'
        policy:
          description: Reservation deposit policy details.
          $ref: '#/components/schemas/depositPolicyType'
        comments:
          description: Comments attached with a deposit.
          type: string
          minLength: 0
          maxLength: 2000
        amountPaid:
          description: Total amount paid against the reservation deposit.
          $ref: '#/components/schemas/currencyAmountType'
        amountDue:
          description: Total amount due against the reservation deposit.
          $ref: '#/components/schemas/currencyAmountType'
        policyId:
          description: Unique ID of the Reservation Policy.
          $ref: '#/components/schemas/uniqueID_Type'
    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
    blockIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    reservationsForCCAuthType:
      type: array
      description: List of reservations with their payment methods.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationForCCAuthType'
    roomMoveDetailsType:
      type: array
      description: List of room move details
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomMoveDetailType'
    resGuestAdditionalInfoType:
      type: object
      properties:
        portOfEntry:
          description: Entry point into the country. (Croatian Requirements).
          type: string
          minLength: 0
          maxLength: 40
        dateOfEntry:
          description: Entry Date into the country. (Croatian Requirements).
          type: string
          format: date
          maxLength: 8
        nextDestination:
          description: Entry Date into the country. (Croatian Requirements).
          type: string
        preferredRoomType:
          description: Preferred Room Type of the guest.
          type: string
          minLength: 0
          maxLength: 20
        lastStay:
          description: Last Stay information of the guest.
          $ref: '#/components/schemas/guestLastStayInfoType'
        purposeOfStay:
          description: Purpose of stay.
          type: string
          minLength: 0
          maxLength: 20
        guestClassification:
          description: Guest Classification for the data export.
          type: string
          minLength: 0
          maxLength: 40
        guestStatus:
          description: Guest Status for the data export.
          type: string
          minLength: 0
          maxLength: 40
    roomKeyDetails:
      type: object
      description: Response for room key creation.
      properties:
        keyCardData:
          type: string
          maxLength: 2000
        keyTrack:
          description: KeyTrack Data.
          $ref: '#/components/schemas/keyTrackType'
        keyPin:
          description: PIN provided in keyTrack3 from the Door Lock System that is used to unlock a room. This is supported when Key Pin handling is active for the property and the Door Lock System in use.
          type: string
          minLength: 0
          maxLength: 20
        keyStatus:
          description: 'Status of the room key operation as reported by the vendor (e.g. ''success'', ''failure'', ''Key1: Key Created'').'
          type: string
          minLength: 0
          maxLength: 2000
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    massCheckInReservations:
      type: object
      description: Request object to Submit Batch job for Mass Checkin of Reservations.
      properties:
        criteria:
          description: Criteria for Submiting Mass CHeckin of Reservations.
          $ref: '#/components/schemas/massCheckInCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomTypeShortInfoType:
      type: object
      description: Basic information of room type.
      properties:
        pseudo:
          description: Indicates if room is a pseudo. This is read-only.
          type: boolean
        suite:
          description: Indicates if room is a suite. 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
        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'
        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'
        accessible:
          description: Indicates if room type is accessible.
          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
    verifiedCheckinReservation:
      type: object
      properties:
        reservation:
          type: array
          description: Reservation record showing the current state of the reservation.
          items:
            $ref: '#/components/schemas/hotelReservationType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    nameValueDataTypeType:
      type: string
      enum:
      - String
      - Number
      - Date
      - Datetime
      - Time
      - Integer
    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
    roomKeyInterfaceDetailType:
      type: object
      properties:
        interfaceRights:
          description: Room key interface rights.
          $ref: '#/components/schemas/roomKeyInterfaceRightsType'
        encoders:
          description: Available room key interface encoders.
          $ref: '#/components/schemas/roomKeyEncodersType'
        hotelId:
          description: Hotel code of the interface.
          type: string
          minLength: 0
          maxLength: 20
        interfaceName:
          description: Name of the interface.
          type: string
          minLength: 0
          maxLength: 20
        interfaceDescription:
          description: Description of the interface.
          type: string
          minLength: 0
          maxLength: 80
        sendValidStartDateTime:
          description: Indicator if the DLS Interface allows to send valid start date and time.
          type: boolean
        propertyDateTime:
          description: Current property date and time. Uses the hotel's time zone.
          type: string
          format: date-time
        multipleRoomKeys:
          description: Indicator if additional rooms are allowed to be included in key creation.
          type: boolean
        additionalRoomsLimit:
          description: Maximum number of additional rooms allowed.
          type: integer
          minimum: 1
          maximum: 999
        outboundCode:
          description: Outbound Code linked to the property interface.
          type: string
          minLength: 0
          maxLength: 20
        interfaceNumber:
          description: Unique identifier for each interface.
          type: number
    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
    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
    hotelReservationTraceType:
      type: object
      description: Extended Trace object to hold information for a reservation.
      properties:
        timeInfo:
          description: Date of the trace.
          $ref: '#/components/schemas/traceTimeInfoType'
        reservationId:
          description: Reservation ID of the reservation for which the traces are to be retrieved.
          $ref: '#/components/schemas/reservationId'
        departmentId:
          description: Indicates the Department code.
          type: string
          minLength: 0
          maxLength: 20
        traceText:
          description: The information this trace contains.
          type: string
        resolveInfo:
          description: Information regarding the status of the trace
          $ref: '#/components/schemas/traceResolveType'
        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
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    autoAssignRoom:
      type: object
      description: Request for auto assignment of rooms to reservations.
      properties:
        criteria:
          description: Criteria for auto assignment of rooms to reservations.
          $ref: '#/components/schemas/reservationAutoRoomAssignRequestType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    linkedReservationInfoType:
      type: object
      properties:
        reservationIdList:
          $ref: '#/components/schemas/reservationIdList'
        timeSpan:
          $ref: '#/components/schemas/timeSpanType'
        givenName:
          type: string
          minLength: 0
          maxLength: 40
        surname:
          type: string
          minLength: 0
          maxLength: 40
        title:
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          type: string
          minLength: 0
          maxLength: 20
        room:
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          type: string
          minLength: 0
          maxLength: 20
        rate:
          $ref: '#/components/schemas/currencyAmountType'
        guarantee:
          $ref: '#/components/schemas/resGuaranteeType'
        balance:
          $ref: '#/components/schemas/currencyAmountType'
        reservationBlock:
          description: Key information about the block for the linked reservation.
          $ref: '#/components/schemas/reservationBlockType'
        displayColor:
          type: string
          minLength: 0
          maxLength: 20
        allowedActions:
          description: Collection of allowed actions for the linked reservation.
          $ref: '#/components/schemas/reservationAllowedActionsType'
        reservationStatus:
          description: Indicates the Actual status of the reservation.
          $ref: '#/components/schemas/pMS_ResStatusType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        linkReservationType:
          $ref: '#/components/schemas/linkedReservationType'
        reverseCheckInAllowed:
          description: This attribute is to verify if reverse check-in is allowed for the reservation.
          type: boolean
        roomNumberLocked:
          description: This attribute is to verify if room number is locked for the reservation. When true the room number cannot be changed
          type: boolean
        suppressRate:
          description: This attribute checks if rate is suppressed or not in order to properly show strike through.
          type: boolean
    membershipType:
      type: object
      description: Detailed information of the memberships.
      properties:
        comment:
          description: Additional comments regarding to the membership.
          $ref: '#/components/schemas/paragraphType'
        newMembershipNumber:
          description: Card Number of the membership.
          type: string
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
        programDescription:
          description: Description of the membership program.
          type: string
        membershipLevel:
          description: Indicates the membership level.
          type: string
        membershipLevelDescription:
          description: Indicates the membership level description.
          type: string
          minLength: 0
          maxLength: 200
        membershipClass:
          description: Indicates the membership class.
          type: string
        earningPreference:
          description: Earning preference to the membership.
          $ref: '#/components/schemas/membershipEarningPreferenceType'
        inactive:
          description: Indicates whether membership is active or inactive.
          type: boolean
        benefits:
          description: benefits for the membership.
          $ref: '#/components/schemas/benefitsType'
        tierAdministration:
          description: Defines the degree of participation for this membership in the tier management portion of the program.
          $ref: '#/components/schemas/tierAdministrationType'
        downgrade:
          description: Defines how downgrading will be handled for this membership.
          $ref: '#/components/schemas/downgradeType'
        reIssueNewCard:
          description: The status of issuing new membership card to the member.
          $ref: '#/components/schemas/cardReIssueType'
        excludeFromBatch:
          description: True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.
          type: boolean
        upgradeDescription:
          description: Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.
          type: string
          minLength: 0
          maxLength: 32000
        downgradeDescription:
          description: Indicates information regarding the member's possible downgrades.
          type: string
          minLength: 0
          maxLength: 32000
        rating:
          description: Value Rating Type Description for this membership.
          type: string
        membershipEnrollmentCode:
          description: Indicates how the guest enrolled in the program.
          type: string
          minLength: 0
          maxLength: 20
        memberStatus:
          description: Indicates where the guest is in the membership enrollment process.
          type: string
          minLength: 0
          maxLength: 20
        currentPoints:
          description: Profile MemberShip Points.
          type: number
        pointsLabel:
          description: Label used to refer to points for this membership type
          type: string
          minLength: 0
          maxLength: 20
        enrollmentSource:
          description: Source from where the enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        enrollmentResort:
          description: Resort/CRO where enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        preferredCard:
          description: Preferred Card.
          type: boolean
        membershipId:
          description: Card Number of the membership.
          type: string
        membershipType:
          description: Type of membership.
          type: string
        primaryMembershipYn:
          description: Indicator if Membership is a Primary Membership.
          type: string
          minLength: 0
          maxLength: 1
        primaryMembership:
          description: Boolean indicator set to True implies membership is a Primary Membership.
          type: boolean
        membershipIdNo:
          description: Membership ID Number.
          type: integer
        playerRanking:
          description: Ranking assigned to the Player Profile by the Gaming system.
          type: integer
        centralSetup:
          description: Indicates how the award points for this membership type will be managed.
          type: boolean
        signupDate:
          description: Indicates when the member signed up for the loyalty program.
          type: string
          format: date
          maxLength: 8
        effectiveDate:
          description: Indicates the starting date.
          type: string
          format: date
          maxLength: 8
        expireDate:
          description: Indicates the ending date.
          type: string
          format: date
          maxLength: 8
        expireDateExclusiveIndicator:
          description: When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    attachmentType:
      type: object
      description: Attached files.
      properties:
        fileName:
          description: Name of the file.
          type: string
          minLength: 0
          maxLength: 2000
        fileSize:
          description: Size of the file.
          type: integer
        description:
          description: Description for the file.
          type: string
          minLength: 0
          maxLength: 4000
        global:
          description: Flag to say if attachment is available across properties.
          type: boolean
        hotelId:
          description: Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        history:
          description: History data associated with Attachment.
          $ref: '#/components/schemas/dateTimeStampGroupType'
        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
    historyListType:
      type: object
      description: A collection of reservation history details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : History reservation details'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationInfoType'
        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
    callerType:
      type: object
      description: Holds caller information.
      properties:
        givenName:
          description: Caller First Name.
          type: string
          minLength: 0
          maxLength: 280
        surname:
          description: Caller Last Name.
          type: string
          minLength: 0
          maxLength: 80
        phone:
          description: Caller Phone Number.
          type: string
          minLength: 0
          maxLength: 80
        email:
          description: Caller Email.
          type: string
          minLength: 0
          maxLength: 80
        fax:
          description: Caller Fax Number.
          type: string
          minLength: 0
          maxLength: 80
        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
    trackItId:
      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
    profileKeyOptionsType:
      type: object
      properties:
        profileId:
          type: string
          description: Unique profile Id attached to the reservation.
          minLength: 0
          maxLength: 200
        keyOptions:
          type: string
          description: Key option preferences of the specific profile Id attached to the reservation.
          minLength: 0
          maxLength: 200
    roomFeaturesType:
      type: array
      description: A recurring element that identifies the room features.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomFeatureType'
    welcomeOfferType:
      type: object
      properties:
        status:
          description: Determines the status of the welcome offer.
          type: string
          minLength: 0
          maxLength: 20
        type:
          description: Determines the welcome offer option selected while availing the welcome offer.
          $ref: '#/components/schemas/welcomeOfferOptionsType'
    roomStayType:
      type: object
      properties:
        registrationNumber:
          description: Registration Number of the reservation for the current day.
          $ref: '#/components/schemas/uniqueID_Type'
        currentRoomInfo:
          description: Room information of the reservation for the current day.
          $ref: '#/components/schemas/currentRoomInfoType'
        reservationKeyInfo:
          description: Holds the room key information provided by the Door Lock System.
          $ref: '#/components/schemas/reservationKeyInfoType'
        roomRates:
          description: A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomRateType'
        hasExtendedStayRates:
          description: Indicates if resertvation has a rate that is configured with a non-nightly posting interval.
          type: boolean
        guestCounts:
          $ref: '#/components/schemas/guestCountsType'
        arrivalDate:
          type: string
          format: date
        departureDate:
          type: string
          format: date
        bookingTimeSpan:
          description: The booking time span of the reservation, only applicable when time increments are being used.
          $ref: '#/components/schemas/bookingTimeSpanType'
        expectedTimes:
          description: The Expected Arrival and Departure Times.
          $ref: '#/components/schemas/resExpectedTimesType'
        originalTimeSpan:
          description: The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.
          $ref: '#/components/schemas/timeSpanType'
        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: Promotions applied to the reservation to get the promotional rate.
          $ref: '#/components/schemas/promotionType'
        suiteWith:
          description: Connecting Rooms.
          type: string
          minLength: 0
          maxLength: 200
        total:
          description: The total amount charged for the Room Stay.
          $ref: '#/components/schemas/totalType'
        totalPoints:
          description: The total number of Points charged for the Room Stay.
          $ref: '#/components/schemas/pointsType'
        multiValueAttrs:
          description: Informative indicators indicating different values of an attribute exists over the stay.
          type: array
          maxItems: 4000
          items:
            type: string
            maxLength: 2000
        upsellInfo:
          description: Indicates Upsell Information to be applied on Reservation.
          $ref: '#/components/schemas/upsellInfoType'
        mobileNotifications:
          description: Denotes the status of Room Ready and Key Ready messages.
          $ref: '#/components/schemas/resMobileNotificationsType'
        roomNumberLocked:
          description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.
          type: boolean
        printRate:
          description: This control whether rate info will be printed in confirmation letter.
          type: boolean
        ownerReservationType:
          description: Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation.
          $ref: '#/components/schemas/ownerResTypeType'
        primaryShareType:
          description: This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed.
          $ref: '#/components/schemas/primaryShareTypeType'
        remoteCheckInAllowed:
          description: Indicates whether the reservation is pre-registered for internet check-in or not.
          type: boolean
        bookingMedium:
          description: Classifies the medium(Channel field on reservation screen) through which the reservation is made.
          type: string
          minLength: 0
          maxLength: 20
        bookingMediumDescription:
          description: Description of the booking medium.
          type: string
          minLength: 0
          maxLength: 2000
        availableUpsellOfferCount:
          description: Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request
          type: integer
    massCheckInCriteriaType:
      type: object
      description: This will have details of reservations and advance criteria for performing Mass Checkin of Reservations
      properties:
        hotelId:
          description: Resort to which the Reservation belongs.
          type: string
          minLength: 0
          maxLength: 20
        reservationIdList:
          description: Collection of Reservation ID's that should be Mass Checked in
          $ref: '#/components/schemas/reservationIdList'
        additionalCriteria:
          description: Additional RoomStatus Criteria for Mass Checkin
          type: object
          properties:
            roomStatuses:
              description: Additional RoomStatus Criteria for Mass Checkin
              $ref: '#/components/schemas/roomStatusListType'
        checkInInitiatedBy:
          description: This indicates who initiated the Check In/Advance Check In. Advance Check In functionality is available when the Advance Check In OPERA Control is active.
          type: string
          minLength: 0
          maxLength: 40
    webUserAccountsType:
      type: array
      description: Web User Accounts List.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/webUserAccountType'
    roomOccupancyType:
      description: Room Occupancy information.
      type: object
      properties:
        roomId:
          type: string
          description: Room Id.
          minLength: 0
          maxLength: 20
        roomType:
          type: string
          description: Room Type.
          minLength: 0
          maxLength: 20
        roomIsOccupied:
          type: boolean
          description: Indicates if the Room is currently occupied.
        estimatedDepartureTime:
          type: string
          description: Estimated Time of Departure of reservation when room status is occupied.
          format: date-time
        guestFirstName:
          type: string
          description: Guest First/Given Name on reservation when room status is occupied.
          minLength: 0
          maxLength: 40
        guestLastName:
          type: string
          description: Guest Last Name /Surname on reservation when room status is occupied.
          minLength: 0
          maxLength: 40
    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
    profileCashieringDetailType:
      type: object
      description: The type contains routing instructions for the profile.
      properties:
        paymentMethod:
          description: Payment Method Details.
          $ref: '#/components/schemas/codeDescriptionType'
        eCommerceId:
          description: E-Commerce ID of the Profile
          $ref: '#/components/schemas/uniqueID_Type'
        routingInstructions:
          description: Set of preconfigured transaction codes.
          $ref: '#/components/schemas/profileRoutingInstructionsType'
        taxType:
          description: Tax type code.
          type: string
          minLength: 0
          maxLength: 20
        fiscalGuestType:
          description: Guest type code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel Code for which the routing instructions are provided for a profile.
          type: string
          minLength: 0
          maxLength: 20
    trackItLogListType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/trackItLogType'
    trackItReservationInfoType:
      type: object
      description: Reservation info associated with a Track It item.
      properties:
        reservationIdList:
          $ref: '#/components/schemas/reservationIdList'
        timeSpan:
          $ref: '#/components/schemas/timeSpanType'
        guestInfo:
          $ref: '#/components/schemas/resGuestInfoType'
        roomType:
          type: string
          minLength: 0
          maxLength: 20
        roomId:
          type: string
          minLength: 0
          maxLength: 20
        roomStatus:
          $ref: '#/components/schemas/housekeepingRoomStatusType'
        guarantee:
          $ref: '#/components/schemas/resGuaranteeType'
        reservationStatus:
          $ref: '#/components/schemas/pMS_ResStatusType'
        computedReservationStatus:
          $ref: '#/components/schemas/pMS_ResStatusType'
    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
    resGuestType:
      type: object
      description: A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection.
      properties:
        profileInfo:
          description: A collection of Profiles or Unique IDs of Profiles.
          type: object
          properties:
            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'
            profile:
              description: Provides detailed information regarding either a company or a customer profile.
              $ref: '#/components/schemas/profileType'
            profileCashieringDetail:
              description: Cashiering details for the profile.
              $ref: '#/components/schemas/profileCashieringDetailType'
            registrationCardNo:
              description: Unique identifier of the police registration card number.
              type: string
              minLength: 0
              maxLength: 40
        arrivalTransport:
          $ref: '#/components/schemas/transportInfoType'
        departureTransport:
          $ref: '#/components/schemas/transportInfoType'
        visaInfo:
          $ref: '#/components/schemas/visaInfoType'
        reservationGuestRPH:
          description: This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.
          type: string
          minLength: 1
          maxLength: 8
        primary:
          description: When true indicates this is the primary guest.
          type: boolean
    ratesType:
      type: object
      description: Individual rate amount.
      properties:
        rate:
          description: The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/amountType'
        rateRange:
          description: Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/rateRangeType'
    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
    cateringResInfoType:
      type: object
      description: Information regarding catering event and catering revenue type associated to the reservation.
      properties:
        eventId:
          description: Unique ID on a catering event associated to the reservation.
          $ref: '#/components/schemas/eventId'
        revenueType:
          description: Catering revenue type associated to the reservation.
          type: string
    facilityCodesType:
      type: array
      description: List of the facility codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/facilityCodeType'
    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'
        accessible:
          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'
    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
    welcomeOfferOptionsType:
      type: string
      description: None of the Welcome Offer option is selected.
      enum:
      - BonusPoints
      - Ecoupons
      - Items
      - PostIt
      - NotSelected
    dateUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Date Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/dateUDFType'
    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
    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'
    feeType:
      type: object
      description: Applicable service charges or fees.
      properties:
        description:
          type: string
          minLength: 0
          maxLength: 2000
        type:
          description: Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).
          $ref: '#/components/schemas/amountDeterminationType'
        code:
          description: Code identifying the fee (e.g.,agency fee, municipality fee).
          type: string
          minLength: 0
          maxLength: 20
        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
    dateUDFType:
      type: object
      description: Used to hold user defined field of Date Type.
      properties:
        name:
          description: Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: string
          format: date
          maxLength: 8
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    keyUserType:
      type: string
      description: Simple type for representing key user type. 'Guest' = request Opera Guest room key
      enum:
      - Guest
    uRLInfoType:
      type: object
      description: Web site address.
      properties:
        url:
          description: Provides URL information.
          $ref: '#/components/schemas/uRLType'
        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
    awardId:
      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
    guestMessagesType:
      type: array
      description: Holds the Message Information
      maxItems: 4000
      items:
        $ref: '#/components/schemas/guestMessageType'
    unAssignRoomCriteria:
      type: object
      description: Request to the remove a room(unassign) from a reserved reservation.
      properties:
        overrideRoomNumberLocked:
          description: Criteria for removing the room from a reservation.
          type: boolean
        overrideRoomOwnership:
          description: Override the room ownership indicator in the reservation when removing rooms. This is applicable when Room Rotation OPERA Control is active.
          type: boolean
        roomSegmentBeginDate:
          type: string
          description: Defines the start date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.
          format: date
        roomSegmentEndDate:
          type: string
          description: Defines the end date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.
          format: date
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    roomSummaryType:
      type: object
      properties:
        assignedRooms:
          description: Indicates summary of the assigned rooms.
          $ref: '#/components/schemas/assignedRoomsSummaryType'
        unassignedRooms:
          description: Indicates summary of the unassigned rooms.
          $ref: '#/components/schemas/unassignedRoomsSummaryType'
    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'
    transactionDiversionDailyDetailsType:
      type: array
      description: List of daily details for Transaction Diversion rule.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/transactionDiversionDailyDetailType'
    reservationLocatorType:
      type: object
      description: Holds the information for a Reservation Guest Locator
      properties:
        dateSpan:
          description: Begin and End date range of the Guest Locator.
          $ref: '#/components/schemas/dateRangeType'
        timeSpan:
          description: Time span for the Guest Locator.
          $ref: '#/components/schemas/dateTimeSpanType'
        locatorText:
          description: The Locator Text for the guest.
          type: string
        locatorOn:
          description: Date and time of the Guest Locator.
          type: string
          format: date-time
        locatorBy:
          description: User that entered this Guest Locator.
          type: string
        locatorId:
          description: Unique Id of the Guest Locator ( Locator Id )
          $ref: '#/components/schemas/uniqueID_Type'
    keywordDetailType:
      type: object
      properties:
        newKeyword:
          description: The new keyword value.
          type: string
          minLength: 0
          maxLength: 80
    roomKeyInfoType:
      type: object
      description: Contains detail information of room keys .
      properties:
        hotelId:
          description: Name of the resort .
          type: string
          minLength: 0
          maxLength: 20
        keyCount:
          description: Number of keys has been created for the reservation .
          type: string
          minLength: 1
          maxLength: 3
        keyStartDate:
          description: Start date and time of the key. Uses the hotel's time zone.
          type: string
          format: date-time
        keyExpiryDate:
          description: Expiry date and time of the key. Uses the hotel's time zone.
          type: string
          format: date-time
        keyPin:
          description: PIN provided in keyTrack3 from the Door Lock System that is used to unlock a room. This is supported when Key Pin handling is active for the property and the Door Lock System in use.
          type: string
          minLength: 0
          maxLength: 200
        keyOptions:
          description: Key options of the key.
          $ref: '#/components/schemas/codeListType'
        additionalRooms:
          description: Additional rooms included in the key creation of reservation room.
          $ref: '#/components/schemas/codeListType'
        roomId:
          description: Room Number.
          type: string
          minLength: 0
          maxLength: 20
        reservationId:
          description: Reservation ID of the reservation of the room key .
          $ref: '#/components/schemas/reservationId'
        keyTrack:
          description: KeyTrack Data.
          $ref: '#/components/schemas/keyTrackType'
        guestInfo:
          description: Guest information on the key. This information is available when multiple_guest_key is active.
          $ref: '#/components/schemas/roomKeyGuest'
        backToBackKey:
          description: Flag indicates whether the key is back to back.
          type: boolean
    taxTypeType:
      type: object
      description: Provides information about the Tax Type.
      properties:
        hotelId:
          description: Code of the Hotel.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Code of the Tax Type.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the Tax Type.
          type: string
          minLength: 0
          maxLength: 2000
        collectingAgentTax:
          description: A boolean flag for Collecting Agent Tax
          type: boolean
        printAutoAdjust:
          description: Print auto adjust information for this tax type on the tax exempt report.
          type: boolean
        reportExemptDays:
          description: Number of days after which the guest will be tax exempt. Only used for tax exempt report.
          type: integer
        reportTaxPercentage:
          description: Tax percentage. Only used for tax exempt report.
          type: number
          minimum: 0
          maximum: 100
        minimumLengthOfStay:
          description: Minimun Length of Stay.
          type: integer
    roomMoveHistory:
      type: object
      description: Response for the fetch room move history of a reservation.
      properties:
        roomMoveHistoryDetails:
          description: List of room move history.
          $ref: '#/components/schemas/roomMoveDetailsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    printDataType:
      type: object
      description: Lists the text, file or picture to print onto a Guest room key (only for roomKeyType is HardKey).
      properties:
        printText:
          description: key options code.
          type: string
          minLength: 0
          maxLength: 200
        printFile:
          description: Base64 format of file representing data to print.
          type: string
          format: byte
        printPicture:
          description: Base64 format of picture representing data to print.
          type: string
          format: byte
    roomKeyInterfaceDetails:
      type: object
      description: Response with the configuration details of active room key interfaces including the available key encoders.
      properties:
        keyInterfaceDetails:
          description: Collection of configuration details of active room key interfaces.
          $ref: '#/components/schemas/roomKeyInterfaceDetailsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    feesType:
      type: object
      description: A collection of fees or service charges.
      properties:
        fee:
          description: An individual fee or service charge.
          type: array
          maxItems: 99
          items:
            $ref: '#/components/schemas/feeType'
        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
    roomStatusListType:
      type: array
      description: Room Status Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/housekeepingRoomStatusType'
    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'
        roomStatus:
          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
        reasonDesc:
          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'
        roomStatus:
          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
    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.
    floorPlanRoomGuestType:
      type: object
      properties:
        lastName:
          type: string
        firstName:
          type: string
        arrival:
          type: string
          format: date
          maxLength: 8
        departure:
          type: string
          format: date
          maxLength: 8
        shareID:
          type: string
        confirmationNo:
          type: string
    eCertificateIssueType:
      type: string
      description: Indicates that guest purchased OPERA E-Certificate.
      enum:
      - Assigned
      - OptedIn
      - Purchased
    configPackagePrimaryDetailsType:
      type: object
      description: A Config Package Info type.
      properties:
        description:
          description: The description of the package.
          type: string
          minLength: 0
          maxLength: 2000
        shortDescription:
          description: The short description of the package.
          type: string
          minLength: 0
          maxLength: 2000
        forecastGroup:
          description: The Forecast group package belongs to.
          type: string
          minLength: 0
          maxLength: 20
        arrangementCode:
          description: Arrangement Code.
          type: string
          minLength: 0
          maxLength: 20
        beginSellDate:
          description: Indicates the begin sell date of the package.
          type: string
          format: date
          maxLength: 8
        endSellDate:
          description: Indicates the end sell date of the package.
          type: string
          format: date
          maxLength: 8
    roomsHoldType:
      type: object
      description: Hold reason and the list of the rooms that are to be put on hold under that reason.
      properties:
        hotelId:
          description: Resort where room hold is to take place.
          type: string
          minLength: 0
          maxLength: 20
        rooms:
          description: Collection of room numbers that are to be placed on hold.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        reason:
          description: List of rooms that are to be put on hold.
          type: string
          minLength: 0
          maxLength: 20
        comments:
          description: Comments to the rooms being put on hold.
          type: string
          minLength: 0
          maxLength: 2000
    roomHoldType:
      type: object
      properties:
        holdUntil:
          description: The date and time when hold will expire. Uses the hotel's time zone.
          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
    webUserAccountType:
      type: object
      description: Web User Account of the guest.
      properties:
        securityQuestion:
          description: Security Question and its Code associated with the account to verify the user.
          $ref: '#/components/schemas/codeDescriptionType'
        securityAnswer:
          description: Answer to the Security Question.
          type: string
          minLength: 0
          maxLength: 4000
        comments:
          description: Comments.
          type: string
          minLength: 0
          maxLength: 4000
        history:
          description: Web User Account History.
          $ref: '#/components/schemas/webUserHistoryType'
        newLoginName:
          description: New Login Name of the guest.
          type: string
          minLength: 0
          maxLength: 80
        newPassword:
          description: Login Password.
          type: string
          minLength: 0
          maxLength: 2000
        autoGeneratePassword:
          description: A flag which determines if the password is auto generated.
          type: boolean
        loginName:
          description: Login Name of the guest.
          type: string
          minLength: 0
          maxLength: 80
        domainCode:
          description: Domain code.
          type: string
          minLength: 0
          maxLength: 20
        locked:
          description: Boolean flag that indicates whether the web account is locked or not.
          type: boolean
        inactive:
          description: Boolean flag that indicates whether the web account is inactive or not.
          type: boolean
    externalReferencesType:
      type: array
      description: This type contains unique information of external reference.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/externalReferenceType'
    fixedChargeDetailType:
      type: object
      description: Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
      properties:
        transaction:
          description: Transaction code and description of a fixed charge.
          $ref: '#/components/schemas/codeDescriptionType'
        quantity:
          description: Quantity of the product.
          type: integer
        chargeAmount:
          description: Price of the product.
          $ref: '#/components/schemas/currencyAmountType'
        percent:
          description: Percentage of the rate amount.
          type: number
          minimum: 0
          maximum: 100
        supplement:
          description: Additional information regarding the fixed charge.
          type: string
          minLength: 0
          maxLength: 2000
        article:
          description: Holds related article code and description.
          $ref: '#/components/schemas/codeDescriptionType'
        roomNights:
          description: Holds number of comp or cash room night to allocate.
          type: integer
    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
    reservationPackageType:
      type: object
      description: A ReservationPackageType class.
      properties:
        packageHeaderType:
          description: Package information from configuration.
          $ref: '#/components/schemas/packageCodeHeaderType'
        scheduleList:
          description: A HotelPackageSchedule type.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationPackageScheduleType'
        newTimeSpan:
          description: The changed dates(Start and End dates) for this product.
          $ref: '#/components/schemas/timeSpanType'
        consumptionDetails:
          description: Package consumption details. Includes information for quantity , allowance etc.
          $ref: '#/components/schemas/packageConsumptionType'
        packageCode:
          description: Package code. This is the unique code used for the package and is a required element.
          type: string
          minLength: 0
          maxLength: 20
        internalID:
          description: Reservation Package Opera Internal Unique Id. This is the unique Id used for this reservation package.
          type: number
        ratePlanCode:
          description: The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record on the reservation.
          type: string
          minLength: 0
          maxLength: 20
        startDate:
          description: Required value when changing a reservation package. If the original start date was null, then null is required.
          type: string
          format: date
          maxLength: 8
        endDate:
          description: Required value when changing a reservation package. If the original end date was null, then null is required.
          type: string
          format: date
          maxLength: 8
        packageGroup:
          description: Package group code. If this package is part of a package group, the group code is indicated here. This is a required element and is part of the key to fetch the correct package record .
          type: string
          minLength: 0
          maxLength: 20
        source:
          description: Indicates if the source of the product is Rate header, Rate Detail or Reservation. For new development this field is to be used for passing the product scource
          $ref: '#/components/schemas/productSourceType'
        awardCode:
          description: This is the Award code used to redeem the package if the package is a redemption package.
          type: string
          minLength: 0
          maxLength: 20
        points:
          description: Indicates the points used to redeem the redemption package.
          type: integer
    autoAssignedRoom:
      type: array
      description: Collection of result set which is made of reservation id, error and warning.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/autoRoomAssignType'
    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
    suggestedRooms:
      type: object
      description: Response of fetch suggested rooms operation.
      properties:
        suggestedRoomsType:
          description: List of suggested rooms for room assignment.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/suggestedRoomType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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
    profileTypeType:
      type: string
      description: The types of Profile handled by the web service.
      enum:
      - Guest
      - Agent
      - Company
      - Group
      - Source
      - Employee
      - Hotel
      - Vendor
      - Contact
      - Purge
      - BusinessHeader
      - BillingAccount
      - Activity
      - Potential
      - Account
    profileIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    primaryShareTypeType:
      type: string
      enum:
      - Primary
      - NonPrimary
    routingInfoListType:
      type: array
      description: A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/routingInfoType'
    fBAInfoType:
      type: object
      description: FBA ( Flexible Benefits Awards ) related fields.
      properties:
        status:
          description: Possible FBA statuses.
          $ref: '#/components/schemas/fBAStatusType'
        monetaryValue:
          description: Award's FBA monetary values.
          type: number
        amount:
          description: Award's FBA amount.
          type: number
        postedAmount:
          description: Award's FBA posted amount.
          type: number
        reimbursedAmount:
          description: Award's FBA reimbursed amount.
          type: number
        postingDateTime:
          description: Date and time of the FBA posting.
          type: string
          format: date
          maxLength: 8
        postingBusinessDate:
          description: Business date of the FBA posting.
          type: string
          format: date
          maxLength: 8
        settlementDateTime:
          description: Date and time of the FBA settlement.
          type: string
          format: date
          maxLength: 8
        settlementBusinessDate:
          description: Business date of the FBA settlement.
          type: string
          format: date
          maxLength: 8
        reimbursementDateTime:
          description: Date and time of the FBA reimbursement.
          type: string
          format: date
          maxLength: 8
        reimbursementBusinessDate:
          description: Business date of the FBA reimbursement.
          type: string
          format: date
          maxLength: 8
        fbaBillGenDate:
          description: Business date of the FBA bill generation.
          type: string
          format: date
          maxLength: 8
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        flexibleBenefitAward:
          description: Indicates if this certificate is a Flexible Benefit Award certificate.
          type: boolean
        posted:
          description: Indicates whether FBA has been posted.
          type: boolean
        settled:
          description: Indicates whether FBA has been settled.
          type: boolean
        reimbursed:
          description: Indicates whether FBA has been reimbursed.
          type: boolean
        resettleAllowed:
          description: Marks if the certificate is eligible for resettlement
          type: boolean
        reimburseAllowed:
          description: Marks if the certificate is eligible for reimbursement.
          type: boolean
        orphanCertificate:
          description: Indicates whether the certificate is Orphan or not.
          type: boolean
    prepaidCardDetailsType:
      type: object
      description: Prepaid Card Details.
      properties:
        initialLoadDate:
          description: Holds fixed charge detail.
          type: string
          format: date
          maxLength: 8
        activateDate:
          description: Holds fixed charge detail.
          type: string
          format: date
          maxLength: 8
        initialCreditTotal:
          description: Holds fixed charge detail.
          $ref: '#/components/schemas/currencyAmountType'
        creditTotal:
          description: Holds fixed charge detail.
          $ref: '#/components/schemas/currencyAmountType'
        debitTotal:
          description: Holds fixed charge detail.
          $ref: '#/components/schemas/currencyAmountType'
        reservedTotal:
          description: Holds fixed charge detail.
          $ref: '#/components/schemas/currencyAmountType'
        balanceTotal:
          description: Holds fixed charge detail.
          $ref: '#/components/schemas/currencyAmountType'
        validUntilDate:
          description: Holds fixed charge detail.
          type: string
          format: date
          maxLength: 8
        expiredDate:
          description: Holds fixed charge detail.
          type: string
          format: date
          maxLength: 8
        transactions:
          description: Holds fixed charge detail.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/prepaidCardTransactionType'
    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
      - HouseKeeping
      - EnrollToPrimaryMembership
      - EnrollInProgress
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    trackItType:
      type: object
      description: Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.
      properties:
        type:
          $ref: '#/components/schemas/codeDescriptionType'
        url:
          $ref: '#/components/schemas/uRLType'
    packagePostingRulesType:
      type: object
      properties:
        transactionCode:
          description: The Transaction code used to post the package price.
          $ref: '#/components/schemas/packageTransactionCodeType'
        overageCode:
          description: The overage code to record over consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        profitCode:
          description: The transaction code to record package profit, if any, from un-consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        lossCode:
          description: The transaction code to record package Loss, if any, from un-consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        alternateCodesList:
          description: The alternate transaction code that can be consumed by the guest in place of the transaction code.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/packageTransactionCodeType'
    awardStatusType:
      type: string
      description: Indicates that certificate is in use.
      enum:
      - Available
      - NotAvailable
      - InUse
    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
    eCertificateClassficationType:
      type: string
      description: Enumeration of the different type of Ecertificate.
      enum:
      - Promotion
      - Award
      - Benefit
      - Other
    batchCCAuthToProcess:
      type: object
      description: Response for starting a credit card authorization batch job, which contains the batch ID upon success.
      properties:
        batchId:
          type: integer
        processId:
          $ref: '#/components/schemas/stringLength200'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    numericUDFType:
      type: object
      description: Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
      properties:
        name:
          description: Name of user defined field.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: number
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    namePrefixType:
      type: string
      description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
      minLength: 0
      maxLength: 40
    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
    keyCardType:
      type: string
      description: Key card types.
      enum:
      - Mifare1K
      - Mifare4K
      - MifareUltralight
    fBAStatusType:
      type: string
      description: Flexible benefit award has been reimbursed.
      enum:
      - Ordered
      - Attached
      - Posted
      - Settled
      - Reimbursed
    scopeType:
      type: string
      description: Minimum required and complimentary values are applicable Per Stay.
      enum:
      - PerDay
      - PerStay
    communicationStatusType:
      type: string
      description: Enum to denote the Status of Readiness messages sent to Guest Devices.
      enum:
      - Pending
      - Completed
      - Failed
      - Sent
      - Received
      - Cancelled
      - PendingAvailability
    amountDeterminationType:
      type: string
      description: Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
      enum:
      - Inclusive
      - Exclusive
    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'
        approvalCode:
          description: Approval code sent by the credit card company on a successful authorization.
          type: string
          minLength: 0
          maxLength: 20
        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'
        citId:
          description: Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.
          type: string
          minLength: 0
          maxLength: 30
    effectiveRateType:
      type: object
      description: Effective rate amount per guest on specific dates.
      properties:
        onePersonRate:
          description: Rate amount for one person.
          type: number
        twoPersonRate:
          description: Rate amount for two persons.
          type: number
        threePersonRate:
          description: Rate amount for three persons.
          type: number
        fourPersonRate:
          description: Rate amount for four persons.
          type: number
        fivePersonRate:
          description: Rate amount for five persons.
          type: number
        extraPersonRate:
          description: Rate amount for each extra person.
          type: number
        extraChildRate:
          description: Rate amount for each extra Child.
          type: number
        oneChildRate:
          description: Rate amount for one Child.
          type: number
        twoChildrenRate:
          description: Rate amount for two Children.
          type: number
        threeChildrenRate:
          description: Rate amount for three Children.
          type: number
        fourChildrenRate:
          description: Rate amount for four Children.
          type: number
        rateByAgeBuckets:
          description: Collection of rate amount by age bracket.
          $ref: '#/components/schemas/rateByAgeBucketsType'
        minimumChildrenForFreeStay:
          description: Minimum number of children needed to get free stay.
          type: integer
        pointsRequired:
          description: The number of award points required for applying this rate plan schedule.
          type: number
        overrideFloorAmount:
          description: true if floor amount needs to be override
          type: boolean
        hotelId:
          description: ''
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: ''
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: ''
          type: string
          minLength: 0
          maxLength: 20
        numberOfRooms:
          description: ''
          type: integer
        amountBeforeTax:
          description: Rate amount Before Tax.
          type: number
        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
    resHousekeepingType:
      type: object
      description: Holds housekeeping turndown service information for the room.
      properties:
        instructions:
          description: Turndown instructions for the room.
          type: string
        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
        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
        roomStatus:
          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'
    indicatorsType:
      type: array
      description: Collection of lamp indicators.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/indicatorType'
    trackItItemType:
      type: object
      description: Detailed information of a Track It item.
      properties:
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        trackItId:
          $ref: '#/components/schemas/trackItId'
        group:
          $ref: '#/components/schemas/trackItGroup'
        ticketNumber:
          type: string
          minLength: 0
          maxLength: 80
        referenceNumber:
          type: string
          minLength: 0
          maxLength: 20
        type:
          $ref: '#/components/schemas/trackItType'
        action:
          $ref: '#/components/schemas/trackItActionType'
        location:
          $ref: '#/components/schemas/codeDescriptionType'
        quantity:
          type: integer
        followUpDate:
          type: string
          format: date
          maxLength: 8
        description:
          type: string
          minLength: 0
          maxLength: 2000
        assignedTo:
          $ref: '#/components/schemas/applicationUserType'
        reservationInfo:
          $ref: '#/components/schemas/trackItReservationInfoType'
        trackItLogList:
          $ref: '#/components/schemas/trackItLogListType'
    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'
    reservationAutoRoomAssignRequestType:
      type: object
      description: Request criteria for auto assignment of rooms to reserved reservations.
      properties:
        reservationCriteria:
          description: A list of reservation ids which will be used to auto assign rooms.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationIdList'
        roomSelectionCriteria:
          description: Search type for the rooms which will be used to assign.
          type: object
          properties:
            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
            hotelId:
              type: string
              minLength: 0
              maxLength: 20
            roomStatusFilter:
              description: Fetch instructions that should be used to get hotel rooms.
              type: object
              properties:
                hotelRoomStatusList:
                  description: Hotel room status instructions to be used in requests for fetching rooms.
                  type: array
                  maxItems: 4000
                  items:
                    $ref: '#/components/schemas/housekeepingRoomStatusType'
                hotelFORoomStatusList:
                  description: Front office room status instructions to be used in requests for fetching housekeeping rooms.
                  type: array
                  maxItems: 4000
                  items:
                    $ref: '#/components/schemas/frontOfficeRoomStatusType'
            roomRange:
              description: Room range instructions.
              $ref: '#/components/schemas/roomRangeType'
            hotelRoomDateRange:
              description: Date range instructions.
              $ref: '#/components/schemas/timeSpanType'
            roomTypes:
              description: The room types of hotel rooms to be fetched.
              type: array
              maxItems: 4000
              items:
                type: string
                minLength: 0
                maxLength: 20
            roomClass:
              description: The room class of hotel rooms to be fetched.
              type: string
              minLength: 0
              maxLength: 20
            floor:
              description: The floor of room to be fetched.
              type: string
              minLength: 0
              maxLength: 20
            includeDueOut:
              description: This flag when set to true will include rooms assigned to due out reservations.
              type: boolean
            departureTime:
              description: When IncludeDueOut is enabled, it is the departure time before which to search. It will return rooms assigned to departing reservations that have an ETD (Estimated Time of Departure) before the entered time.
              type: string
              format: date-time
            roomFeatures:
              description: The Room Features of the room to be fetched.
              $ref: '#/components/schemas/roomFeaturesType'
            smokingPreference:
              description: The smoking preference of room to be fetched.
              type: string
              minLength: 0
              maxLength: 20
            includeAllRoomConditions:
              description: This flag when set to true will include all room conditions, when set to false then room with "General Assignment" condition type will be excluded from the result.
              type: boolean
            includeComponentRooms:
              description: This flag when set to true will include all component rooms
              type: boolean
            includePseudoRooms:
              description: This flag when set to true will include all pseudo rooms
              type: boolean
            includeOORoomCheck:
              description: This flag when set to true will work for Available Rooms functionality
              type: boolean
            connectingRoomsOnly:
              description: This flag when set to true will include only connecting rooms.
              type: boolean
            reservationId:
              $ref: '#/components/schemas/reservationId'
            pseudoRoomsOnly:
              description: This flag when set to true will include only pseudo rooms
              type: boolean
            includeAttendentInRoom:
              description: This flag when set to true will includes attendent in Rooms
              type: boolean
            roomNumberWildcard:
              type: string
              minLength: 0
              maxLength: 20
            useAIRoomAssignment:
              description: If the AI ROOM ASSIGNMENT application parameter is set to Y, this flag when set to true will use the AI Room Assignment algorithm to fetch the results in order of suitability.
              type: boolean
            includeDepartureRooms:
              description: Indicates if departure rooms are to be included in the auto assignment.
              type: boolean
            useAssociatedProfilePreferences:
              description: Indicates if preferences on the profile associated to the reservation should be used to determine the room type. The preferences for FLOOR, SMOKING and ROOM FEATURES will be used.
              type: boolean
            excludeRoomFeatures:
              description: It indicates to exclude rooms with the selected Room Feature(s). It allows alphanumeric values(e.g.,TUB,BOLCONY,MV)
              $ref: '#/components/schemas/roomFeaturesType'
            excludeFloorPreferences:
              description: It indicates to exclude rooms with the selected Floor(s).It allows alphanumeric values(e.g.,01,02,03,GROUND,five)
              type: array
              maxItems: 4000
              items:
                type: string
                minLength: 0
                maxLength: 20
            perfectFitRoomsOnly:
              type: boolean
              description: When this flag is set to true, it will fetch only rooms that have exactly Y nights free with the reservation guest(s) points. This will prevent any gaps in room assignment.
            orderBy:
              description: When Forecast Rotation is checked, the room rotation order will consider any future reservations for point calculation and reorder the rooms accordingly.This is supported when OPERA Control Room Rotation and Forecast Rotation Points are active.
              $ref: '#/components/schemas/hotelRoomsOrderBy'
            useETDandETA:
              description: Indicates if the Estimated Time of Departure of the departing reservation and the Estimated Time of Arrival of the arriving reservation should be considered during the Auto Assign process. If true, rooms that would cause an overlap of the ETD/ETAs will not be assigned. An additional buffer (in Minutes) will also be considered if the value in the Auto Assign ETD - ETA Buffer OPERA Control is not blank. The default value is false, which will not consider the ETD/ETA when assigning rooms.
              type: boolean
            excludeBackToBackReservations:
              description: When this flag is set to true, it will exclude the linked reservations which are marked as Back to Back in the result.Marking reservations as Back to Back is available when the Back to Back Handling for Linked Reservations OPERA control is active.
              type: boolean
            includeScheduledMoveOutRoom:
              description: Indicates if Move Out rooms are to be included in the auto assignment. Move Out rooms are rooms that are assigned to reservations with a scheduled room move on the day of assignment.Scheduled Room Move functionality is available when the Advanced Daily Details OPERA Control is active.
              type: boolean
            useRoomFeatureSuggestions:
              description: Indicates if preferences on the profile associated to the reservation should be used to determine the room type. The preferences for FLOOR, SMOKING and ROOM FEATURES will be used.
              type: boolean
        roomNumberLocked:
          description: Update the do not move flag used to locking the reservation room number.
          type: boolean
    timeWindowType:
      type: object
      description: Defines a Time period with start time and an end time.
      properties:
        startTime:
          description: Start Time of the Time window.
          type: string
        endTime:
          description: End Time of the Time window.
          type: string
    stringLength2000:
      type: string
      description: Used for Character Strings, length 0 to 2000.
      maxLength: 2000
      minLength: 0
    addtionalCodeInfoType:
      type: array
      description: Holds name of additional code information
      maxItems: 4000
      items:
        type: object
        properties:
          name:
            description: Holds name of additional code information
            $ref: '#/components/schemas/masterInfoCodeDetailType'
          value:
            description: Holds value of additional code information
            type: string
            minLength: 0
            maxLength: 2000
    externalRoomKeyType:
      type: string
      description: Simple type for representing room key request type. 'HardKey' = request for physical key card with RFID; 'MobileKey' = request for mobile key (no physical key); 'PinCode' = request for PinCode; 'KeyPayload' = request Key image from DLS System
      enum:
      - HardKey
      - MobileKey
      - PinCode
      - KeyPayload
    roomOwnershipType:
      type: object
      description: Define the search criteria for retrieving room ownership records
      properties:
        roomOwnershipId:
          description: Unique Id for Room Owner record.
          type: integer
        contractNumber:
          description: Contract number for room owner.
          type: string
        roomId:
          description: Room Id of room owner.
          type: string
        roomCategory:
          description: Room Category of the room ownership record.
          type: string
        roomType:
          description: Room Type of the room ownership record.
          type: string
        startDate:
          description: Start Date of the room ownership record.
          type: string
          format: date
          maxLength: 8
        endDate:
          description: End Date of the room ownership record.
          type: string
          format: date
          maxLength: 8
        profileId:
          description: Profile ID of the room ownership record.
          $ref: '#/components/schemas/uniqueID_Type'
        status:
          description: Status of the room ownership record.
          type: string
    messageStatusType:
      type: string
      description: Status of the Message.
      enum:
      - Mr
      - Nr
    movedInHouseGuest:
      type: object
      description: 'Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room''s occupancy level has been compromised. - The room''s pricing is NOT available.'
      properties:
        oldRates:
          description: Collection of old room rate information on a daily basis.
          $ref: '#/components/schemas/dailyRatesType'
        newRates:
          description: Collection of new room rate information on a daily basis.
          $ref: '#/components/schemas/dailyRatesType'
        effectiveRates:
          description: Collection of effective rates per stay dates per guest to be applied on reservation including its shares.
          $ref: '#/components/schemas/effectiveRatesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    reservationForCCAuthType:
      type: object
      description: Reservation details, including a list of the associated payment methods.
      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'
        guestFirstName:
          type: string
          minLength: 0
          maxLength: 80
        room:
          type: string
          minLength: 0
          maxLength: 20
        paymentMethods:
          $ref: '#/components/schemas/reservationPaymentMethodsType'
        confirmationNo:
          description: Reservation confirmation number.
          $ref: '#/components/schemas/uniqueID_Type'
        arrivalDate:
          description: Arrival date of the reservation. Uses the hotel's time zone.
          type: string
          format: date-time
        departureDate:
          description: Departure date of the reservation. Uses the hotel's time zone.
          type: string
          format: date-time
        reservationStatus:
          description: reservation statuses for credit card authorizations.
          $ref: '#/components/schemas/batchCCAuthReservationStatusType'
    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.
          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.
          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
    dailyDocketType:
      type: array
      description: log book entry.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/dailyDocketEntryType'
    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'
        scheduledRoomMoveOut:
          description: This flag will be set to true  for rooms assigned to reservations that are scheduled to  move to another room.
          type: boolean
        scheduledRoomMoveOutTime:
          description: This time indicates when the reservation is scheduled to move out of the room. Uses the hotel's time zone.
          type: string
          format: date-time
    keyOptionsResponseType:
      type: object
      description: This contains code and description information for key options.
      properties:
        keyOptionsCode:
          description: key options code.
          type: string
          minLength: 0
          maxLength: 40
        keyOptionDescription:
          description: key options description.
          type: string
          minLength: 0
          maxLength: 40
        isEnabled:
          description: Indicates that the keyOption is enabled for this key.
          type: boolean
        default:
          description: Indicates that this keyOption is a default access.
          type: boolean
    transactionDiversionRuleLevelType:
      type: string
      description: Reservation level.
      enum:
      - Property
      - Reservation
    reservation:
      type: object
      description: 'Validation checks includes the following: - Reservation is not valid to be checked in. - Split is still required before the reservation can be checked in. - Room information is missing. - Payment information is missing. - The status of the room needs to be reviewed. - Sharers was impacted. The check-in process affected the reservation details of shared guests on the reservation. - Sharers was not impacted. The check-in process has not affected the reservation details of shared guests on the reservation.'
      properties:
        reservation:
          type: object
          description: Criteria element to check-in a reservation
          properties:
            roomId:
              description: Expected room no. If this attribute is included, then Opera will check if the currently configured room no in the database matches this value.
              type: string
              minLength: 0
              maxLength: 20
            checkOutTime:
              description: Request to update the checkout time.
              type: string
              format: date-time
            startCheckInProcessTime:
              description: Represents the time the user starts the check in process.
              type: string
              format: date-time
            endCheckInProcessTime:
              description: Represents the time the user compeletes the check in process.
              type: string
              format: date-time
            lockHandle:
              description: An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.
              type: number
            profilePrivacyPrompted:
              description: Dictates whether Profile privacy stop in check in is prompted.
              type: boolean
            ignoreWarnings:
              description: Dictates whether to ignore warnings ( e.g. room availability ) before check in.
              type: boolean
            stopCheckin:
              description: Indicates the Stop Check In reservation Global Alert flag.
              type: boolean
            printRegistration:
              description: Flag for Print Registration Card
              type: boolean
            overrideAdvancePaymentValidation:
              description: Flag to override advance payment validation.
              type: boolean
            checkInInitiatedBy:
              description: This indicates who initiated the Check In/Advance Check In. Advance Check In functionality is available when the Advance Check In OPERA Control is active.
              type: string
              minLength: 0
              maxLength: 40
        fetchReservationInstruction:
          description: Instructions to fetch reservations .
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/checkedInReservationInstructionType'
        includeNotifications:
          description: When "true" alerts and comments are fetched. When "false", these alerts and comments are not retrieved.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    nameValueModuleType:
      type: string
      enum:
      - Reservation
      - Folio
      - Profile
      - Fintrix
    confDeliveryInfoTypes:
      type: array
      description: List of confirmation letter delivery methods and their status
      maxItems: 4
      items:
        $ref: '#/components/schemas/confDeliveryInfoType'
    scheduledRoomMoveInfoType:
      description: Scheduled Room Move information.
      type: object
      properties:
        moveStatus:
          description: Scheduled Room Move Status.
          $ref: '#/components/schemas/scheduledRoomMoveStatusType'
        moveComments:
          type: string
          description: Comments about scheduled room move.
          minLength: 0
          maxLength: 200
        moveInRoomOccupancyInfo:
          description: Scheduled Move In Room Occupancy Information.
          $ref: '#/components/schemas/roomOccupancyType'
        estimatedMoveTime:
          type: string
          description: Estimated Move Time.
          format: date-time
        moveOutRoomId:
          type: string
          description: Scheduled Move Out Room Id.
          minLength: 0
          maxLength: 20
        moveOutRoomType:
          type: string
          description: Scheduled Move Out Room Type.
          minLength: 0
          maxLength: 20
    reservationQueuePriorityNumber:
      type: object
      description: Request to change the current priority of a reservation in Queue for Check-In.
      properties:
        priority:
          description: Priority which should be assigned to the reservation in Queue. If null, the topmost priority(1) will be assigned. All other reservations in the queue will be adjusted accordingly.
          type: integer
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    unassignedRoomsSummaryType:
      type: object
      description: Indicates summary of the unassigned rooms.
      properties:
        count:
          description: Number of reservations with unassigned rooms.
          type: string
          minLength: 4
          maxLength: 4
    preferenceType:
      type: object
      description: Guest Preference details for the profile.
      properties:
        preferenceValue:
          description: Preference value for display purposes.
          type: string
          minLength: 0
          maxLength: 200
        description:
          description: Preference Description for display purposes.
          type: string
          minLength: 0
          maxLength: 2000
        global:
          description: Whether this preference is property specific or not.
          type: boolean
        source:
          description: Source of the preference.
          type: string
          minLength: 0
          maxLength: 40
        hotels:
          description: If specified preference belongs to the Hotels listed, otherwise it is a global preference.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        preferenceId:
          type: string
          minLength: 0
          maxLength: 20
        excludedPreferencesCount:
          description: Specifies the count of preferences excluded for the attached reservation preference.
          type: integer
        copyToProfile:
          description: Specifies whether to copy the reservation preference to the profile or not.
          type: boolean
    tierAdministrationType:
      type: string
      description: Do not upgrade membership. The membership may be downgraded.
      enum:
      - Disabled
      - NoUpgrade
    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
    alertGuestInfoType:
      type: object
      properties:
        guestName:
          description: Guest Name.
          type: string
          minLength: 0
          maxLength: 200
        membership:
          description: Membership information of the guest.
          $ref: '#/components/schemas/membershipType'
        vipStatus:
          description: VIP status of the guest.
          $ref: '#/components/schemas/vIPStatusType'
        lastHotelCode:
          description: Hotel code of the last stay location of the guest.
          type: string
          minLength: 0
          maxLength: 20
        lastStayDate:
          description: Last stay date at the property.
          type: string
          format: date
          maxLength: 8
        totalStay:
          description: Holds total number of days that the guest have stayed in the property.
          type: integer
        comments:
          description: Additional alert information regarding the membership of the guest.
          type: string
        preference:
          description: Additional alert information regarding the guest.
          type: string
        preference2:
          description: Additional mandatory alert information regarding the guest preferences.
          type: string
        guestPreferredLanguage:
          description: Holds the language preferred by the guest.
          $ref: '#/components/schemas/languageType'
        totalBrandStay:
          description: Holds total number of days that the guest have stayed in the properties for the same brand.
          type: integer
        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
    roomRateAvailReasonType:
      type: string
      description: Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
      enum:
      - Available
      - Restricted
      - RestrictedDueToInventory
      - RestrictedDueToOccupancy
      - RestrictedDueToItemInventory
    roomKeyInfo:
      type: object
      description: Response of fetch room keys operation.
      properties:
        totalAuthorization:
          description: Total Authorization on a reservation.
          type: number
        incidentalLimit:
          description: Incidental limit on a reservation.
          type: number
        roomKeysInfoList:
          description: Collection of Room Keys information.
          $ref: '#/components/schemas/roomKeysInfoListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    updateRoomKeys:
      type: object
      description: Collection of error and warning if any.
      properties:
        warnings:
          description: Details of the warnings.
          $ref: '#/components/schemas/warningsType'
        errors:
          description: Details of the errors.
          $ref: '#/components/schemas/errorsType'
    configPostingAttributesType:
      type: object
      description: A config Package posting attributes type.
      properties:
        addToRate:
          description: The package price is added to the room rate.
          type: boolean
        printSeparateLine:
          description: The package price is printed on separate line of the folio.
          type: boolean
        sellSeparate:
          description: Can the package be sold separate from rate plan code?
          type: boolean
        postNextDay:
          description: package charges will be posted next business day.
          type: boolean
        forecastNextDay:
          description: Package will be forecasted for consumption the next business day.
          type: boolean
        deliveryTimeRequired:
          description: Indicates whether a delivery time is required for the package.
          type: boolean
        webBookable:
          description: Can package be sold via Web channel.
          type: boolean
        formula:
          description: The custom formula used for this package, if any.
          type: string
          minLength: 0
          maxLength: 2000
        formulaFunctionName:
          description: The custom formula function name used for this package, if any.
          type: string
          minLength: 0
          maxLength: 2000
        formulaFunctionArguments:
          description: The function argument name-value combination accepted by the custom formula used for this package.
          $ref: '#/components/schemas/functionArgumentsType'
        startTime:
          description: Start time the package is valid.
          type: string
        endTime:
          description: End time the package is valid.
          type: string
        catering:
          description: Is package used for catering?
          type: boolean
        postingRhythm:
          description: The posting rhythm for this package.
          $ref: '#/components/schemas/packagePostingRhythmType'
        priceCalculationRule:
          description: The price calculation rule for this package.
          $ref: '#/components/schemas/packageCalculationRuleType'
        ticket:
          description: Indicates whether a package is configured as a ticket or not.
          type: boolean
        inventoryItems:
          description: Package Code Inventory Items type.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/pkgInventoryItemType'
        calculatedPrice:
          description: Calculated Package Price based from Number of Adults, Children and Calculation Rule.
          type: number
    traceResolveType:
      type: object
      properties:
        resolvedOn:
          description: Date the trace was resolved
          type: string
          format: date
          maxLength: 8
        resolvedBy:
          description: User that resolved the trace
          type: string
    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
    keyOptionsType:
      type: object
      description: This contains code and description information for key options.
      properties:
        keyOptionsCode:
          description: key options code.
          type: string
          minLength: 0
          maxLength: 40
        keyOptionDescription:
          description: key options description.
          type: string
          minLength: 0
          maxLength: 40
    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
    ratePlanRatingType:
      type: string
      description: Possible Rate plan rating values.
      enum:
      - MostImportant
      - Important
      - SomewhatImportant
      - LessImportant
      - LeastImportant
      - NoValueSet
    masterInfoType:
      type: object
      properties:
        codeInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/codeInfoType'
        codeType:
          $ref: '#/components/schemas/masterType'
    transportInfoType:
      type: object
      properties:
        comments:
          type: string
          minLength: 0
          maxLength: 2000
        type:
          type: string
          minLength: 0
          maxLength: 20
        transportCode:
          type: string
          minLength: 0
          maxLength: 20
        carrierCode:
          type: string
          minLength: 0
          maxLength: 20
        stationCode:
          type: string
          minLength: 0
          maxLength: 20
        dateTime:
          type: string
          format: date-time
        transportationReqd:
          type: boolean
    packageTransactionCodeType:
      type: object
      properties:
        description:
          description: The description of the code.
          type: string
          minLength: 0
          maxLength: 200
        code:
          description: Posting / transaction code.
          type: string
          minLength: 0
          maxLength: 20
        type:
          description: Code is inclusive or exclusive of other charges such as taxes.
          $ref: '#/components/schemas/amountDeterminationType'
    roomsHoldsType:
      type: array
      description: List of rooms, reason, and comments.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomsHoldType'
    resDepositPoliciesType:
      type: array
      description: A list of deposit policies attached with the reservation.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resDepositPolicyType'
    reservationProfileType:
      type: object
      properties:
        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'
        profile:
          description: Provides detailed information regarding either a company or a customer profile.
          $ref: '#/components/schemas/profileType'
        reservationProfileType:
          $ref: '#/components/schemas/resProfileTypeType'
    wakeUpCallType:
      type: object
      description: Criteria to search and retrieve wake up calls.
      properties:
        reservationInfo:
          description: Hotel room in which wake up call is to ring.
          $ref: '#/components/schemas/wakeUpCallResvInfoType'
        callTime:
          description: Time on which wake up call is set. Uses the hotel's time zone.
          type: string
          format: date-time
        followUpCallTime:
          description: Follow up call time. Uses the hotel's time zone. Uses the hotel's time zone.
          type: string
          format: date-time
        isFollowUpCall:
          description: Is the call type follow up.
          type: boolean
        status:
          description: Time on which wake up call is set.
          $ref: '#/components/schemas/wakeUpCallStatusType'
        processedDate:
          description: Date on which wake up call was processed.
          type: string
          format: date
          maxLength: 8
        processedTime:
          description: Time on which wake up call was processed.
          type: string
        instructions:
          description: Special instructions for the wake up call.
          type: string
        timeSpan:
          description: Date Range to set the Wakeup calls. Only used to create a wake up call.
          $ref: '#/components/schemas/timeSpanType'
        newCallTime:
          description: New Time on which wake up call is set. Used to change the Followup Call time
          type: string
          format: date-time
        newFollowUpCallTime:
          description: New Follow up call time.Used to change the Followup Call time.
          type: string
          format: date-time
        createDateTime:
          description: Time stamp of the creation. Uses the hotel's 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.
          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
    moveInHouseGuest:
      type: object
      description: To move a reservation, the reservation needs to be in Checked-In state.
      properties:
        criteria:
          description: Defines search criteria needed to configure a room to a reservation.
          type: object
          properties:
            hotelId:
              type: string
              minLength: 0
              maxLength: 20
            reservationIdList:
              $ref: '#/components/schemas/reservationIdList'
            roomId:
              description: Room identifier which the reservation will hold.
              type: string
              minLength: 0
              maxLength: 20
            overrideInstructions:
              description: If this element is present, override flags will be set when configuring the room to the reservation.
              $ref: '#/components/schemas/reservationRoomSelectionOverrideType'
            includedSharers:
              description: Valid share reservation identifier.
              type: array
              items:
                $ref: '#/components/schemas/reservationIdList'
            updateRoomTypeCharged:
              description: Update the Room Type used for the Rate calculation.
              type: boolean
            includeDepartureRooms:
              description: Indicates if departure rooms are to be included for room assignment.
              type: boolean
            roomNumberLocked:
              description: Update the do not move flag used to locking the reservation room number.
              type: boolean
            oldRoomStatus:
              description: On a successful RoomMove, this status will be configured in the reservation's previous room.
              $ref: '#/components/schemas/housekeepingRoomStatusType'
            reasonCode:
              description: Identifies the room move reason code.
              $ref: '#/components/schemas/codeType'
            description:
              description: Description of why room is moved.
              $ref: '#/components/schemas/stringLength2000'
            orderBy:
              description: When Forecast Rotation is checked, future reservation's point calculation will be considered while determing the room order for the assignment.
              $ref: '#/components/schemas/hotelRoomsOrderBy'
            roomSegmentBeginDate:
              type: string
              description: Defines the start date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.
              format: date
            roomSegmentEndDate:
              type: string
              description: Defines the end date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.
              format: date
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    dateTimeSpanType:
      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:
        startDateTime:
          type: string
          format: date-time
        endDateTime:
          type: string
          format: date-time
    overrideInstructionType:
      type: object
      description: Type for Overrides. Contains information for the override action performed while booking a reservation.
      properties:
        description:
          description: The description of the restriction for which the override was done.
          type: string
          minLength: 0
          maxLength: 2000
        date:
          description: The date when the override was done.
          type: string
          format: date
          maxLength: 8
        type:
          description: The type of override done. If done for Availability, then it will be AVAILABILITY.
          type: string
          minLength: 0
          maxLength: 80
        userId:
          description: Login ID of the user who performed the override.
          type: string
          minLength: 0
          maxLength: 40
        reasonCode:
          description: The override reason code.
          type: string
          minLength: 0
          maxLength: 20
        reasonDescription:
          description: The override reason description.
          type: string
          minLength: 0
          maxLength: 2000
    reservationMembershipType:
      type: object
      properties:
        comment:
          description: Additional comments regarding to the membership.
          $ref: '#/components/schemas/paragraphType'
        newMembershipNumber:
          description: Card Number of the membership.
          type: string
        nameOnCard:
          description: Name to be displayed on the membership card.
          type: string
        programDescription:
          description: Description of the membership program.
          type: string
        membershipLevel:
          description: Indicates the membership level.
          type: string
        membershipLevelDescription:
          description: Indicates the membership level description.
          type: string
          minLength: 0
          maxLength: 200
        membershipClass:
          description: Indicates the membership class.
          type: string
        earningPreference:
          description: Earning preference to the membership.
          $ref: '#/components/schemas/membershipEarningPreferenceType'
        inactive:
          description: Indicates whether membership is active or inactive.
          type: boolean
        benefits:
          description: benefits for the membership.
          $ref: '#/components/schemas/benefitsType'
        tierAdministration:
          description: Defines the degree of participation for this membership in the tier management portion of the program.
          $ref: '#/components/schemas/tierAdministrationType'
        downgrade:
          description: Defines how downgrading will be handled for this membership.
          $ref: '#/components/schemas/downgradeType'
        reIssueNewCard:
          description: The status of issuing new membership card to the member.
          $ref: '#/components/schemas/cardReIssueType'
        excludeFromBatch:
          description: True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.
          type: boolean
        upgradeDescription:
          description: Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.
          type: string
          minLength: 0
          maxLength: 32000
        downgradeDescription:
          description: Indicates information regarding the member's possible downgrades.
          type: string
          minLength: 0
          maxLength: 32000
        rating:
          description: Value Rating Type Description for this membership.
          type: string
        membershipEnrollmentCode:
          description: Indicates how the guest enrolled in the program.
          type: string
          minLength: 0
          maxLength: 20
        memberStatus:
          description: Indicates where the guest is in the membership enrollment process.
          type: string
          minLength: 0
          maxLength: 20
        currentPoints:
          description: Profile MemberShip Points.
          type: number
        pointsLabel:
          description: Label used to refer to points for this membership type
          type: string
          minLength: 0
          maxLength: 20
        enrollmentSource:
          description: Source from where the enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        enrollmentResort:
          description: Resort/CRO where enrollment is done.
          type: string
          minLength: 0
          maxLength: 20
        preferredCard:
          description: Preferred Card.
          type: boolean
        membershipId:
          description: Card Number of the membership.
          type: string
        membershipType:
          description: Type of membership.
          type: string
        primaryMembershipYn:
          description: Indicator if Membership is a Primary Membership.
          type: string
          minLength: 0
          maxLength: 1
        primaryMembership:
          description: Boolean indicator set to True implies membership is a Primary Membership.
          type: boolean
        membershipIdNo:
          description: Membership ID Number.
          type: integer
        playerRanking:
          description: Ranking assigned to the Player Profile by the Gaming system.
          type: integer
        centralSetup:
          description: Indicates how the award points for this membership type will be managed.
          type: boolean
        signupDate:
          description: Indicates when the member signed up for the loyalty program.
          type: string
          format: date
          maxLength: 8
        effectiveDate:
          description: Indicates the starting date.
          type: string
          format: date
          maxLength: 8
        expireDate:
          description: Indicates the ending date.
          type: string
          format: date
          maxLength: 8
        expireDateExclusiveIndicator:
          description: When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
        linkMembership:
          type: boolean
        primary:
          type: boolean
      description: Detailed information of the memberships.
    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: 60
        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'
    itemInfoType:
      type: object
      description: Basic information regarding an Item.
      properties:
        description:
          description: Detail description of an item.
          type: string
          minLength: 0
          maxLength: 2000
        availabilityPeriod:
          description: Defines a Time period when the item is available.
          $ref: '#/components/schemas/timeWindowType'
        timeSpan:
          description: Date Range to get the inventories of the items.
          $ref: '#/components/schemas/timeSpanType'
        quantity:
          description: Quantity of hold Item
          type: integer
        itemHoldId:
          description: ID reference for the hold Item
          type: number
        code:
          description: Item Code.
          type: string
          minLength: 0
          maxLength: 20
        name:
          description: Name of an item.
          type: string
          minLength: 0
          maxLength: 200
        itemPool:
          description: Indicates if it is an item pool. Not applicable for Item within the Item Pool.
          type: boolean
        sellSeparate:
          description: If true indicates that item is allowed to sell separately.
          type: boolean
        sellInReservation:
          description: If true indicates that item can be sold in reservation.
          type: boolean
        sellInEvent:
          description: If true indicates that item can be sold in event.
          type: boolean
        requiredForBooking:
          description: If true indicates that item is required for the reservation.
          type: boolean
        fixedCharge:
          description: If true indicates that item has fixed charge when it is attached to a reservation.
          type: boolean
        outsideStay:
          description: If true indicates that item could be held outside of the reservation stay days.
          type: boolean
        defaultDuration:
          description: Define the default duration in days when booking the item.
          type: integer
    stayRoominfo:
      type: object
      description: Request which contains parameters needed to swap or shift rooms
      properties:
        roomId:
          description: Room identifier which the reservation will hold.
          type: string
          minLength: 0
          maxLength: 20
        arrivalDate:
          description: Identifies Reservation arrival date.
          type: string
          format: date
          maxLength: 8
        roomType:
          description: Identifies the reservations which are same room type/room category
          type: string
          minLength: 0
          maxLength: 20
    basicEmailType:
      type: string
      description: Email address
      minLength: 0
      maxLength: 2000
    paymentMethodsSummaryType:
      type: object
      properties:
        establishedCount:
          description: Reservations count with payment method established.
          type: string
          minLength: 4
          maxLength: 4
        unestablishedCount:
          description: Reservations count with no payment method established.
          type: string
          minLength: 4
          maxLength: 4
    awardVouchersType:
      type: array
      description: This stores the Membership Awards code applied on the reservation.
      maxItems: 5
      items:
        type: object
        properties:
          awardCode:
            description: Membership Award code applied on the reservation.
            type: string
            minLength: 0
            maxLength: 20
          voucherNo:
            description: Membership Award number.
            type: string
            minLength: 0
            maxLength: 80
    deliverQueueRoomsTextMessage:
      type: object
      description: Request to deliver a text message via Queue Reservations (for a guest) or Queue Rush (for housekeeping).
      properties:
        criteria:
          $ref: '#/components/schemas/queueRoomsTextCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    profileCommissionType:
      type: object
      description: This is the preconfigured routing instruction type.
      properties:
        hotelId:
          description: Hotel Code for the commission being used for a profile.
          type: string
          minLength: 0
          maxLength: 20
        commissionCode:
          description: commission Code for a profile.
          type: string
          minLength: 0
          maxLength: 20
        bankAccount:
          description: Bank account used for the commission for a profile.
          type: string
          minLength: 0
          maxLength: 20
        paymentMethod:
          description: Type of payment associated with the bank account.
          $ref: '#/components/schemas/commissionPaymentMethods'
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
    serviceRequest:
      type: object
      description: Service request.
      properties:
        serviceRequestId:
          description: Unique identifier of the service request.
          $ref: '#/components/schemas/uniqueID_Type'
        hotelId:
          description: Hotel Code of the service request.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Service request code.
          type: string
          minLength: 0
          maxLength: 20
        status:
          description: The status of the service request.
          $ref: '#/components/schemas/serviceRequestStatusType'
        priority:
          description: The priority level of the service request.
          type: string
          minLength: 0
          maxLength: 20
        department:
          description: The department that is associated with the service request code.
          $ref: '#/components/schemas/codeDescriptionType'
        reservationIdList:
          description: Unique identifier of the reservation.
          $ref: '#/components/schemas/reservationIdList'
        profileId:
          description: Unique identifier of the guest.
          $ref: '#/components/schemas/profileId'
        guestName:
          description: The guest name.
          type: string
          minLength: 0
          maxLength: 200
        room:
          description: The room number in which the service request was created.
          type: string
          minLength: 0
          maxLength: 20
        openDate:
          description: The date-time in which the service request was opened. Uses the hotel's time zone.
          type: string
          format: date-time
        guaranteedBy:
          description: The user who guaranteed the completion of the service request.
          type: string
          minLength: 0
          maxLength: 100
        comment:
          description: Description of the service request.
          type: string
          minLength: 0
          maxLength: 2000
        action:
          description: Description of the action taken to complete the request.
          type: string
          minLength: 0
          maxLength: 200
        guestContactMethod:
          description: Communication method picked from guest profile.
          type: string
          minLength: 0
          maxLength: 100
        completionDate:
          description: The date-time in which the service request was completed. Uses the hotel's time zone.
          type: string
          format: date-time
        closedDate:
          description: The date-time in which the service request was closed. Uses the hotel's time zone.
          type: string
          format: date-time
        closedBy:
          description: The user who closed the service request.
          type: string
          minLength: 0
          maxLength: 80
        closeDescription:
          description: The follow up description.
          type: string
          minLength: 0
          maxLength: 2000
    identificationType:
      type: object
      description: Identification information of the customer.
      properties:
        idType:
          description: Identification Type. Eg Passport, Driving License etc.
          type: string
          minLength: 0
          maxLength: 40
        idNumber:
          description: Identification Number.
          type: string
          minLength: 0
          maxLength: 80
        idNumberMasked:
          description: Masked Identification Number.
          type: string
          minLength: 0
          maxLength: 80
        issuedCountry:
          description: The country where Identification was issued.
          type: string
          minLength: 0
          maxLength: 20
        issuedDate:
          description: Issued date of Identification.
          type: string
          format: date
          maxLength: 8
        issuedPlace:
          description: The place where Identification was issued.
          type: string
          minLength: 0
          maxLength: 80
        expirationDate:
          description: Expiration date of Identification.
          type: string
          format: date
          maxLength: 8
        registeredProperty:
          description: Property where the identification belongs to.
          type: string
          minLength: 0
          maxLength: 20
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    articleInfoType:
      type: object
      description: Information regarding an article.
      properties:
        description:
          description: Description of the article.
          type: string
          minLength: 0
          maxLength: 2000
        transactionCode:
          description: Transaction code to which the article belongs.
          type: string
          minLength: 0
          maxLength: 20
        price:
          description: Default price of the article.
          $ref: '#/components/schemas/currencyAmountType'
        postIt:
          description: Post it information of the article.
          $ref: '#/components/schemas/articlePostItType'
        universalProductCode:
          description: Unique Universal product code of the article.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel code to which the article belongs.
          type: string
          minLength: 0
          maxLength: 20
        articleCode:
          description: Unique code of the article.
          type: string
          minLength: 0
          maxLength: 20
        inactive:
          description: Indicates whether the article is inactive or not.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    relationshipProfileType:
      type: object
      properties:
        customer:
          description: Detailed information of the customer
          $ref: '#/components/schemas/customerType'
        company:
          description: Detailed information of the Company.
          $ref: '#/components/schemas/companyType'
        telephone:
          description: Information on telephone details for the customer/company
          $ref: '#/components/schemas/telephoneInfoType'
        address:
          description: Information on address details for the customer/company
          $ref: '#/components/schemas/addressInfoType'
        email:
          description: Information on email address for the customer/company
          $ref: '#/components/schemas/emailInfoType'
        uRLs:
          description: Information on web url/address for the customer/company
          $ref: '#/components/schemas/uRLInfoType'
        primaryOwner:
          description: Primary Owner of the profile
          $ref: '#/components/schemas/ownerType'
        profileIdList:
          description: Original profile details for which the relationships was created
          $ref: '#/components/schemas/uniqueIDListType'
        changeProfileIdList:
          description: Updated/changed profile details for the relationships created
          $ref: '#/components/schemas/uniqueIDListType'
        primary:
          description: Indicates if this relationship is the primary relationship.
          type: string
          minLength: 0
          maxLength: 20
        id:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        statusCode:
          description: Status of the profile. Active/Inactive
          $ref: '#/components/schemas/profileStatusType'
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
    reservationsInQueue:
      type: object
      description: Response for the operation to fetch Reservations in Queue
      properties:
        reservations:
          description: List of reservation currently in queue.
          $ref: '#/components/schemas/reservationList'
        roomStatusInfo:
          description: Master Information regarding the room status for each of the rooms included in the response.
          $ref: '#/components/schemas/hotelRoomsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    policyAmountPercentType:
      type: object
      description: Defines the percentage basis for calculating the fee amount or the amount.
      properties:
        basisType:
          description: Provides the basis for how the amount of the guarantee is calculated.
          $ref: '#/components/schemas/policyBasisTypeType'
        nights:
          description: The number of nights of the hotel stay that are used to calculate the fee amount.
          type: integer
        percent:
          description: The percentage used to calculate the amount.
          type: number
          minimum: 0
          maximum: 100
        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
    resInventoryItemType:
      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
        item:
          description: Specifies Items and its attributes. When used for data manipulation for Items setup on reservation, etc only code is considered. Other Attributes are for used to provide information during fetch operation.
          $ref: '#/components/schemas/itemInfoType'
        quantity:
          description: Number of items booked.
          type: integer
        timeSpan:
          description: Begin and end date and time of the items applicability.
          $ref: '#/components/schemas/dateRangeType'
        source:
          description: If exists specifies whether the item is setup due to a Rate Plan, Package or a Block.
          $ref: '#/components/schemas/resInventoryItemSourceType'
    masterAccountInfoType:
      type: object
      properties:
        masterAccountId:
          description: Unique ID of the Master account.
          $ref: '#/components/schemas/uniqueID_Type'
        masterAccountName:
          description: Name of the Master account.
          type: string
          minLength: 0
          maxLength: 40
    keyOptionsInfo:
      type: object
      description: Response of fetch keyOptions operation.
      properties:
        profileKeyOptions:
          type: array
          description: Key option preferences currently attached to a profile associated with the reservation.
          items:
            $ref: '#/components/schemas/profileKeyOptionsType'
        reservationKeyOptions:
          type: string
          description: Key option preferences currently attached to the reservation.
          minLength: 0
          maxLength: 200
        roomKeyOptions:
          type: string
          description: Key option preferences currently attached to the room assigned to the reservation.
          minLength: 0
          maxLength: 200
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    numericUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Numeric Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/numericUDFType'
    roomType:
      type: object
      description: This type represents the primary room attributes.
      properties:
        scheduledRoomMoveOut:
          description: This flag will be set to true  for rooms assigned to reservations that are scheduled to  move to another room.
          type: boolean
        scheduledRoomMoveOutTime:
          description: It indicates the time of the reservation which is scheduled for move  out. Uses the hotel's time zone.
          type: string
          format: date-time
        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'
        accessible:
          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'
        roomOccupancyInfo:
          $ref: '#/components/schemas/roomOccupancyInfoType'
        componentRoomNumbers:
          description: List of component room numbers.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        rotationRoomId:
          description: Rotation room of the room type.
          type: string
          minLength: 0
          maxLength: 20
    packageCalculationRuleType:
      type: string
      description: Simple type for package caluculation rules.
      enum:
      - FlatRate
      - PerPerson
      - PerAdult
      - PerChild
      - PerRoom
    offsetUnitType:
      type: string
      description: Indicates deadline offset unit type.
      enum:
      - Year
      - Month
      - Day
      - Hour
    advanceCheckInReservationType:
      type: object
      description: Information needed to perform Advance Check In of a Reservation
      properties:
        hotelId:
          description: Resort to which the Reservation belongs.
          type: string
          minLength: 0
          maxLength: 20
        reservationId:
          description: ID of the Reservation that is being Advance Checked In
          $ref: '#/components/schemas/reservationId'
        expectedReturnTime:
          description: Time when the guest is expected to return to perform Check In
          type: string
          format: date-time
        eTRComments:
          description: Comments relating to the Advance Checked In guest's return to the property
          type: string
          minLength: 0
          maxLength: 2000
        reservationCommunication:
          description: Collection of Reservation communication information such as phone numbers and email addresses.
          $ref: '#/components/schemas/resCommunicationType'
        optedForCommunication:
          description: Indicates if the guest has opted for communications pertaining to this reservation.
          type: boolean
        checkInInitiatedBy:
          description: This indicates who initiated the Check In/Advance Check In. Advance Check In functionality is available when the Advance Check In OPERA Control is active.
          type: string
          minLength: 0
          maxLength: 40
    roomPersonsType:
      type: object
      properties:
        frontOfficePersons:
          type: integer
        houseKeepingPersons:
          type: integer
    activityLogType:
      type: object
      properties:
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        module:
          type: string
        logDate:
          type: string
          format: date-time
        refActionId:
          type: number
        logUserId:
          type: integer
        logUserName:
          type: string
        machineStation:
          type: string
        croCode:
          type: string
          minLength: 0
          maxLength: 20
        actionType:
          type: string
          minLength: 0
          maxLength: 100
        actionDescription:
          type: string
          minLength: 0
          maxLength: 2000
        iPAddress:
          description: The IP Address of the machine that performed the activity
          type: string
          minLength: 0
          maxLength: 2000
        deviceCode:
          description: The selected device code
          type: string
          minLength: 0
          maxLength: 2000
    masterType:
      type: string
      enum:
      - Country
      - State
      - AddressType
      - PhoneType
      - RateCategory
      - CalculationRule
      - PostingRythym
      - BillingInstruction
      - TransactionCode
      - DisplaySet
      - MailingActions
      - DistanceType
      - District
      - Territory
      - FiscalRegion
      - InventoryItem
      - Package
      - RoomFeaturePreference
      - SpecialPreference
      - Promotion
      - Department
      - ReservationPreference
      - FacilityTask
      - RoomType
      - RateCode
      - OutOfOrderReason
      - Block
    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
    queueRoomsTextMessageType:
      type: string
      description: Text message will be delivered via Queue Rush, to housekeeping.
      enum:
      - QueueReservation
      - QueueRush
    phoneNumberType:
      type: string
      description: Phone number
      minLength: 0
      maxLength: 40
    membershipTypeLevelType:
      type: object
      properties:
        type:
          description: Code type for Rule Details
          type: string
          minLength: 0
          maxLength: 20
        level:
          description: Description type for Rule Details
          type: string
          minLength: 0
          maxLength: 20
    hotelInterfaceStatusType:
      type: string
      description: Status of the Hotel Interface either STOPPED or RUNNING.
      enum:
      - Stopped
      - Running
      - Waiting
      - StopInitiated
      - StartInitiated
      - RebootInitiated
      - Other
    eCertificateConsumeSourceType:
      type: string
      description: Indicates that OPERA E-Certificate is consumed by hotelPMS.
      enum:
      - Central
      - Web
      - Hotel
    confRecipientInfoType:
      type: object
      properties:
        profileId:
          description: name id of the recipient.
          $ref: '#/components/schemas/profileId'
        formerName:
          description: Last Name of recipient.
          $ref: '#/components/schemas/profileNameType'
        addressInfo:
          description: id of the address where to send confirmation letter.
          $ref: '#/components/schemas/addressInfoType'
        emailInfo:
          description: id of the Email where to send confirmation letter.
          $ref: '#/components/schemas/emailInfoType'
        faxInfo:
          description: id of the Fax where to send confirmation letter.
          $ref: '#/components/schemas/telephoneInfoType'
        telephoneInfo:
          description: id of the Mobile where to send confirmation letter.
          $ref: '#/components/schemas/telephoneInfoType'
        recipientType:
          $ref: '#/components/schemas/profileTypeType'
    upsellInfoType:
      type: object
      description: Information regarding upsell for a reservation.
      properties:
        originalInfo:
          description: Original Values of the reservation prior to upgrade.
          type: object
          properties:
            rateCode:
              description: The Rate Code of the Reservation before it was upgraded
              type: string
              minLength: 0
              maxLength: 20
            totalAmount:
              description: Total Amount of the reservation before it was upgraded.
              $ref: '#/components/schemas/currencyAmountType'
            roomType:
              description: Original Reservation Room Type before being upgraded.
              $ref: '#/components/schemas/codeDescriptionType'
            nights:
              description: The number of nights of the reservation before being upgraded.
              type: integer
        upsellInfo:
          description: Information of a reservation during the process of upgrade.
          type: object
          properties:
            totalUpsellCharge:
              description: Amount that was charged for the upsell.
              $ref: '#/components/schemas/currencyAmountType'
            totalUpsellMoneyAmount:
              description: Total Amount that was charged including upsell.
              $ref: '#/components/schemas/currencyAmountType'
            firstNightUpsellAmount:
              description: First Night Total Amount including Upsell.
              $ref: '#/components/schemas/currencyAmountType'
            firstNightUpsellCharge:
              description: First Night Upsell Charges.
              $ref: '#/components/schemas/currencyAmountType'
            totalUpsellPoints:
              description: Total Upsell Points.
              type: integer
            totalActualRateAmount:
              description: Actual Total Room Rate for the Target Upsell Room Type.
              $ref: '#/components/schemas/currencyAmountType'
            roomType:
              description: Reservation Room Type for Upsell.
              $ref: '#/components/schemas/codeDescriptionType'
            roomLongDescription:
              description: Detail description of the Room Type.
              type: string
              minLength: 0
              maxLength: 2000
            ruleId:
              description: Upsell Rule Id.
              type: integer
            ruleCode:
              description: Upsell rule code
              type: string
              minLength: 0
              maxLength: 20
            ruleDescription:
              description: Upsell rule description
              type: string
              minLength: 0
              maxLength: 2000
            percentageSavings:
              description: Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)
              type: number
              minimum: 0
              maximum: 100
            upsellDate:
              description: The date on which reservation is upgraded.
              type: string
              format: date
              maxLength: 8
            upsellUser:
              description: User who upgraded the reservation.
              type: string
              minLength: 0
              maxLength: 40
    dailyDocketEntryType:
      type: object
      description: Log book entry.
      properties:
        hotelId:
          description: Hotel Code of the log book entry.
          type: string
          minLength: 0
          maxLength: 20
        docketEntryId:
          description: Unique identifier of the log book entry.
          $ref: '#/components/schemas/uniqueID_Type'
        department:
          description: Department ID in which the log book entry belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        roleUserEntry:
          description: Role or User in which the log book entry belongs to.
          $ref: '#/components/schemas/roleUserEntryType'
        entryDate:
          description: The date-time in which the log book entry was created. Uses the hotel's time zone.
          type: string
          format: date-time
        details:
          description: Entry details.
          type: string
          minLength: 0
          maxLength: 2000
        history:
          description: Creation date time, Creator Id, last modification date time and last Modifier Id.
          $ref: '#/components/schemas/changeHistoryType'
    iATAInfoType:
      type: object
      description: IATA Information of the profile.
      properties:
        iATACompany:
          description: IATA Company Detail.
          type: string
          minLength: 0
          maxLength: 20
        iATAConsortia:
          description: IATA Consortia.
          type: string
          minLength: 0
          maxLength: 40
        iATAValidationResult:
          description: IATA Validation Result.
          type: boolean
    reservationCertificateType:
      type: string
      description: Certificate is incentive.
      enum:
      - Reward
      - Incentive
    awardKindType:
      type: string
      description: Indicates that this is electronic certificate.
      enum:
      - Paper
      - ECertificate
    preferenceTypeType:
      type: object
      description: Preference details for the profile.
      properties:
        preference:
          description: Collection of Preferences for the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/preferenceType'
        preferenceType:
          description: Preference group code.
          type: string
          minLength: 0
          maxLength: 20
        preferenceTypeDescription:
          description: Preference group description.
          type: string
        sequence:
          description: Preference Sequence.
          type: string
        maxQuantity:
          description: Maximum quantity of preferences allowed per preference group.
          type: integer
        availableQuantity:
          description: Available quantity of preferences (maximum quantity - Existing preferences)per preference group.
          type: integer
        maxResortUsedQuantity:
          description: Maximum quantity of preferences used by any resort per preference group.
          type: integer
        reservationPreference:
          description: Whether this preference is reservation preference or not.
          type: boolean
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
    attachmentsType:
      type: array
      description: Attachment List.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/attachmentType'
    wakeUpCallStatusType:
      type: string
      description: Statuses of the wake up call.
      enum:
      - Completed
      - NoAnswer
      - Cancelled
      - Pending
    guestCountsType:
      type: object
      description: A collection of GuestCount by age group.
      properties:
        childAges:
          description: Defines Children's Ages. Number of children ages mentioned may mot match with children counts.
          $ref: '#/components/schemas/childAgesType'
        childBuckets:
          description: Defines children counts with Age Qualifying Group(Child Bucket#1) classification.
          $ref: '#/components/schemas/childBucketsType'
        adults:
          description: Defines the number of Adults.
          type: integer
        children:
          description: Defines the number of Children.
          type: integer
    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.
          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.
          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
    swapRooms:
      type: object
      description: To quickly swap or shift rooms for two reservations that are for the same arrival date and room type
      properties:
        sourceRoom:
          description: Source Room request which defines parameters needed to swap rooms.
          $ref: '#/components/schemas/stayRoominfo'
        targetRoom:
          description: Target Room request which defines parameters needed to swap rooms.
          $ref: '#/components/schemas/stayRoominfo'
        swapShiftOverrideInstruction:
          description: List of overrides available when swapping or shifting rooms.
          $ref: '#/components/schemas/swapShiftOverrideInstructionType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    ticketsType:
      type: array
      description: Collection of TicketType objects.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/ticketType'
    fixedChargeType:
      type: object
      description: Holds fixed charge information.
      properties:
        schedule:
          description: Holds schedule of fixed charge.
          $ref: '#/components/schemas/fixedChargeScheduleType'
        charge:
          description: Holds specific details of fixed charge.
          $ref: '#/components/schemas/fixedChargeDetailType'
        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
    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
    confDeliveryInfoType:
      type: object
      properties:
        communicationType:
          description: CommunicationType through which the confirmation letter was sent.
          $ref: '#/components/schemas/confDeliveryMethod'
        lastStatus:
          description: Status of last sent confirmation.
          $ref: '#/components/schemas/sentConfirmationStatus'
        lastAttempted:
          description: Date of last attempt to send confirmation letter.
          type: string
          format: date-time
        successfulTries:
          description: Number of success letter sent.
          type: integer
    uRLType:
      type: object
      description: Web site address, in IETF(The Internet Engineering Task Force) specified format.
      properties:
        value:
          type: string
          description: Property Value
        type:
          description: Defines the purpose of the URL address, such as personal, business, public, etc.
          type: string
          minLength: 0
          maxLength: 20
        typeDescription:
          description: Describes the Type code
          type: string
          minLength: 0
          maxLength: 2000
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
    customChargeExemptionDatesType:
      type: array
      description: Contains List of Custom Charge Exemption information for a day.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/customChargeExemptionDateType'
    codeInfoType:
      type: object
      description: ''
      properties:
        description:
          type: string
          minLength: 0
          maxLength: 80
        addtionalCodeInfo:
          $ref: '#/components/schemas/addtionalCodeInfoType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        code:
          type: string
          minLength: 0
          maxLength: 20
    companyType:
      type: object
      properties:
        companyName:
          description: Name of the company.
          type: string
          minLength: 0
          maxLength: 40
        companyName2:
          description: Second Name of the company.
          type: string
          minLength: 0
          maxLength: 40
        companyName3:
          description: Third Name of the company.
          type: string
          minLength: 0
          maxLength: 40
        alternateName:
          description: Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.
          type: string
          minLength: 0
          maxLength: 80
        alternateLanguage:
          description: Alternate Language of the company.
          type: string
          minLength: 0
          maxLength: 20
        businessLocale:
          description: A jurisdiction(Territory) in which a company is authorized to do business.
          type: string
          minLength: 0
          maxLength: 40
        iATAInfo:
          description: IATA Information of the profile.
          $ref: '#/components/schemas/iATAInfoType'
        businessTitle:
          description: Business Title.
          type: string
          minLength: 0
          maxLength: 80
        currencyCode:
          description: The code specifying a monetary unit. Use ISO 4217, three alpha code.
          type: string
          minLength: 0
          maxLength: 20
        currencySymbol:
          description: The symbol for the currency, e.g, for currencyCode USD the symbol is $.
          type: string
          minLength: 0
          maxLength: 10
        decimalPlaces:
          description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
          type: integer
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        nationality:
          description: Nationality code identification
          type: string
          minLength: 0
          maxLength: 20
        nationalityDescription:
          description: Nationality code description
          type: string
          minLength: 0
          maxLength: 80
        commissionCode:
          description: Commission code of the company.
          type: string
          minLength: 0
          maxLength: 20
        creditRating:
          description: Credit Rating of the company.
          type: string
          minLength: 0
          maxLength: 20
        corporateIdType:
          description: The type of corporate ID
          type: string
          minLength: 0
          maxLength: 20
        vipStatus:
          description: VIP status of the company.
          type: string
          minLength: 0
          maxLength: 20
        vipDescription:
          description: Description of the VIP status.
          type: string
          minLength: 0
          maxLength: 2000
        blacklist:
          description: This element tells if profile is blacklisted or not.
          type: boolean
    resStatClassificationType:
      type: object
      description: Statistical Classification information for the reservation.
      properties:
        roomType:
          description: Room Type used to calculate statistics for export(DRS).
          type: string
          minLength: 0
          maxLength: 20
        rateTier:
          description: Rate Tier used calculate statistics for export(DRS).
          type: integer
    trxCodesInfoType:
      type: array
      description: List of Transaction codes info.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/trxInfoType'
    changeRelationsType:
      type: object
      description: Detailed information regarding the changes made to relationships for the profile.
      properties:
        id:
          description: Relationship identifier.
          type: string
          minLength: 0
          maxLength: 80
        relation:
          description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 20
        relationDescription:
          description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
        targetRelation:
          description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).
          type: string
          minLength: 0
          maxLength: 20
        targetRelationDescription:
          description: Displays the description of the target relation(Target Profile).
          type: string
          minLength: 0
          maxLength: 200
    stayHistoryListType:
      type: object
      description: A collection of reservation history details attached to Profiles.
      properties:
        reservationInfo:
          description: 'Additional reservation information attached to the profile . Eg : History reservation details'
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayReservationInfoType'
        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
    resCancelPenaltyType:
      type: object
      description: The CancelPenalty class defines the cancellation policy of the hotel facility.
      properties:
        deadline:
          description: Cancellation deadline, absolute or relative.
          $ref: '#/components/schemas/policyDeadlineType'
        amountPercent:
          description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights.
          $ref: '#/components/schemas/policyAmountPercentType'
        penaltyDescription:
          description: Text description of the Penalty in a given language.
          type: string
          minLength: 0
          maxLength: 2000
        offsetUnit:
          $ref: '#/components/schemas/offsetUnitType'
        formattedRule:
          description: Formatted Text Rule of the Cancellation Penalty.
          type: string
          minLength: 0
          maxLength: 2000
        policyCode:
          description: Policy Code.
          type: string
          minLength: 0
          maxLength: 20
        manual:
          description: Flag to indicate if the cancellation policy is manual.
          type: boolean
        nonRefundable:
          description: Indicates if the amount is refundable if booking is canceled.
          type: boolean
        effective:
          description: Indicator if Cancellation Penalty is currently applicable or not.
          type: boolean
    roomKeyInterfaceRightsType:
      type: array
      description: Holds the key encoder right.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomKeyInterfaceRightType'
    reservationAllowedActionsType:
      type: array
      description: Allowed action.
      maxItems: 11
      items:
        $ref: '#/components/schemas/reservationAllowedActionType'
    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'
    hotelRooms:
      type: object
      properties:
        hotelRoomsDetails:
          description: Hotel rooms response based on criteria request.
          $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
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    stringLength200:
      type: string
      description: Used for Character Strings, length 0 to 200.
      maxLength: 200
      minLength: 0
    reservationDisplayColorInfoType:
      description: 'Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION '
      type: object
      properties:
        displayColor:
          description: Display Color of Reservation.
          $ref: '#/components/schemas/colorType'
        colorDefinition:
          description: Definition populated based on OPERA setting RESERVATION_COLOR_DEFINITION.
          $ref: '#/components/schemas/colorDefinitionType'
        colorDescription:
          description: Description populated based on DisplayColor.
          type: string
          minLength: 0
          maxLength: 2000
    languageType:
      type: string
      minLength: 0
      maxLength: 40
    taxType:
      type: object
      description: Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
      properties:
        description:
          type: string
          minLength: 0
          maxLength: 2000
        type:
          description: Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).
          $ref: '#/components/schemas/amountDeterminationType'
        code:
          description: Code identifying the fee (e.g.,agency fee, municipality fee).
          type: string
          minLength: 0
          maxLength: 20
        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
    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
    scheduledRoomMoveStatusType:
      type: string
      description: Flag indicating scheduled room move status.
      enum:
      - Completed
      - Pending
    userInfoType:
      type: object
      description: Opera User Information
      properties:
        userId:
          description: User Id of the Opera User
          type: integer
        userName:
          description: Name of the Opera User
          type: string
          minLength: 0
          maxLength: 40
    trackItItemsType:
      type: array
      description: ''
      maxItems: 4000
      items:
        $ref: '#/components/schemas/trackItItemType'
    requestActionType:
      type: string
      enum:
      - Create
      - Remove
      - Query
    confirmationType:
      type: object
      properties:
        recipientInfo:
          description: Receipient's information.
          $ref: '#/components/schemas/confRecipientInfoType'
        deliveryInfo:
          description: The status of the confirmation letter sent via the specified CommunicationType.
          $ref: '#/components/schemas/confDeliveryInfoTypes'
        confirmationStyleInfo:
          description: Confirmation style.
          $ref: '#/components/schemas/confirmationStyle'
        fromEmail:
          description: Senders Email address.
          type: string
          minLength: 0
          maxLength: 40
        sendTextMessage:
          description: Flag to indicate sending confirmation letter as text message.
          type: boolean
        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
    functionArgumentsType:
      type: array
      description: Collection of function arguments and their corresponding values.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/functionArgumentType'
    roomKeyEncoderType:
      type: object
      properties:
        interfaceId:
          type: string
        encoderId:
          type: string
        workstation:
          type: string
        location:
          type: string
        deviceArea:
          type: string
    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'
    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
    fixedChargeFrequencyType:
      type: string
      description: Yearly.
      enum:
      - O
      - D
      - W
      - M
      - Q
      - Y
    resCancellationPoliciesType:
      type: array
      description: A list of reservation cancellation policies.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resCancellationPolicyType'
    anonymizationStatusType:
      type: string
      description: Guest has been anonymized.
      enum:
      - Requested
      - Anonymized
    characterUDFType:
      type: object
      description: Used to hold user defined field of Character/String Type.
      properties:
        name:
          description: Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: string
          minLength: 0
          maxLength: 2000
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    policyDeadlineType:
      type: object
      description: Cancellation deadline, absolute or relative.
      properties:
        absoluteDeadline:
          description: Defines the absolute deadline. Either this or the offset attributes may be used.
          type: string
          format: date-time
        offsetFromArrival:
          description: The number of days before arrival that allows cancellation without penalties.
          type: integer
        offsetDropTime:
          description: Time on offset day the cancellation penalties applies.
          type: string
          format: date-time
        offsetFromBookingDate:
          description: The number of days after booking deposit must be paid.
          type: integer
    childAgeType:
      type: object
      description: Defines Child's Age.
      properties:
        age:
          description: Age of a child in years.
          type: integer
    packageElementType:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/currencyAmountType'
        allowance:
          $ref: '#/components/schemas/currencyAmountType'
        description:
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 2000
        startDate:
          type: string
          format: date
          maxLength: 8
        endDate:
          type: string
          format: date
          maxLength: 8
        packageCode:
          type: string
        calculationRule:
          type: string
        postingRhythm:
          type: string
        quantity:
          type: integer
        includedInRate:
          type: boolean
        addRateSeprateLine:
          type: boolean
        addRateCombinedLine:
          type: boolean
        startTime:
          type: string
        endTime:
          type: string
        sellSeparate:
          type: boolean
    roomInterfaceStatus:
      type: object
      description: Response object for fetching room interface status
      properties:
        roomInterfaceStatusList:
          description: Collection of room, reservation and interface status information.
          type: array
          items:
            $ref: '#/components/schemas/reservationInfoType'
        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'
    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
    gdsNegotiatedType:
      type: object
      description: This holds a list of GdsNegotiatedInfoType.
      properties:
        gdsNegotiatedInfoList:
          description: List of channel negotiated rates for the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/gdsNegotiatedInfoType'
        bookingChannelCode:
          description: Booking Channel Code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        channelRatePlanCode:
          description: Channel Room Type.
          type: string
          minLength: 0
          maxLength: 20
    profileAccessType:
      type: object
      properties:
        chainCode:
          description: Indicates the Chain code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        croCode:
          description: Indicates the CRO code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        hotelId:
          description: Indicates the Hotel code where the profile was created
          type: string
          minLength: 0
          maxLength: 200
        sharedLevel:
          description: 'Indicates whether the profile is shared at the following levels : global/property/CRO'
          $ref: '#/components/schemas/profileSharedLevelType'
    profileType:
      type: object
      description: Type provides the detailed information about the profile and its children.
      properties:
        customer:
          description: Detailed customer information for this profile.
          $ref: '#/components/schemas/customerType'
        company:
          description: Detailed company information for this profile.
          $ref: '#/components/schemas/companyType'
        profileImage:
          description: The profile image.
          $ref: '#/components/schemas/imageSetType'
        addresses:
          description: List of customer addresses.
          type: object
          properties:
            addressInfo:
              description: Collection of Detailed information on an address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/addressInfoType'
            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
        businessSegments:
          description: Business/Market Segment associated to the profile.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        territory:
          description: Territory associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        traceCode:
          description: Trace Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        ownerCode:
          description: Owner Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        influenceCode:
          description: Influence Code associated to the profile.
          type: string
          minLength: 0
          maxLength: 40
        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
        uRLs:
          description: List of Information on a URL for the customer.
          type: object
          properties:
            uRLInfo:
              description: Collection of Detailed information on web url/address for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/uRLInfoType'
            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
        comments:
          description: List of Notes for the customer.
          type: object
          properties:
            commentInfo:
              description: Collection of Detailed information on comments for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/commentInfoType'
            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
        profileDeliveryMethods:
          description: List of Delivery methods configured against a Property for this Profile.
          type: object
          properties:
            profileDeliveryMethod:
              description: Collection of delivery methods for this Profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/profileDeliveryMethod'
            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
        profileMemberships:
          description: List of loyalty program(s) the profile is subscribed to.
          type: object
          properties:
            profileMembership:
              description: Collection of Detailed information on memberships for the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/profileMembershipType'
            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
        preferenceCollection:
          description: List of customer preferences.
          type: object
          properties:
            preferenceType:
              description: Collection of Detailed information on preferences of the customer.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/preferenceTypeType'
            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
        keywords:
          description: List of customer keywords.
          type: object
          properties:
            keyword:
              description: Collection of keywords attached to the profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/keywordType'
            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
        negotiatedRates:
          description: List of profile negotiated rates.
          type: object
          properties:
            negotiatedRate:
              description: Collection of Detailed information on profile negotiated rates.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/negotiatedType'
            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
        gdsNegotiatedRates:
          description: List of channel negotiated rates that this profile has been assigned to.
          type: object
          properties:
            gdsNegotiatedRate:
              description: Collection of Detailed information on channel negotiated rates for the profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/gdsNegotiatedType'
            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
        profileIndicators:
          description: Indicators of additional information attached to the profile
          $ref: '#/components/schemas/indicatorsType'
        relationships:
          description: Contains a collection of profiles that have a relationship with this profile.
          type: object
          properties:
            relationship:
              description: A collection of the profiles that have a relationship with this profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/relationshipInfoType'
            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
        relationshipsSummary:
          description: Contains a collection of profiles that have a relationship with this profile.
          type: object
          properties:
            relationship:
              description: A collection of the profiles summary that have a relationship with this profile.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/relationshipInfoSummaryType'
            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
        reservationInfoList:
          description: Collection of Detailed information on history and future reservations associated with the profile.
          $ref: '#/components/schemas/reservationHistoryFutureInfoType'
        stayReservationInfoList:
          description: Collection of Detailed information on history and future reservations associated with the profile.
          $ref: '#/components/schemas/reservationStayHistoryFutureInfoType'
        lastStayInfo:
          description: Information on last stay of the profile.
          $ref: '#/components/schemas/lastStayInfoType'
        profileAccessType:
          description: Detailed information on access type associated with the profile.
          $ref: '#/components/schemas/profileAccessType'
        profileRestrictions:
          description: Detailed information on restrictions associated with the profile.
          $ref: '#/components/schemas/profileRestrictions'
        mailingActions:
          description: Contains collection of mailing action list associated with the profile
          $ref: '#/components/schemas/mailingActionsType'
        privacyInfo:
          description: Contains privacy related information associated with the profile
          $ref: '#/components/schemas/privacyInfoType'
        cashiering:
          description: Contains cashiering related details for the profile
          $ref: '#/components/schemas/profileCashieringType'
        commissionInfoList:
          description: Contains commission related details for the profile.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/profileCommissionType'
        userDefinedFields:
          description: Collections of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
        webUserAccounts:
          description: List of Web User Accounts of the profile.
          $ref: '#/components/schemas/webUserAccountsType'
        taxInfo:
          description: Profile information about tax.
          $ref: '#/components/schemas/profileTaxInfoType'
        salesInfo:
          description: Sales information of the profiles.
          $ref: '#/components/schemas/salesInfoType'
        eCertificates:
          description: E-Certificate assosiated with the profile.
          $ref: '#/components/schemas/eCertificatesType'
        subscriptions:
          description: List of profile subscriptions.
          $ref: '#/components/schemas/profileSubscriptionListType'
        localizationGuestType:
          description: Localization Guest Type assocaited to the profile.
          type: string
          minLength: 0
          maxLength: 20
        eligibleForFiscalFolio:
          description: Eligible for Fiscal Folio/Payload generation.
          type: string
          minLength: 0
          maxLength: 20
        roomOwnershipsList:
          description: Room Ownership records.
          type: object
          properties:
            roomOwnershipInfo:
              description: Collection of Detailed information on Room Ownership records.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/roomOwnershipType'
            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
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
        statusCode:
          description: Status of the profile. Active/Inactive
          $ref: '#/components/schemas/profileStatusType'
        registeredProperty:
          description: Hotel which this profile is registered with. This attribute is not used for configuration.
          type: string
          minLength: 0
          maxLength: 20
        requestForHotel:
          description: Hotel which this profile is to be registered. This attribute is only used during creation of profile.
          type: string
          minLength: 0
          maxLength: 20
        protectedBy:
          description: What level this profile is protected.
          type: string
          minLength: 0
          maxLength: 40
        createDateTime:
          description: Time stamp of the creation.
          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.
          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
        markAsRecentlyAccessed:
          description: Mark this profile as recently accessed.
          type: boolean
        markForHistory:
          description: '"true" setting marks the profile to be kept from being purged, once the profile is marked inactive.'
          type: boolean
        hasCommission:
          description: Populates true if the profile has commission configured false otherwise.
          type: boolean
        inheritedNegRates:
          description: Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.
          type: boolean
        showInactiveRoomOwners:
          description: Flag to show inactive Room Owners.
          type: boolean
    paragraphType:
      type: object
      description: An indication of a new paragraph for a sub-section of a formatted text message.
      properties:
        text:
          description: Formatted text content.
          $ref: '#/components/schemas/formattedTextTextType'
        image:
          description: An image for this paragraph.
          type: string
        url:
          description: A URL for this paragraph.
          type: string
    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
    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
    reservationLocatorsType:
      type: array
      description: Holds the Locator Information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationLocatorType'
    reservationRoomOwnershipType:
      type: string
      description: Indicates if the assigned reservation room is an Owner/Referral or Regular room.
      enum:
      - Owner
      - Referral
      - Regular
  responses:
    '406':
      description: Not acceptable.
    '503':
      description: Service Unavailable
    '413':
      description: Request Entity Too Large
    '403':
      description: Forbidden
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '401':
      description: Unauthorized
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '405':
      description: Method not allowed
    '414':
      description: Request URI Too Large
    '502':
      description: Bad Gateway
  parameters:
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    x-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    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
    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-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}
    externalData:
      name: externalData
      description: Pass this header as true, if payload needs DVM
      in: header
      schema:
        type: string
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html