openapi: 3.2.0
info:
  title: OPERA Cloud Block Configuration Block Config API
  description: APIs for Block configuration, such as creating, updating, fetching and removing codes related to blocks. <br />< This might include fetching the block cancellation reasons, or creating new block refused reasons.  Wash schedules can be create, or new reservation methods could be added for a property.<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: /blk/config/v1
tags:
- name: BlockConfig
  description: The Block Configuration module offers capability of creating, managing, and retrieving of Block configuration.
paths:
  /blockStatusCodes:
    get:
      summary: Get block status codes
      description: This API fetches a list of configured status codes for the chain. It returns status code, description, and status type such as non-deduct, deduct, cancel, waitlist, inquiry, and actual. Status attributes, such as starting status, function diary visibility, allows pickup, and log catering changes are also returned in the response. Please note, that status codes are configured in a strict sequence that must be followed. In order to find available next statuses for the current block status, please use operation getNextBlockStatusCodes. <p><strong>OperationId:</strong>getBlockStatusCodes</p>
      operationId: getBlockStatusCodes
      parameters:
      - name: blockStatusCodes
        in: query
        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 object for fetching block status codes.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/statusCodeDetails'
        '204':
          description: BlockStatusCodes 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:
      - BlockConfig
    post:
      summary: Create a block status code
      description: You can use this API to create a new block status code. <p><strong>OperationId:</strong>postBlockStatusCode</p>
      operationId: postBlockStatusCode
      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:
        '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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/blockStatusCodeDetails'
        description: Request object for creating a block status code.
        required: true
  /blockStatusCodes/nextStatusCodes:
    get:
      summary: Get next block status codes
      description: Retrieve the next block Status Codes for a property. <p><strong>OperationId:</strong>getNextBlockStatusCodes</p>
      operationId: getNextBlockStatusCodes
      parameters:
      - name: configuredOnly
        in: query
        required: false
        description: When set to true, only configured next status codes will be included (available status list will not be included).
        schema:
          type: boolean
      - name: blockStatusCodes
        in: query
        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 object for fetch next block status codes.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/nextBlockStatusCodeDetails'
        '204':
          description: NextBlockStatusCodes 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:
      - BlockConfig
  /blockStatusCodes/{blockStatusCode}:
    delete:
      summary: Delete block status code
      description: You can use this API to delete block status code. <p><strong>OperationId:</strong>deleteBlockStatusCode</p>
      operationId: deleteBlockStatusCode
      parameters:
      - name: blockStatusCode
        in: path
        required: true
        description: OPERA Block status code
        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:
      - BlockConfig
    put:
      summary: Change block status code
      description: You can use this API to change block status code. <p><strong>OperationId:</strong>putBlockStatusCode</p>
      operationId: putBlockStatusCode
      parameters:
      - name: blockStatusCode
        in: path
        required: true
        description: OPERA Block status code
        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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/blockStatusCodeDetails'
        description: Request object for updating block status code.
        required: true
  /blockStatusCodes/{srcBlockStatusCode}/nextStatusCodes:
    put:
      summary: Change next block status codes
      description: Update the next Block status. <p><strong>OperationId:</strong>putNextBlockStatusCodes</p>
      operationId: putNextBlockStatusCodes
      parameters:
      - name: srcBlockStatusCode
        in: path
        required: true
        description: OPERA Block status code
        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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/nextBlockStatusCode'
        description: Request object for change block status code flow. Batch insert/update/delete of next status code list of a particular status code.
        required: true
  /hotels/{hotelId}/blockCutoffScheduleRange:
    put:
      summary: Set block cutoff schedule range
      description: You can use this API to set block cutoff schedule range. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.<p><strong>OperationId:</strong>setBlockCutoffScheduleRange</p>
      operationId: setBlockCutoffScheduleRange
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        schema:
          type: string
          maxLength: 20
          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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/blockCutoffScheduleRange'
        description: Request object to a create block cutoff schedule with date range.
        required: true
  /hotels/{hotelId}/blockSalesAllowance:
    get:
      summary: Get Block Sales Allowance
      description: You can use this API to get Block Sales Allowance. <p><strong>OperationId:</strong>getBlockSalesAllowance</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getBlockSalesAllowance
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: endDateRange
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: startDateRange
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: includeRestricted
        in: query
        required: false
        description: Indicate to include restricted room types.
        schema:
          type: boolean
      - name: roomTypesCodes
        in: query
        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 object for FetchBlockSalesAllowance operation which will contain all the information of sales allowance.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/blockSalesAllowance'
        '204':
          description: BlockSalesAllowance 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:
      - BlockConfig
  /hotels/{hotelId}/blockSalesAllowance/activityLog:
    get:
      summary: Get the Block Sales Allowance activity log
      description: Use this API to facilitate retrieving the Block Sales Allowance activity log. <p><strong>OperationId:</strong>getBlockSalesAllowanceActivityLog</p>
      operationId: getBlockSalesAllowanceActivityLog
      parameters:
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          maximum: 200
      - 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: hotelId
        in: path
        required: true
        description: Hotel code.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: changeLogDate
        in: query
        required: false
        description: Search date for the user activity log.
        schema:
          type: string
          format: date
      - name: salesAllowanceDate
        in: query
        required: false
        description: Sales Allowance date for the user activity log.
        schema:
          type: string
          format: date
      - name: userId
        in: query
        required: false
        description: User Id for the user activity log.
        schema:
          type: integer
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching block sales allowance activity log. This object contains collection of user activity log for the block sales allowance changes.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/blockSalesAllowanceActivityLog'
        '204':
          description: Block sales allowance activity log 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:
      - BlockConfig
  /hotels/{hotelId}/blockSalesAllowanceRange:
    delete:
      summary: Delete block sales allowance range
      description: You can use this API to delete block sales allowance range. <p><strong>OperationId:</strong>deleteBlockSalesAllowanceRange</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: deleteBlockSalesAllowanceRange
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: endDate
        in: query
        required: true
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: startDate
        in: query
        required: true
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: friday
        in: query
        required: false
        schema:
          type: boolean
      - name: monday
        in: query
        required: false
        schema:
          type: boolean
      - name: saturday
        in: query
        required: false
        schema:
          type: boolean
      - name: sunday
        in: query
        required: false
        schema:
          type: boolean
      - name: thursday
        in: query
        required: false
        schema:
          type: boolean
      - name: tuesday
        in: query
        required: false
        schema:
          type: boolean
      - name: wednesday
        in: query
        required: false
        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:
      - BlockConfig
    put:
      summary: Set block sales allowance range
      description: You can use this API to set block sales allowance range. <p><strong>OperationId:</strong>setBlockSalesAllowanceRange</p>
      operationId: setBlockSalesAllowanceRange
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/blockSalesAllowanceRange'
        description: Operation to a create block sales allowance with date range.
        required: true
  /hotels/{hotelId}/cutoffSchedules:
    get:
      summary: Get block cutoff schedule codes.
      description: This API fetches a list of configured cutoff schedule codes for the property. It returns cutoff schedule code, description, start date, end date and default cutoff days. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates. <p><strong>OperationId:</strong>getCutoffSchedules</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>
      operationId: getCutoffSchedules
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: cutoffCodes
        in: query
        description: Cutoff Schedule Codes to be searched.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 40
      - name: cutoffCodeStartDate
        in: query
        description: Cutoff Schedule Code start date.
        schema:
          type: string
          format: date
      - 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 object for fetching cutoff schedule codes which will contain all the information of 'CutoffCodes' like code, date range, default days, and description.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/cutoffScheduleDetails'
        '204':
          description: Cutoff Schedule Codes 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:
      - BlockConfig
    post:
      summary: Create a block cutoff schedule code.
      description: You can use this API to create a new block cutoff schedule code. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates. <p><strong>OperationId:</strong>postCutoffScheduleCode</p>
      operationId: postCutoffScheduleCode
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel Id
        schema:
          type: string
          maxLength: 20
          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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/cutoffCodeCriteria'
        description: Request object for creating a block cutoff schedule code.
        required: true
  /hotels/{hotelId}/cutoffSchedules/{cutoffCodeId}:
    get:
      summary: Get cutoff Schedules Details for a cutoff schedule code.
      description: This API fetches a list of cutoff schedule details for a cutoff schedule code. It returns stay date, room type and cutoff days for cutoff schedule. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.<p><strong>OperationId:</strong>getCutoffSchedulesDetails</p> <p>The maximum allowable limit for this API is <strong>365</strong>.</p>
      operationId: getCutoffSchedulesDetails
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: cutoffCodeId
        in: path
        description: Unique cutoff schedule code for which details will be fetched.
        required: true
        schema:
          type: integer
      - 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 object for fetching cutoff code schedule details which will contain stay date, cutoff days, and room type .
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/cutoffScheduleDetails'
        '204':
          description: Cutoff Schedule 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:
      - BlockConfig
    put:
      summary: Change block cutoff schedule code
      description: You can use this API to change block cutoff schedule code. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.<p><strong>OperationId:</strong>putCutoffScheduleCode</p>
      operationId: putCutoffScheduleCode
      parameters:
      - name: cutoffCodeId
        in: path
        required: true
        description: OPERA Block cutoff schedule code Id.
        schema:
          type: integer
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel Id
        schema:
          type: string
          maxLength: 20
          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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/cutoffCodeCriteria'
        description: Request object for updating block cutoff schedule code.
        required: true
    delete:
      summary: Delete cutoff schedule code.
      description: You can use this API to delete cutoff schedule code. <p><strong>OperationId:</strong>removeCutoffScheduleCode</p>
      operationId: deleteCutoffScheduleCode
      parameters:
      - name: cutoffCodeId
        in: path
        required: true
        description: Unique Cutoff Schedule Code Id.
        schema:
          type: integer
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel Code.
        schema:
          type: string
          maxLength: 20
          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:
      - BlockConfig
  /hotels/{hotelId}/salesManagers:
    get:
      summary: Get Sales Managers by Hotel.
      description: You can use this API to retrieve multiple Sales Managers for a hotel, you can narrow the results using different search criteria. <p><strong>OperationId:</strong>getSalesManagers</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>
      operationId: getSalesManagers
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel Id
        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: ownerCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: firstName
        in: query
        required: false
        description: First name required to fetch Sales Manager information.
        schema:
          type: string
      - name: lastName
        in: query
        required: false
        description: Last name required to fetch Sales Manager information.
        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: You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/salesManagersInfo'
        '204':
          description: SalesManagers 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:
      - BlockConfig
  /hotels/{hotelId}/salesManagers/searches:
    post:
      summary: Get Sales Managers by Hotel.
      description: You can use this API to retrieve multiple Sales Managers for a hotel, you can narrow the results using different search criteria. <p><strong>OperationId:</strong>searchSalesManagers</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>
      operationId: searchSalesManagers
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel Id
        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: You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/salesManagersInfo'
        '204':
          description: SalesManagers 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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchSalesManagersRequest'
  /hotels/{hotelId}/salesManagers/{salesManagerId}/salesManagerGoals:
    get:
      summary: Get Sales Manager Goals by Hotel
      description: You can use this API to retrieve individual Sales Manager Goals for a hotel, you can narrow the results using different search criteria. <p><strong>OperationId:</strong>getSalesManagerGoals</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>
      operationId: getSalesManagerGoals
      parameters:
      - name: salesManagerId
        in: path
        required: true
        description: Sales Manager Id required to fetch Sales Manager goals information
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel Id
        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: future
        in: query
        required: false
        description: Use this indicator to fetch goal's having Production From or Arrival From dates later than the current business date or quarter
        schema:
          type: boolean
      - name: fetchInstructions
        in: query
        description: 'Fetch instructions that can be used to fetch details of particular Sales Manager type,ex: Group Room, Transient Room, Catering, Activity.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - GroupRoomsWithCatering
            - TransientRoom
            - Activity
          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 for fetching details of Sales Manager Goal.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/salesManagerGoalsInfo'
        '204':
          description: SalesManagerGoals 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:
      - BlockConfig
    post:
      summary: Create Sales Manager Goals
      description: Use this API to Create Sales Manager Goals for a Sales Manager ID.You must know the OPERA Sales Manager ID for this API. <p><strong>OperationId:</strong>postSalesManagerGoals</p>
      operationId: postSalesManagerGoals
      parameters:
      - name: salesManagerId
        in: path
        required: true
        description: Sales Manager Id required to fetch Sales Manager goals information
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel Id
        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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/createSalesManagerGoals'
        description: Request object for Creating Sales Manager Goal(s).
        required: true
  /hotels/{hotelId}/salesManagers/{salesManagerId}/salesManagerGoals/{salesGoalId}:
    put:
      summary: Update Sales Manager Goal in a hotel by ID
      description: Use this API to update Sales Manager Goal.You must know the OPERA Sales Manager ID and Goal ID for this API. <p><strong>OperationId:</strong>putSalesManagerGoals</p>
      operationId: putSalesManagerGoals
      parameters:
      - name: salesGoalId
        in: path
        required: true
        description: Unique Sales Goal Id assigned to a Sales Manager.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: salesManagerId
        in: path
        required: true
        description: Sales Manager Id required to put Sales Manager goals information
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel Id
        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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/salesManagerGoalsInfo'
        description: Request object for modifying Sales Manager's goal.
        required: true
  /hotels/{hotelId}/washSchedules:
    post:
      summary: Create block wash schedule
      description: Create a block wash schedule. <p><strong>OperationId:</strong>postWashSchedule</p>
      operationId: postWashSchedule
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/washScheduleCriteria'
        description: Operation to create new Wash Schedule Configuration under the selected property.
        required: true
  /hotels/{hotelId}/washSchedules/{washScheduleCode}:
    delete:
      summary: Delete block wash schedule
      description: Delete a block wash schedule. <p><strong>OperationId:</strong>deleteWashSchedule</p>
      operationId: deleteWashSchedule
      parameters:
      - name: washScheduleCode
        in: path
        required: true
        description: Unique Block Wash Code
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        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:
      - BlockConfig
    put:
      summary: Change block wash schedule
      description: Change a block wash schedule. <p><strong>OperationId:</strong>putWashSchedule</p>
      operationId: putWashSchedule
      parameters:
      - name: washScheduleCode
        in: path
        required: true
        description: Unique Block Wash Code
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/washScheduleCriteria'
        description: Operation to change existing Wash Schedule Configuration.
        required: true
  /salesManagers:
    get:
      summary: Get Sales Managers.
      description: You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria. <p><strong>OperationId:</strong>getSalesManagersMultipleHotelIds</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>
      operationId: getSalesManagersMultipleHotelIds
      deprecated: true
      parameters:
      - name: hotelIds
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - 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: ownerCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: firstName
        in: query
        required: false
        description: First name required to fetch Sales Manager information.
        schema:
          type: string
      - name: lastName
        in: query
        required: false
        description: Last name required to fetch Sales Manager information.
        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: You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/salesManagersInfo'
        '204':
          description: SalesManagersMultipleHotelIds 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:
      - BlockConfig
  /salesManagers/searches:
    post:
      summary: Get Sales Managers.
      description: You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria. <p><strong>OperationId:</strong>searchSalesManagersMultipleHotelIds</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>
      operationId: searchSalesManagersMultipleHotelIds
      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: You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/salesManagersInfo'
        '204':
          description: SalesManagersMultipleHotelIds 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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/searchSalesManagersMultipleHotelIdsRequest'
  /salesManagers/{salesManagerId}/salesManagerGoals:
    delete:
      summary: Delete Sale Manager Goals
      description: Use this API to delete Sales Manager Goals. <p><strong>OperationId:</strong>removeSalesManagerGoals</p>
      operationId: removeSalesManagerGoals
      parameters:
      - name: salesManagerId
        in: path
        required: true
        description: Unique Sales Managers Id
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: salesGoalId
        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
      - $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:
      - BlockConfig
    get:
      summary: Get Sales Manager Goals
      description: You can use this API to retrieve individual Sales Manager Goals, you can narrow the results using different search criteria. <p><strong>OperationId:</strong>getSalesManagerGoalsMultipleHotelIds</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>
      operationId: getSalesManagerGoalsMultipleHotelIds
      parameters:
      - name: salesManagerId
        in: path
        required: true
        description: Sales Manager Id required to fetch Sales Manager goals information
        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: hotelIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: future
        in: query
        required: false
        description: Use this indicator to fetch goal's having Production From or Arrival From dates later than the current business date or quarter
        schema:
          type: boolean
      - name: fetchInstructions
        in: query
        description: 'Fetch instructions that can be used to fetch details of particular Sales Manager type,ex: Group Room, Transient Room, Catering, Activity.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - GroupRoomsWithCatering
            - TransientRoom
            - Activity
          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 for fetching details of Sales Manager Goal.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/salesManagerGoalsInfo'
        '204':
          description: SalesManagerGoalsMultipleHotelIds 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:
      - BlockConfig
  /salesManagers/{salesManagerId}/salesManagerGoals/{salesGoalId}:
    delete:
      summary: Delete Sale Manager Goal
      description: Use this API to delete Sales Manager Goal. <p><strong>OperationId:</strong>removeSalesManagerGoal</p>
      operationId: removeSalesManagerGoal
      parameters:
      - name: salesGoalId
        in: path
        required: true
        description: Unique Sales Goal Id assigned to a Sales Manager.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: salesManagerId
        in: path
        required: true
        description: Unique Sales Managers Id
        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:
      - BlockConfig
  /services/block/status:
    get:
      summary: ' ping'
      description: Ping Block Configuration Service <p><strong>OperationId:</strong>pingBlockConfigService</p>
      operationId: pingBlockConfigService
      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: pingBlockConfigService 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:
      - BlockConfig
  /upsert/hotels/{hotelId}/washSchedules/{washScheduleCode}:
    put:
      summary: Create/Change block wash schedule
      description: Create/Change a block wash schedule. <p><strong>OperationId:</strong>putUpsertWashSchedule</p>
      operationId: putUpsertWashSchedule
      parameters:
      - name: washScheduleCode
        in: path
        required: true
        description: Unique Block Wash Code
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        description: Unique OPERA Hotel code
        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:
      - BlockConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/washScheduleCriteria'
        description: Operation to change existing Wash Schedule Configuration.
        required: true
  /washSchedules:
    get:
      summary: Get block wash schedule
      description: Get block wash schedules. <p><strong>OperationId:</strong>getWashSchedule</p>
      operationId: getWashSchedule
      parameters:
      - name: hotelIds
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: washCodes
        in: query
        description: Codes to be searched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: wildCard
        in: query
        required: false
        description: Wildcard search on the code.
        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 FetchWashSchedule operation which will contain all the information of 'WashCodes' like Days prior to arrival, Occupancy detail, Sell limit and Wash by percent value if exists.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/washScheduleDetails'
        '204':
          description: WashSchedule 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:
      - BlockConfig
components:
  schemas:
    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
    cutoffCodeCriteria:
      type: object
      description: 'Object which will contain all the information of ''CutoffCodes''. '
      properties:
        cutoffCodes:
          type: array
          description: Cutoff Code, which will allow the user to define standard cutoff schedules. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/cutoffCodeType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    managedByOptions:
      description: Describes of the Configuration is Managed by Enterprise or Property.
      type: string
      enum:
      - EnterpriseManaged
      - PropertyManaged
      - EnterpriseEnforced
      - PropertyOverridden
    salesManagerGoalsInfo:
      type: object
      description: You can use this API to retrieve individual Sales Manager Goals for a hotel, you can narrow the results using different search criteria
      properties:
        salesManagerGoals:
          description: Collection of Sales Manager Goals information.
          $ref: '#/components/schemas/salesManagerGoalsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    nextBlockStatusCodeInfoListType:
      type: array
      description: List of all configured next status codes for the main status code.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/nextBlockStatusCodeInfoType'
    blockSalesAllowanceListType:
      type: array
      description: Block's sales allowance information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockSalesAllowanceType'
    blockSalesAllowanceType:
      type: object
      description: Contains single entry information for Block's Sales Allowance.
      properties:
        hotelId:
          description: Contains Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        salesAllowanceDate:
          description: Contains sales allowance date.
          type: string
          format: date
          maxLength: 8
        roomType:
          description: Contains room type.
          type: string
          minLength: 0
          maxLength: 20
        roomPool:
          description: Contains room pool code.
          type: string
          minLength: 0
          maxLength: 20
        allowance:
          description: Contains allocated number of rooms for allowance.
          type: integer
        booked:
          description: Contains number of rooms are booked/consumed from sales allowance.
          type: integer
        overBooked:
          description: Contains number of rooms are overbooked from sales allowance.
          type: integer
        cutoffDate:
          description: Contains cutoff date for sales allowance.
          type: string
          format: date
          maxLength: 8
    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
    nextBlockStatusCode:
      type: object
      description: Request object for change block status code flow. Batch insert/update/delete of next status code list of a particular status code.
      properties:
        nextBlockStatusCodeList:
          description: Contains list of all available next status codes for a particular status code.
          $ref: '#/components/schemas/nextBlockStatusCodeListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    errorInstance:
      title: Error Instance Details
      description: Complex type that contains error instance details for a REST call.
      type: object
      properties:
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).
        title:
          type: string
          description: Short, human-readable summary of the problem.  The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
        detail:
          type: string
          description: Human-readable description specific to this occurrence of the problem.
        instance:
          type: string
          description: Absolute URI that identifies the specific occurrence of the problem.  It may or may not provide additional information if dereferenced.
        o:errorCode:
          type: string
          description: Application error code, which is different from HTTP error code.
        o:errorPath:
          type: string
          description: Path to the problem at the resource or property level.
      required:
      - type
      - title
    washCodesType:
      type: array
      description: Wash Code, which will allow the user to define standard schedules that can be attached to blocks prior to the block's cutoff date to automate this process.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/washCodeType'
    cutoffCodeType:
      type: object
      description: A representation of the information contained by a Cutoff Code.
      properties:
        cutoffCodeDetails:
          type: array
          description: Detail information of the Cutoff Code.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/cutoffCodeDetailType'
        hotelCode:
          description: Hotel Code to which the cutoff Code belongs to.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Unique Cutoff Schedule Code.
          type: string
          minLength: 0
          maxLength: 20
        id:
          description: Unique Cutoff Schedule Code Id
          type: integer
        description:
          description: Description of the Cutoff Schedule Code.
          type: string
          minLength: 0
          maxLength: 2000
        cutoffCodeStartDate:
          type: string
          description: Cutoff Schedule Code Start Date.
          format: date
        cutoffCodeEndDate:
          type: string
          description: Cutoff Schedule Code End Date.
          format: date
        defaultDays:
          description: Cutoff Schedule Code Default Days. This value will be used if no pre defined schedule exist for a date or room type.
          type: integer
    salesManagerGoalType:
      type: object
      description: Detail Information about Sales Manager's goal.
      properties:
        hotelId:
          description: Hotel Code of the Sales Manager
          type: string
          minLength: 0
          maxLength: 20
        nameId:
          description: Unique Name ID for the Sales Manager
          $ref: '#/components/schemas/uniqueID_Type'
        goalID:
          description: Unique Goal ID for the Sales Manager
          $ref: '#/components/schemas/uniqueID_Type'
        goalType:
          description: Specifies the Goal Type
          type: string
        arrivalGoal:
          description: Specifies if this is a Arrival or a Production Goal
          type: boolean
        productionStartDate:
          description: Specifies the Production Start Date
          type: string
          format: date
          maxLength: 8
        productionEndDate:
          description: Specifies the Production End Date
          type: string
          format: date
          maxLength: 8
        productionPeriodCode:
          description: Specifies the Production Period Code
          type: string
        arrivalStartDate:
          description: Specifies the Arrival Start Date
          type: string
          format: date
          maxLength: 8
        arrivalEndDate:
          description: Specifies the Arrival End Date
          type: string
          format: date
          maxLength: 8
        arrivalPeriodCode:
          description: Specifies the Arrival Period Code
          type: string
        marketCode:
          description: Market Code assigned for the goal
          type: string
        roomNights:
          description: Room Nights assigned for the goal
          type: integer
        roomRevenue:
          description: Room Revenue assigned for the Goal
          $ref: '#/components/schemas/currencyAmountType'
        averageRate:
          description: Average Rate assigned for the Goal
          $ref: '#/components/schemas/currencyAmountType'
        cateringCovers:
          description: Number of meals or covers assigned for the Goal
          type: integer
        fBRevenue:
          description: Food and Beverage revenue assigned for the Goal
          $ref: '#/components/schemas/currencyAmountType'
        averageFBCheck:
          description: Average Food and Beverage check assigned for the Goal
          $ref: '#/components/schemas/currencyAmountType'
        otherRevenue:
          description: Other revenue assigned for the Goal
          $ref: '#/components/schemas/currencyAmountType'
        activityType:
          description: Specifies the type of activity being set as a goal
          type: string
        activitiesCount:
          description: Specifies the number of activities of Activity Type being set as a goal
          type: integer
        groupRoomsWithCatering:
          description: Goal type used to fetch goals related to Group Rooms and Catering business
          type: boolean
        transientRoom:
          description: Goal type used to fetch non group goals related to Rooms business
          type: boolean
        activity:
          description: Indicates if the Sales manager has Activity Goal
          type: boolean
        future:
          description: Use this indicator to fetch goal's having Production From or Arrival From dates later than the current business date or quarter
          type: boolean
    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
    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
    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
    washCodeDetailsType:
      type: array
      description: Wash Code Detail for a single entry.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/washCodeDetailType'
    salesManagersType:
      type: object
      description: Collection of Sales Managers information.
      properties:
        salesManager:
          description: Sales Manager's information.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/salesManagerType'
        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
    nextBlockStatusCodeDetails:
      type: object
      description: Response object for fetching next block status codes.
      properties:
        nextBlockStatusCodeList:
          description: List of block status code flow which compose of a particular status code and its selected next statuses. Moreover, available next status can be not included if ConfigureOnly is set to true.
          $ref: '#/components/schemas/nextBlockStatusCodeListType'
        blockStatusCodeMasterList:
          description: Block status code information e.g. Color, Description, etc.
          $ref: '#/components/schemas/blockStatusCodeListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    nextBlockStatusCodeType:
      type: object
      description: Next block status codes information. Contains list of all configured and/or available next status codes for a particular status code.
      properties:
        nextConfiguredStatusList:
          description: List of all configured next status codes for the main status code.
          $ref: '#/components/schemas/nextBlockStatusCodeInfoListType'
        nextAvailableStatusList:
          description: List of all available next status codes for the main status code.
          $ref: '#/components/schemas/nextBlockStatusCodeInfoListType'
        status:
          description: Main block status code.
          type: string
          minLength: 0
          maxLength: 20
    blockStatusCodeListType:
      type: array
      description: Block status code information.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockStatusCodeType'
    blockSalesAllowanceRange:
      type: object
      description: Operation to a create block sales allowance with date range.
      properties:
        criteria:
          description: Criteria to fetch block sales allowance.
          $ref: '#/components/schemas/blockSalesAllowanceRangeType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    blockCutoffScheduleRangeType:
      type: object
      description: Object to create block cutoff schedule details by providing date range, room type, days of week and cutoff days.
      properties:
        hotelId:
          description: Contains Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        cutoffCodeId:
          description: Contains Cutoff Schedule Code Id.
          type: integer
        roomTypes:
          description: Contains Room Types.
          type: array
          maxItems: 20
          items:
            type: string
            minLength: 0
            maxLength: 20
        cutoffDays:
          description: Number of cutoff Days.
          type: integer
        overwriteExistingcutoffschedule:
          description: Flag to indicate if the cutoff schedule already exists for criteria then overwrite the records.
          type: boolean
        stayDateFrom:
          description: The starting value of the date range.
          type: string
          format: date
        stayDateTo:
          description: The ending value of the date range.
          type: string
          format: date
        sunday:
          type: boolean
        monday:
          type: boolean
        tuesday:
          type: boolean
        wednesday:
          type: boolean
        thursday:
          type: boolean
        friday:
          type: boolean
        saturday:
          type: boolean
    cutoffScheduleDetails:
      type: object
      description: 'Object which will contain all the information of ''CutoffCodes''. '
      properties:
        cutoffCodes:
          type: array
          description: Cutoff Code, which will allow the user to define standard cutoff schedules. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.
          maxItems: 4000
          items:
            $ref: '#/components/schemas/cutoffCodeType'
        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'
    salesManagersInfo:
      type: object
      description: You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria
      properties:
        salesManagers:
          description: Collection of Sales Managers information.
          $ref: '#/components/schemas/salesManagersType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    cutoffCodeDetail:
      type: object
      description: A representation of the single entry information for cutoff schedule detail.
      properties:
        id:
          description: Cutoff Schedule detail Id.
          type: integer
        stayDate:
          description: Contains stay date.
          type: string
          format: date
          maxLength: 8
        cutoffDays:
          description: Contains the number of cutoff Days to be set for specific date and room type.
          type: integer
        roomType:
          description: Contains the room types.
          type: string
    washScheduleDetails:
      type: object
      description: Response object for FetchWashSchedule operation which will contain all the information of 'WashCodes' like Days prior to arrival, Occupancy detail, Sell limit and Wash by percent value if exists.
      properties:
        washCodes:
          description: Collection of Block Wash Schedule fetched.
          $ref: '#/components/schemas/washCodesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    salesManagerGoalsType:
      type: array
      description: Detail Information about Sales Manager's goal.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/salesManagerGoalType'
    washScheduleCriteria:
      type: object
      description: Operation to create new Wash Schedule Configuration under the selected property.
      properties:
        washCodes:
          description: Wash Schedule Configuration to be created.
          $ref: '#/components/schemas/washCodesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    status:
      type: object
      description: Response Body.
      properties:
        warnings:
          $ref: '#/components/schemas/warningsType'
        links:
          $ref: '#/components/schemas/links'
    nextBlockStatusCodeInfoType:
      type: object
      description: Information of next block status code.
      properties:
        status:
          description: Next block status code.
          type: string
          minLength: 0
          maxLength: 20
        order:
          description: Order of next block status code
          type: integer
    searchSalesManagersRequest:
      type: object
      properties:
        limit:
          type: integer
          description: Indicates maximum number of records a Web Service should return.
        offset:
          type: integer
          default: 0
          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.
        ownerCodes:
          type: array
          maxItems: 4000
          items:
            type: string
          description: ''
        firstName:
          type: string
          description: First name required to fetch Sales Manager information.
        lastName:
          type: string
          description: Last name required to fetch Sales Manager information.
    blockSalesAllowance:
      type: object
      description: Response object for FetchBlockSalesAllowance operation which will contain all the information of sales allowance.
      properties:
        salesAllowances:
          description: Collection of Block Sales Allowance fetched.
          $ref: '#/components/schemas/blockSalesAllowanceListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    washCodeType:
      type: object
      description: A representation of the information contained by a Wash Code.
      properties:
        description:
          description: Description of the Wash Code.
          type: string
          minLength: 0
          maxLength: 2000
        washCodeDetails:
          description: Detail information of the Wash Code. It will contain number of rooms to be washed which is linked to a block by a Percentage or Specific number of rooms.
          $ref: '#/components/schemas/washCodeDetailsType'
        hotelId:
          description: Hotel Code to which the Wash Code belongs to.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Wash Code.
          type: string
          minLength: 0
          maxLength: 20
        managedBy:
          $ref: '#/components/schemas/managedByOptions'
    searchSalesManagersMultipleHotelIdsRequest:
      type: object
      properties:
        hotelIds:
          type: array
          maxItems: 4000
          items:
            type: string
          description: ''
        limit:
          type: integer
          description: Indicates maximum number of records a Web Service should return.
        offset:
          type: integer
          default: 0
          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.
        ownerCodes:
          type: array
          maxItems: 4000
          items:
            type: string
          description: ''
        firstName:
          type: string
          description: First name required to fetch Sales Manager information.
        lastName:
          type: string
          description: Last name required to fetch Sales Manager information.
      required:
      - hotelIds
    blockStatusCodeType:
      type: object
      description: Block status code information.
      properties:
        status:
          description: Code and Description used to define a status e.g. (INT, TENT, DEF, CXL) (initial, tentative, definite, cancelled).
          $ref: '#/components/schemas/codeDescriptionType'
        roomStatusType:
          description: Room status type selected for status code.
          $ref: '#/components/schemas/blockStatusCodeStatusType'
        cateringStatusType:
          description: Catering status type selected for status code. When the OPS Sales & Catering license code is active, the Sales & Catering status type for the status code is displayed.
          $ref: '#/components/schemas/blockStatusCodeStatusType'
        defaultReservationType:
          description: Default reservation type to be used for the status code. The reservation type and status code must have the same deduct/no deduct status.
          $ref: '#/components/schemas/codeDescriptionType'
        reasonType:
          description: Reason type for every block reservation cancellation. Block Cancellation Reason, Block Refused Reasons, and Block Lost Reasons.
          type: string
        color:
          description: Color code for the status code.
          $ref: '#/components/schemas/statusColorType'
        allowPickup:
          description: Indicates if the rooms with this status code will be allowed for pickup or not.
          type: boolean
        returnToInventory:
          description: Indicates if the rooms with this status code can be returned to availability or not.
          type: boolean
        starting:
          description: Indicates if the status code is the starting status of the status cycle or not.
          type: boolean
        leadStatus:
          description: Indicates the default status for all new leads. Only one lead status can be selected as the default.
          type: boolean
        logCatering:
          description: Indicates if the status code logs the catering changes or not.
          type: boolean
        showDiary:
          description: Indicates if the function diary will be shown within the Sales and Catering.
          type: boolean
        orderBy:
          description: Indicates the order the status code is displayed in the status cycle.
          type: integer
        inUse:
          description: Returns true if the status code is already used in Block / Event / Status Flow.
          type: boolean
        cateringInUse:
          description: Returns true if the status code is already used in Events.
          type: boolean
        opportunity:
          description: Indicates that the business block created with this Status is an Opportunity.
          type: boolean
        managedBy:
          $ref: '#/components/schemas/managedByOptions'
    statusCodeDetails:
      type: object
      description: Response object for fetching block status codes.
      properties:
        blockStatusCodes:
          description: Collection of configured Block Status Codes.
          $ref: '#/components/schemas/blockStatusCodeListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    createSalesManagerGoals:
      type: object
      description: Request object for Creating Sales Manager Goal(s).
      properties:
        salesManagerGoals:
          description: Collection of Sales Manager Goals information which should be created.
          $ref: '#/components/schemas/salesManagerGoalsType'
        warnings:
          $ref: '#/components/schemas/warningsType'
    washCodeDetailType:
      type: object
      description: Allows for a choice to populate the detail information based on the choice between 'Wash by number of rooms' and 'Wash by %'.
      properties:
        washByRoom:
          $ref: '#/components/schemas/washByRoomType'
        washByPercent:
          type: integer
        daysPriorToArrival:
          description: Number of days prior to arrival of a block or block's cutoff day.
          type: integer
    blockSalesAllowanceRangeType:
      type: object
      description: Indicates the block sales allowance for a date range.
      properties:
        hotelId:
          description: Contains Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        quantity:
          description: Contains quantity for sales allowance.
          type: integer
        cutoffDays:
          description: Number of days before sales allowance date, after which unused quantity should set to 0.
          type: integer
        incrementFlag:
          description: Flag to indicate if the sales allowance update is absolute or relative to the current value.
          type: boolean
        overwriteExistingSalesAllowance:
          description: Flag to indicate if the sales allowance already exists for criteria then overwrite the records.
          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
        sunday:
          type: boolean
        monday:
          type: boolean
        tuesday:
          type: boolean
        wednesday:
          type: boolean
        thursday:
          type: boolean
        friday:
          type: boolean
        saturday:
          type: boolean
        validateExistingSalesAllowance:
          description: Flag to validate existing sales allowance records within criteria.
          type: boolean
    blockCutoffScheduleRange:
      type: object
      description: Operation to a create block cutoff schedule details by providing date range, room type, days of week and cutoff days.
      properties:
        criteria:
          description: Criteria to create block cutoff schedule.
          $ref: '#/components/schemas/blockCutoffScheduleRangeType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    nextBlockStatusCodeListType:
      type: array
      description: Block status code with its next configured and/or available status codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/nextBlockStatusCodeType'
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    blockStatusCodeStatusType:
      type: string
      description: Simple type for block status code's room status type and catering status type. Valid status values are Waitlist,Cancel,Lost,Refused,Actual,Inquiry,NonDeductInv,DeductInv and Referral.
      enum:
      - Waitlist
      - Cancel
      - Lost
      - Refused
      - Actual
      - Inquiry
      - NonDeductInv
      - DeductInv
      - Referral
    washByRoomType:
      type: object
      description: A representation of the single entry information for 'Wash by number of rooms' type.
      properties:
        occupancy1:
          description: Contains the number of 'Occupancy1'. Based on the parameter it should be replaced by the number of 'Rooms'.
          type: integer
        occupancy2:
          description: Contains the number of 'Occupancy2'.
          type: integer
        occupancy3:
          description: Contains the number of 'Occupancy3'.
          type: integer
        occupancy4:
          description: Contains the number of 'Occupancy4'.
          type: integer
        sell:
          description: Contains the available Sell Limit rooms for a Sell Limit block.
          type: integer
    blockSalesAllowanceActivityLog:
      type: object
      description: Response object for fetching block sales allowance activity log.
      properties:
        blockSalesAllowance:
          description: Response object for Block Sales Allowance activity Log.
          $ref: '#/components/schemas/blockSalesAllowanceActivityLogListType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    blockStatusCodeDetails:
      type: object
      description: Request object for updating block status code.
      properties:
        blockStatusCode:
          description: Block status code information to be applied.
          $ref: '#/components/schemas/blockStatusCodeType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    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'
    cutoffCodeDetailType:
      type: object
      description: Cutoff Code Detail for a single entry
      properties:
        cutoffCodeDetail:
          $ref: '#/components/schemas/cutoffCodeDetail'
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    operaVersionNumberType:
      type: string
      description: Current Opera Version Number
      minLength: 0
      maxLength: 40
    statusColorType:
      type: string
      description: Status code color configuration type.
      enum:
      - White
      - Red
      - Blue
      - Cyan
      - Magenta
      - Green
      - Brown
      - Black
      - Yellow
      - Gray
    salesManagerType:
      type: object
      description: Sales Manager's information.
      properties:
        hotelId:
          description: Hotel Code of the Sales Manager
          type: string
          minLength: 0
          maxLength: 20
        nameId:
          description: Unique Name ID for the Sales Manager
          $ref: '#/components/schemas/uniqueID_Type'
        salesManagerCode:
          description: Sales Manager's code
          type: string
          minLength: 0
          maxLength: 20
        name:
          description: Sales Manager's name
          type: string
        groupRoomWithCatering:
          description: Indicates if the Sales manager has Group Room with Catering Goal
          type: boolean
        transientRoom:
          description: Indicates if the Sales manager has Transient Room Goal
          type: boolean
        activity:
          description: Indicates if the Sales manager has Activity Goal
          type: boolean
    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
    blockSalesAllowanceActivityLogListType:
      type: object
      properties:
        activityLog:
          type: array
          maxItems: 200
          items:
            $ref: '#/components/schemas/blockSalesAllowanceActivityLogType'
        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
    blockSalesAllowanceActivityLogType:
      type: object
      properties:
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        logDate:
          type: string
          format: date-time
          description: Date on which change happened.
        salesAllowanceDate:
          type: string
          format: date-time
          description: sales Allowance Date
        oldQuantity:
          type: number
          description: Value of sales allowance before the change.
        newQuantity:
          type: number
          description: Value of sales allowance after the change.
        refActionId:
          type: number
        logUserId:
          type: number
          description: ID of user who made the change.
        logUserName:
          type: string
          description: Name of user who made the change.
        actionType:
          type: string
          minLength: 0
          maxLength: 100
          description: Action type.
        ipAddress:
          description: The IP Address of the machine that performed the activity
          type: string
          minLength: 0
          maxLength: 20
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '403':
      description: Forbidden
    '413':
      description: Request Entity Too Large
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '503':
      description: Service Unavailable
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    x-hotelid:
      name: x-hotelid
      description: Mandatory parameter to identify the hotel code where the end user is logged in
      in: header
      required: true
      schema:
        type: string
    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}$
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    externalData:
      name: externalData
      description: Pass this header as true, if payload needs DVM
      in: header
      schema:
        type: string
    x-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    Accept-Language:
      name: Accept-Language
      description: Language code
      in: header
      schema:
        type: string
    x-request-id:
      name: x-request-id
      description: Request Id of an incoming request
      in: header
      schema:
        type: string
        pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html