openapi: 3.2.0
info:
  title: OPERA Cloud Block Reservation Asynchronous Block Async API
  description: APIs to cater Block Reservation related asynchronous functionality in OPERA.<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/async/v1
tags:
- name: BlockAsync
  description: The Block Async Service Web Service provides capability to implement block related asynchronous operations in OPERA Cloud.
paths:
  /externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary:
    post:
      summary: This API facilitates fetching block allocation summary for a Hotel.
      description: This API will fetch Block allocation information for a hotel, and specified date range. The block allocated inventory, rates and room type statistics are returned as part of the response. The maximum limit of date range (whether using start/endDate or startLastModifiedDate/endLastModifiedDate) is 94 days, but the recommendation is to use a date range proportionate to the size of the hotel.   Every identical request (employing the same query parameters) for the getBlockAllocationSummary operation when requesting data with start/endDate or startLastModifiedDate/endLastModifiedDate, necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed. The API returns a header parameter location that can be used in the getBlockAllocationSummaryProcessStatus operation.  Use event-driven APIs -(see https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_business_events.htm#OHIPU-BusinessEvents-F0AC1F1C) -to get real-time block updates. <p><strong>OperationId:</strong>startBlockAllocationSummaryProcess</p>
      operationId: startBlockAllocationSummaryProcess
      x-interaction:
      - async-polling
      responses:
        '202':
          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 process status 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/links'
        '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'
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: extSystemCode
        in: path
        required: true
        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/Accept-Language'
      tags:
      - BlockAsync
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/criteria'
        description: Request object for fetching block allocation summary asynchronously.
        required: true
  /externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary/{requestId}:
    head:
      summary: This API returns the status of asynchronous process scheduled for given id.
      description: ' <p><strong>OperationId:</strong>getBlockAllocationSummaryProcessStatus</p>'
      operationId: getBlockAllocationSummaryProcessStatus
      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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Processing
                - Invalid
            Cache-Control:
              description: number of seconds to wait before polling again.
              x-example: max-age=10
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Completed
            Location:
              description: Location of newly created resource once the status of process run is Complete.
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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'
      parameters:
      - name: requestId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: extSystemCode
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        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/Accept-Language'
      tags:
      - BlockAsync
    get:
      summary: This API returns a hotel's block allocation summary for a scheduled process.
      description: This API will fetch Block allocation information for a hotel, and specified date range.  The block allocated inventory, rates and room type statistics are returned as part of the response. <p><strong>OperationId:</strong>getBlockAllocationSummary</p>
      operationId: getBlockAllocationSummary
      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: Callback request object for fetched block allocation summary.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/blockAllocationSummary'
        '204':
          description: BlockAllocationSummary 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'
      parameters:
      - name: requestId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: extSystemCode
        in: path
        required: true
        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/Accept-Language'
      tags:
      - BlockAsync
  /hotels/{hotelId}/blocks/{blockId}/allocation:
    post:
      summary: This API facilitates setting Block Allocations for a Hotel.
      description: Use this API to add block room type allocations and rates to a specified Block. <p><strong>OperationId:</strong>startBlockAllocationProcess</p>
      operationId: startBlockAllocationProcess
      x-interaction:
      - async-polling
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        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/Accept-Language'
      responses:
        '202':
          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 process status 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/links'
        '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:
      - BlockAsync
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/allocation'
        description: A Request message that sets the room allocations as a collection of room types and dates.
        required: true
  /hotels/{hotelId}/blocks/{blockId}/allocation/{requestId}:
    head:
      summary: This API returns the status of asynchronous process scheduled for given id.
      description: ' <p><strong>OperationId:</strong>getBlockAllocationProcessStatus</p>'
      operationId: getBlockAllocationProcessStatus
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Processing
                - Invalid
            Cache-Control:
              description: number of seconds to wait before polling again.
              x-example: max-age=10
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Completed
            Location:
              description: Location of newly created resource once the status of process run is Complete.
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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:
      - BlockAsync
    get:
      summary: This API returns information about the set allocation process.
      description: This API will fetch Block allocation warnings for a hotel to allow for overbooking information to be returned as part of the response. <p><strong>OperationId:</strong>getBlockAllocationProcessInfo</p>
      operationId: getBlockAllocationProcessInfo
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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: Callback request object for fetched block allocation process information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/processDetails'
        '204':
          description: BlockAllocationProcessInfo 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:
      - BlockAsync
  /hotels/{hotelId}/blocks/{blockId}/allocationRanges:
    post:
      summary: This API facilitates setting Block Allocation Ranges for a Hotel.
      description: Use this API to set business block allocation for one or more date ranges, which are within business block date range, and for a list of room types. <p><strong>OperationId:</strong>startAllocationRangesProcess</p>
      operationId: startAllocationRangesProcess
      x-interaction:
      - async-polling
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        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/Accept-Language'
      responses:
        '202':
          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 process status 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/links'
        '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:
      - BlockAsync
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/allocationRanges'
        description: Request for updating block allocations for ranges of dates and list of room types.
        required: true
  /hotels/{hotelId}/blocks/{blockId}/allocationRanges/{requestId}:
    head:
      summary: This API returns the status of asynchronous process scheduled for given id.
      description: ' <p><strong>OperationId:</strong>getAllocationRangesProcessStatus</p>'
      operationId: getAllocationRangesProcessStatus
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Processing
                - Invalid
            Cache-Control:
              description: number of seconds to wait before polling again.
              x-example: max-age=10
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Completed
            Location:
              description: Location of newly created resource once the status of process run is Complete.
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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:
      - BlockAsync
    get:
      summary: This API returns information about the set allocation ranges process.
      description: This API will fetch Block allocation ranges warnings for a hotel to allow for overbooking information to be returned as part of the response. <p><strong>OperationId:</strong>getAllocationRangesProcessInfo</p>
      operationId: getAllocationRangesProcessInfo
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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: Callback request object for fetched block allocation process information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/processDetails'
        '204':
          description: AllocationRangesProcessInfo 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:
      - BlockAsync
  /hotels/{hotelId}/blocks/{blockId}/shift:
    post:
      summary: Shifts the Block start date.
      description: Use this API to move or shift the dates of a block in OPERA. <p><strong>OperationId:</strong>startShiftBlockProcess</p>
      operationId: startShiftBlockProcess
      x-interaction:
      - async-polling
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        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/Accept-Language'
      responses:
        '202':
          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 process status 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/links'
        '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:
      - BlockAsync
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/blockToShift'
        description: Request object to shift business block starting date.
        required: true
  /hotels/{hotelId}/blocks/{blockId}/shift/{requestId}:
    head:
      summary: This API returns the status of asynchronous process scheduled for given id.
      description: ' <p><strong>OperationId:</strong>getShiftBlockProcessStatus</p>'
      operationId: getShiftBlockProcessStatus
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Processing
                - Invalid
            Cache-Control:
              description: number of seconds to wait before polling again.
              x-example: max-age=10
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Completed
            Location:
              description: Location of newly created resource once the status of process run is Complete.
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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:
      - BlockAsync
    get:
      summary: This API returns information about the shift block process.
      description: This API will fetch shift Block warnings and errors to be returned as part of the response. <p><strong>OperationId:</strong>getShiftBlockProcessInfo</p>
      operationId: getShiftBlockProcessInfo
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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: Callback request object for fetched shift block process information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/processDetails'
        '204':
          description: Shift Block information 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:
      - BlockAsync
  /hotels/{hotelId}/blocks/{blockId}/recalculateRoomForecast:
    post:
      summary: This API facilitates setting recalculation for forecast room rates in a business block.
      description: Use this API to recalculate room forecast rates
      operationId: startRecalculateRoomForecastProcess
      x-interaction:
      - async-polling
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel code where the Block resides.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 40
          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/Accept-Language'
      responses:
        '202':
          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 process status 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/links'
      tags:
      - BlockAsync
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/blockId'
        description: Unique OPERA Block ID which is used to find a Block from OPERA.
  /hotels/{hotelId}/blocks/{blockId}/recalculateRoomForecast/{requestId}:
    head:
      summary: This API returns the status of asynchronous process scheduled for given id.
      description: ' <p><strong>OperationId:</strong>getRecalculateRoomForecastProcessStatus</p>'
      operationId: getRecalculateRoomForecastProcessStatus
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Processing
                - Invalid
            Cache-Control:
              description: number of seconds to wait before polling again.
              x-example: max-age=10
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Completed
            Location:
              description: Location of newly created resource once the status of process run is Complete.
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
      tags:
      - BlockAsync
    get:
      summary: This API returns information about the recalculate room forecast rates process.
      description: This API will fetch recalculate room forecast warnings and errors to be returned as part of the response.<p><strong>OperationId:</strong>getRecalculateRoomForecastProcessInfo</p>
      operationId: getRecalculateRoomForecastProcessInfo
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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: Callback request object for fetched recalculate room forecast process information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/processDetails'
        '204':
          description: Information related to recalculateRoomForecast request not found.
      tags:
      - BlockAsync
  /hotels/{hotelId}/blocks/{blockId}/refreshProjectedRevenues:
    post:
      summary: This API facilitates refreshing projected revenues for a business block.
      description: Use this API to refresh Business Block projected revenues
      operationId: startRefreshProjectedRevenuesProcess
      x-interaction:
      - async-polling
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel code where the Business Block resides.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA ID which is used to find a Block in OPERA Cloud. This ID is a primary identification of a Business Block in OPERA Cloud.
        schema:
          type: string
          maxLength: 40
          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/Accept-Language'
      responses:
        '202':
          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 process status 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/links'
      tags:
      - BlockAsync
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/blockId'
        description: Unique OPERA ID which is used to find a Business Block in OPERA Cloud.
  /hotels/{hotelId}/blocks/{blockId}/refreshProjectedRevenues/{requestId}:
    head:
      summary: This API returns the status of asynchronous process scheduled for given id.
      description: ' <p><strong>OperationId:</strong>getRefreshProjectedRevenuesProcessStatus</p>'
      operationId: getRefreshProjectedRevenuesProcessStatus
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel code where the Business Block resides.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA ID which is used to find a Block in OPERA Cloud. This ID is a primary identification of a Business Block in OPERA Cloud.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Processing
                - Invalid
            Cache-Control:
              description: number of seconds to wait before polling again.
              x-example: max-age=10
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Completed
            Location:
              description: Location of newly created resource once the status of process run is Complete.
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
      tags:
      - BlockAsync
    get:
      summary: This API returns information about the Business Block projected revenues refresh process.
      description: To include as part of response, this API will fetch warnings and/or errors (if any) from Business Block projected revenues refresh process.<p><strong>OperationId:</strong>getRefreshProjectedRevenuesProcessInfo</p>
      operationId: getRefreshProjectedRevenuesProcessInfo
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Hotel code where the Business Block resides.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA ID which is used to find a Block in OPERA Cloud. This ID is a primary identification of a Business Block in OPERA Cloud.
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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: Callback request object for fetched recalculate room forecast process information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/processDetails'
        '204':
          description: Information related to recalculateRoomForecast request not found.
      tags:
      - BlockAsync
  /hotels/{hotelId}/blocks/{blockId}/async:
    post:
      summary: Use this API to retrieve a Block by ID using an asynchronous process.
      description: Initiates an asynchronous operation to retrieve a block by ID.  You will need to know the blockID in the request; if you don't know it, please go ahead and use getBlocks API first.  The response will include detailed information about the block. <p><strong>OperationId:</strong>postStartFetchBlockProcess</p>
      operationId: postStartFetchBlockProcess
      x-interaction:
      - async-polling
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: markAsRecentlyAccessed
        in: query
        required: false
        description: Mark this block as recently accessed.
        schema:
          type: boolean
      - name: fetchInstructions
        in: query
        description: Type for block instructions that can be used in requests for partial operations.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - AccessExclusions
            - Aliases
            - AlternateDates
            - Attachments
            - Block
            - BlockNextStatuses
            - BlockStatusHistory
            - CatNextStatuses
            - CatStatusHistory
            - CentralSalesLeads
            - Comments
            - DateProtect
            - ExternalReferences
            - GenericRateGrid
            - Header
            - Indicators
            - InventoryItems
            - Owners
            - Packages
            - Policies
            - PrimaryOwners
            - PrimaryProfiles
            - PrimaryRates
            - Profiles
            - RateGrid
            - RateProgram
            - Rates
            - Restrictions
            - SellMessages
            - Statistics
            - SummaryStatistics
            - Traces
            - WashSchedules
          uniqueItems: true
      - name: fetchAllocatedRoomTypes
        in: query
        required: false
        description: Indicates whether to fetch only those room types that have rooms or rates allocated. If this flag is true then only those room types with rooms or rates allocated for the block are fetched. Only applicable to fetch instruction RateGrid.
        schema:
          type: boolean
      - name: startDate
        in: query
        required: false
        description: Start Date for the rate grid data. Only applicable to fetch instruction RateGrid.
        schema:
          type: string
          format: date
      - name: numberOfDays
        in: query
        required: false
        description: Number of days to fetch for the rate grid data. Only applicable to fetch instruction RateGrid. If this query parameter is not provided, the API defaults to returning data for 7 days.
        schema:
          type: number
      - name: roomAllocationCriteria
        in: query
        description: Simple type for block allocation used in room rate grid.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Initial
            - Actual
            - Rates
            - Pickup
            - Contract
            - Available
            - Pickupperc
            - Changes
            - Released
            - Houseavailability
            - SellLimit
            - AvailableSellLimit
            - MasterAllocInitial
            - Allocated
            - SubAllocResv
            - CutoffDate
            - ForecastRooms
            - ForecastRates
          uniqueItems: true
      - name: roomTypes
        in: query
        description: The Room Types that need to be fetched for the rate room grid data. If these values are not provided, all room types for the block will be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: fetchRoomTypesWithInventory
        in: query
        required: false
        description: Indicates whether to fetch only those room types that have rooms allocated. If this flag is true then only those room types with rooms allocated for the block are fetched. Only applicable to fetch instruction RateGrid.
        schema:
          type: boolean
          default: false
      - $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/Accept-Language'
      responses:
        '202':
          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 process status 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/links'
      tags:
      - BlockAsync
  /hotels/{hotelId}/blocks/{blockId}/async/{requestId}:
    head:
      summary: This API returns the status of asynchronous process scheduled for given id.
      description: ' Use this to check whether the request sent have been processed or not. <p><strong>OperationId:</strong>headFetchBlockProcessStatus</p>'
      operationId: headFetchBlockProcessStatus
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Processing
                - Invalid
            Cache-Control:
              description: number of seconds to wait before polling again.
              x-example: max-age=10
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
        '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})*'
            Status:
              description: Status of the requested process.
              schema:
                type: string
                enum:
                - Completed
            Location:
              description: Location of newly created resource once the status of process run is Complete.
              schema:
                type: string
          description: Response for status of scheduled asynchronous process.
      tags:
      - BlockAsync
    get:
      summary: The API returns information about the block retrieval request.
      description: This API will fetch block information requested. <p><strong>OperationId:</strong>getFetchBlockProcess</p>
      operationId: getFetchBlockProcess
      parameters:
      - name: hotelId
        in: path
        required: true
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: blockId
        in: path
        required: true
        description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: requestId
        in: path
        required: true
        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/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: Callback request object for fetched block Block information requested.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/block'
        '204':
          description: getBlockProcessInfo not found.
      tags:
      - BlockAsync
components:
  schemas:
    roomAllocationTypeType:
      type: object
      description: A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.
      properties:
        roomAllocationInfo:
          description: Allocation objects for a block.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomAllocationInfoType'
        allocation:
          description: Indicates the type of the Allocation objects.
          $ref: '#/components/schemas/allocationType'
    packagePostingRulesType:
      type: object
      properties:
        transactionCode:
          description: The Transaction code used to post the package price.
          $ref: '#/components/schemas/packageTransactionCodeType'
        overageCode:
          description: The overage code to record over consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        profitCode:
          description: The transaction code to record package profit, if any, from un-consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        lossCode:
          description: The transaction code to record package Loss, if any, from un-consumed allowance.
          $ref: '#/components/schemas/packageTransactionCodeType'
        alternateCodesList:
          description: The alternate transaction code that can be consumed by the guest in place of the transaction code.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/packageTransactionCodeType'
    revenueSummaryType:
      type: object
      description: Summary information pertaining to revenue like Room, Food and Beverage, Catering, Other, Catering Other and Total Revenue.
      properties:
        roomRevenue:
          type: number
        foodAndBeverageRevenue:
          type: number
        otherRevenue:
          type: number
        cateringRevenue:
          type: number
        cateringOtherRevenue:
          type: number
        totalRevenue:
          type: number
        nonRevenue:
          type: number
    masterSubBlockBaseInfoType:
      type: object
      properties:
        blockIdList:
          description: Collection of unique block identifiers.
          $ref: '#/components/schemas/blockIdList'
        hotelId:
          description: Master/Sub Block's Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        blockType:
          description: Indicate Block Classification.
          $ref: '#/components/schemas/blockClassificationType'
        timeSpan:
          description: The Time Span(Arrival, Departure) which covers the Block Span.
          $ref: '#/components/schemas/timeSpanType'
        blockName:
          description: Block description.
          type: string
          minLength: 0
          maxLength: 2000
        blockStatus:
          description: Current status of the block.
          $ref: '#/components/schemas/bookingStatusType'
        cateringStatus:
          description: Catering Status details of the block.
          $ref: '#/components/schemas/bookingStatusType'
        roomNights:
          description: Pertain value for blocked rooms for a block.
          type: integer
        roomNightsPickedup:
          description: Pertain value for reserved rooms for a block.
          type: integer
        syncBlockDates:
          description: Indicates to check if Block Dates to be in sync.
          type: boolean
        syncOtherBlockDetails:
          description: Indicates whether other BlockDetails to be in Sync.
          type: boolean
        syncBlockStatusDetails:
          description: Indicates if Block Status Details to be in sync.
          type: boolean
        syncPackages:
          description: Indicates if packages to be in Sync.
          type: boolean
    roomStatisticsType:
      type: object
      properties:
        roomCount:
          description: The total number of rooms.
          type: number
        roomRevenue:
          description: The total revenue for the rooms.
          type: number
        averageRate:
          description: The average rate per room.
          type: number
    cateringStatusChangeHistoryType:
      type: array
      description: Collection of catering status history.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/bookingStatusHistoryType'
    allocationGridByDateRangeType:
      type: object
      description: Indicates the block allocations for a date range. This can be rooms or rate amounts.
      properties:
        inventory:
          description: Indicates the room inventory values per person occupancy.
          $ref: '#/components/schemas/setBlockGridInvType'
        rate:
          description: Indicates the rate amount values per person occupancy.
          $ref: '#/components/schemas/blockGridRatesType'
        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
    setBlockGridInvType:
      type: object
      description: Indicates the inventory values (occupancy or availability) per person occupancy.
      properties:
        onePerson:
          description: Indicates the one person inventory value (occupancy or availability).
          type: integer
        twoPerson:
          description: Indicates the two person inventory value (occupancy or availability).
          type: integer
        threePerson:
          description: Indicates the three person inventory value (occupancy or availability).
          type: integer
        fourPerson:
          description: Indicates the four person inventory value (occupancy or availability).
          type: integer
        sellLimit:
          description: Indicates the sell limit
          type: integer
        cutoffDate:
          description: Indicates the cutoff date.Date when inventory left in the block will be cut-off.
          type: string
          format: date
          maxLength: 8
        forceOverbook:
          description: Indicates whether to overbook the rooms in case there are not enough rooms at the house or room type level.
          type: boolean
    configPackageUsageDetailType:
      type: object
      description: A Config Package Usage Detail type.
      properties:
        source:
          description: Indicates if the source of the product is Rate header, Rate Detail or Reservation.
          $ref: '#/components/schemas/productSourceType'
        usedInReservations:
          description: Indicates if the package is used in, reserved or prospect reservations.
          type: boolean
        usedInRates:
          description: Indicates if the package is used in any rate code.
          type: boolean
        usedInHouseReservations:
          description: Indicates if any checked in reservations are using this product.
          type: boolean
    policyBasisTypeType:
      type: string
      description: Full Amount.
      enum:
      - FlatAmount
      - Percentage
      - Nights
      - NightPercentage
      - FullAmount
    blocksType:
      type: object
      description: A collection of Block objects or Unique IDs of Blocks.
      properties:
        blockInfo:
          description: A collection of Blocks or Unique IDs of Blocks.
          type: array
          maxItems: 4000
          items:
            type: object
            properties:
              block:
                description: Provides detailed information regarding a block.
                $ref: '#/components/schemas/blockType'
        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
    blockRangeModeType:
      type: string
      description: Enumerates range operation modes.
      enum:
      - Core
      - ShoulderStart
      - ShoulderEnd
    numericUDFType:
      type: object
      description: Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
      properties:
        name:
          description: Name of user defined field.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: number
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    blockAllocationSummaryType:
      type: object
      properties:
        hotelId:
          description: Hotel code for the block
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          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: number
          minLength: 0
          maxLength: 80
        currency:
          description: Currency code to reflect the currency for room rates.
          type: string
        blockCode:
          description: Defined block code for the block.
          type: string
          minLength: 0
          maxLength: 20
        blockName:
          description: Name of the block.
          type: string
          minLength: 0
          maxLength: 2000
        masterBlockId:
          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: number
          minLength: 0
          maxLength: 80
        status:
          description: Booking Status of the block.
          type: string
          minLength: 0
          maxLength: 20
        marketCode:
          description: Market Code of the block.
          type: string
          minLength: 0
          maxLength: 20
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        cutOffDate:
          type: string
          format: date-time
        cutOffDays:
          type: integer
        cancellationDate:
          description: Cancellation Date.
          type: string
          format: date-time
        cancellationCode:
          description: Code that idenfies the reason for cancellation.
          type: string
          minLength: 0
          maxLength: 20
        cancellationDescription:
          description: Description that explains the reason for cancellation.
          type: string
          minLength: 0
          maxLength: 2000
        cateringOwner:
          description: Catering Owner
          type: integer
        cateringOwnerCode:
          description: Primary Catering Owner Code
          type: string
          minLength: 0
          maxLength: 10
        cateringOwnerResort:
          description: Property of Catering Owner
          type: string
          minLength: 0
          maxLength: 20
        owner:
          description: Owner ID
          type: integer
        ownerCode:
          description: Block Owner Code
          type: string
          minLength: 0
          maxLength: 10
        ownerResort:
          description: Property of Business Block Owner
          type: string
          minLength: 0
          maxLength: 20
        roomsOwner:
          description: Rooms Owner
          type: integer
        roomsOwnerCode:
          description: Primary Rooms Owner Code
          type: string
          minLength: 0
          maxLength: 10
        roomsOwnerResort:
          description: Property of Rooms Owner
          type: string
          minLength: 0
          maxLength: 20
        createDateTime:
          description: The business date the block was created.
          type: string
          format: date-time
        blockType:
          description: Indicates the internal type of the block like G, etc.
          type: string
          minLength: 0
          maxLength: 1
        reservationMethod:
          description: Booking Method.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: Rate code associated with Block.
          type: string
          minLength: 0
          maxLength: 20
        lastModifiedDate:
          description: Date Time when the block was modified last.
          type: string
          format: date-time
        sourceCode:
          description: Source of the Block.
          type: string
          minLength: 0
          maxLength: 20
        allocationDates:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomAllocationDateType'
        bookingMedium:
          description: Booking Medium/Origin Code of the Block.
          type: string
          minLength: 0
          maxLength: 20
        blockProfiles:
          description: A collection of all the Primary Profiles associated to a this block.
          type: object
          properties:
            blockProfile:
              description: The list of primary profiles associated with the block.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/blockProfilesType'
    blockNonCompeteType:
      type: object
      description: Block Non Compete code information.
      properties:
        industry:
          description: Specifies the Non-Compete Industry.>
          type: string
          minLength: 0
          maxLength: 20
        industryDescription:
          description: Specifies the Non-Compete Industry description.>
          type: string
          minLength: 0
          maxLength: 2000
        criteria:
          description: Indicates the type of Non-Compete. 'All' means all dates are Non-Compete. 'None' specifies Non-Compete is disabled. 'Selected' specifies few dates are Non-Compete.
          $ref: '#/components/schemas/rateProtectionType'
        protectedDates:
          description: Specifies all the Non-Compete dates in the selected date range.
          $ref: '#/components/schemas/datesType'
    cateringRevenueType:
      type: object
      description: Information about Catering Revenue.
      properties:
        serviceCharge:
          description: The service charge for the Catering Events that will be added to the business block.
          $ref: '#/components/schemas/currencyAmountType'
        taxAmount:
          description: The tax amount for the Catering Events that will be added to the business block.
          $ref: '#/components/schemas/currencyAmountType'
        itemDiscount:
          description: Item discount for the block.
          type: number
        itemDiscountPercentage:
          description: The discount percentage to be applied to resource items associated with catering events.
          type: number
          minimum: 0
          maximum: 100
    personNameType:
      type: object
      description: This provides name information for a person.
      properties:
        givenName:
          description: Given name, first name or names.
          type: string
          minLength: 0
          maxLength: 40
        surname:
          description: Family name, last name.
          type: string
          minLength: 0
          maxLength: 40
    blockOwnerType:
      type: object
      description: Generic type for information about an owner.
      properties:
        hotel:
          description: Hotel to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        userId:
          description: Unique application user ID.
          $ref: '#/components/schemas/uniqueID_Type'
        userName:
          description: Unique application user name of the owner.
          type: string
          minLength: 0
          maxLength: 40
        ownerCode:
          description: Unique Code to identify the owner.
          type: string
          minLength: 0
          maxLength: 20
        profileId:
          description: Unique owner profile information.
          $ref: '#/components/schemas/profileId'
        name:
          description: Provides name information of the owner.
          $ref: '#/components/schemas/personNameType'
        department:
          description: Department to which the owner belongs to.
          $ref: '#/components/schemas/codeDescriptionType'
        email:
          description: Email information of the owner.
          $ref: '#/components/schemas/emailInfoType'
        phone:
          description: Information on the telephone number of the owner.
          $ref: '#/components/schemas/telephoneInfoType'
        relationship:
          description: Relationship of the owner within the profile or block.
          $ref: '#/components/schemas/codeDescriptionType'
        primary:
          description: When true, this is a primary owner.
          type: boolean
        ownership:
          description: Specifies the business block ownership type.
          $ref: '#/components/schemas/blockOwnershipType'
    packageCodeHeaderType:
      type: object
      properties:
        primaryDetails:
          description: Package code header primary details.
          $ref: '#/components/schemas/configPackagePrimaryDetailsType'
        transactionDetails:
          description: Package code header transaction information.
          $ref: '#/components/schemas/configPackageTransactionType'
        postingAttributes:
          description: Package code posting attributes.
          $ref: '#/components/schemas/configPostingAttributesType'
        usageDetails:
          description: Package code usage information.
          $ref: '#/components/schemas/configPackageUsageDetailType'
    commentInfoType:
      type: object
      description: Comment related to the profile/reservation.
      properties:
        comment:
          description: Comment details for the comment. It will be empty in case of delete comment.
          $ref: '#/components/schemas/commentType'
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        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: 20
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        warnings:
          $ref: '#/components/schemas/warningsType'
    datesType:
      type: array
      description: Specifies a single date.
      maxItems: 4000
      items:
        type: string
        format: date
        maxLength: 8
    rateProgramType:
      type: object
      description: Rate Programs for the Block.
      properties:
        roomPool:
          description: Room Pool Code.
          type: string
          minLength: 0
          maxLength: 20
        rates:
          description: Block Rate Program Rates.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/rateProgramRateType'
    amountDeterminationType:
      type: string
      description: Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
      enum:
      - Inclusive
      - Exclusive
    bookingChannelMappingType:
      type: object
      properties:
        bookingChannelCode:
          type: string
          minLength: 0
          maxLength: 20
        code:
          type: string
          minLength: 0
          maxLength: 20
        name:
          type: string
          minLength: 0
          maxLength: 40
        description:
          type: string
          minLength: 0
          maxLength: 2000
    statisticsSummaryType:
      type: string
      description: Type of statistic for which summary information is populated.
      enum:
      - Potential
      - Actual
      - Variance
    blockGridInvType:
      type: object
      description: Indicates the inventory values ( occupancy or availability ) per person occupancy.
      properties:
        onePerson:
          description: Indicates the one person inventory value ( occupancy or availability ).
          type: integer
        twoPerson:
          description: Indicates the two person inventory value ( occupancy or availability ).
          type: integer
        threePerson:
          description: Indicates the three person inventory value ( occupancy or availability ).
          type: integer
        fourPerson:
          description: Indicates the four person inventory value ( occupancy or availability ).
          type: integer
        sellLimit:
          description: Indicates the sell limit
          type: integer
        cutoffDate:
          description: Indicates the cutoff date.Date when inventory left in the block will be cut-off.
          type: string
          format: date
          maxLength: 8
    pkgInventoryItemType:
      type: object
      properties:
        articleNumber:
          description: Article Number of the inventory item.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of the inventory item.
          type: string
          minLength: 0
          maxLength: 200
        quantity:
          description: Quantity of the inventory item allocated to the package.
          type: integer
        itemId:
          description: Identifier for the inventory item.
          type: integer
    blockCancellationTypeType:
      type: string
      description: Simple type for cancellation reasons which helps to decide type of cancellation.
      enum:
      - Lost
      - Cancel
      - Refused
    roomAllocationDateType:
      type: object
      properties:
        allocationDate:
          description: The block date for which the allocation details are listed.
          type: string
          format: date-time
        allocations:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomAllocationDetailsType'
    processDetails:
      type: object
      description: Response object to hold the details of process.
      properties:
        status:
          description: Status of the process.
          $ref: '#/components/schemas/statusType'
        cateringEventsProcessedInfo:
          description: Status of the processed events after the process.
          $ref: '#/components/schemas/cateringEventsProcessedInfoList'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    characterUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Character/String Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/characterUDFType'
    indicatorsType:
      type: array
      description: Collection of lamp indicators.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/indicatorType'
    timeSpanType:
      type: object
      description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.
      properties:
        startDate:
          type: string
          format: date
          maxLength: 8
        endDate:
          type: string
          format: date
          maxLength: 8
        duration:
          type: string
    blockAliasesType:
      type: array
      description: List of Block Aliases.
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 40
    indicatorType:
      type: object
      description: Lamp indicator Type.
      properties:
        indicatorName:
          description: Name of the indicator.
          type: string
          minLength: 0
          maxLength: 80
        count:
          description: Indicates number of occurrences of the indicator.
          type: integer
    mealPlansType:
      type: array
      description: Meal plan codes associated with the rate codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/mealPlanCodeType'
    blockRateProtectionType:
      type: object
      description: Block Rate Protection code information.
      properties:
        criteria:
          description: Indicates the type of rate protection. 'All' means all dates are rate protected. 'None' specifies no rate protection. 'Selected' specifies few dates are rate protected.
          $ref: '#/components/schemas/rateProtectionType'
        protectedDates:
          description: Specifies all the Rate protected dates in the selected range.
          $ref: '#/components/schemas/datesType'
    timeWindowType:
      type: object
      description: Defines a Time period with start time and an end time.
      properties:
        startTime:
          description: Start Time of the Time window.
          type: string
        endTime:
          description: End Time of the Time window.
          type: string
    imageStyleType:
      type: string
      description: An enumeration of image styles.
      enum:
      - Full
      - Thumbnail
      - Icon
      - Square
      - Banner
      - Button
      - Lowres
      - Highres
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 100
      items:
        $ref: '#/components/schemas/warningType'
    statusColorType:
      type: string
      description: Status code color configuration type.
      enum:
      - White
      - Red
      - Blue
      - Cyan
      - Magenta
      - Green
      - Brown
      - Black
      - Yellow
      - Gray
    blockInventoryItemType:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
        item:
          description: Specifies Items and its attributes. When used for data manipulation for Items setup on reservation, etc only code is considered. Other Attributes are for used to provide information during fetch operation.
          $ref: '#/components/schemas/itemInfoType'
        quantity:
          description: Number of items booked.
          type: integer
        timeSpan:
          description: Begin and end date and time of the items applicability.
          $ref: '#/components/schemas/dateRangeType'
        source:
          description: If exists specifies whether the item is setup due to a Rate Plan, Package or a Block.
          $ref: '#/components/schemas/blockInventoryItemSourceType'
    uniqueID_Type:
      type: object
      description: An identifier used to uniquely reference an object in a system.
      properties:
        id:
          description: A unique identifying value assigned by the creating system.
          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: 20
    telephoneType:
      type: object
      description: Information on a telephone number for the customer.
      properties:
        phoneTechType:
          description: Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.
          type: string
          minLength: 0
          maxLength: 20
        phoneUseType:
          description: Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
          type: string
          minLength: 0
          maxLength: 20
        phoneUseTypeDescription:
          description: Description of the PhoneUseType code
          type: string
          minLength: 0
          maxLength: 2000
        phoneNumber:
          description: Telephone number assigned to a single location.
          type: string
          minLength: 0
          maxLength: 40
        extension:
          description: Extension to reach a specific party at the phone number.
          type: string
          minLength: 0
          maxLength: 20
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
    currencyAmountType:
      type: object
      description: A monetary value expressed with a currency code.
      properties:
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    customerType:
      type: object
      description: Contains basic data on the customer's identity.
      properties:
        personName:
          description: Detailed name information for thecustomer.
          type: array
          maxItems: 5
          items:
            $ref: '#/components/schemas/personNameType'
    telephoneInfoType:
      type: object
      description: Information on a telephone number for the customer.
      properties:
        telephone:
          description: Phone details for the profile.
          $ref: '#/components/schemas/telephoneType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        warnings:
          $ref: '#/components/schemas/warningsType'
    sellMessageConfigType:
      type: object
      description: 'Only one of the following can hold a value: HotelCode, CROCode or ChainCode'
      properties:
        message:
          description: Sell message text.
          type: string
          minLength: 0
          maxLength: 2000
        blockId:
          description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
          $ref: '#/components/schemas/blockId'
        blockCode:
          description: Block Code to which the sell message is defined.
          type: string
          minLength: 0
          maxLength: 20
        timespan:
          description: Begin and End date for the sell message.
          $ref: '#/components/schemas/timeSpanType'
        hotelId:
          description: Hotel Code for which the sell message is defined.
          type: string
          minLength: 0
          maxLength: 20
        croCode:
          description: CRO Code for which the sell message is defined.
          type: string
          minLength: 0
          maxLength: 20
        chainCode:
          description: Chain Code for which the sell message is defined.
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Room type for which the sell message is defined.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: Rate Plan Code for which the sell message is defined.
          type: string
          minLength: 0
          maxLength: 20
        languageCode:
          description: Language in which the sell message is defined.
          type: string
          minLength: 0
          maxLength: 20
        stickyFlag:
          description: Sticky flag is used to define if the sell message should display on the block screen by default.
          type: boolean
        sellSequence:
          description: This number indicates the display order of the sell message.
          type: number
        usedInModule:
          description: This represents the moduleType where we want to display this SellMessage.
          type: array
          maxItems: 10
          items:
            $ref: '#/components/schemas/usedInModuleType'
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
    rateProtectionType:
      type: string
      description: Simple type for specifying the block protection type.
      enum:
      - All
      - Selected
      - None
    dateTimeStampGroupType:
      type: object
      properties:
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
        purgeDate:
          description: Date an item will be purged from a database (e.g., from a live database to an archive).
          type: string
          format: date
          maxLength: 8
    blockOwnershipType:
      type: string
      description: Specifies the type of the owner associated with the business block(Block/Rooms/Catering).
      enum:
      - Block
      - Rooms
      - Catering
    timeSpanDaysOfWeekType:
      type: object
      description: Container for Time span with days of week.
      properties:
        timeSpan:
          $ref: '#/components/schemas/timeSpanType'
        sunday:
          type: boolean
        monday:
          type: boolean
        tuesday:
          type: boolean
        wednesday:
          type: boolean
        thursday:
          type: boolean
        friday:
          type: boolean
        saturday:
          type: boolean
    blockStatisticsSummaryType:
      type: object
      description: Type to store summary detail like rooms sold, average room rate and revenue for a statistic type.
      properties:
        roomsSold:
          description: Total Number of Rooms Picked Up.
          type: integer
        revenueSummary:
          $ref: '#/components/schemas/revenueSummaryType'
        avgRoomRate:
          type: number
        statisticType:
          $ref: '#/components/schemas/statisticsSummaryType'
    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
    guaranteeType:
      type: object
      description: Specifies Guarantee Code attributes.
      properties:
        description:
          description: Description of the Guarantee Code.
          type: string
          minLength: 0
          maxLength: 2000
        requirements:
          description: Specifies various requirements for the guarantee code.
          $ref: '#/components/schemas/guaranteeRequirementsType'
        shortDescription:
          description: Brief description of the Guarantee Code.
          $ref: '#/components/schemas/translationTextType80'
        paymentTypes:
          description: Specifies various payment types for the guarantee code.
          $ref: '#/components/schemas/paymentTypesType'
        guaranteeCode:
          description: Code assigned to the Guarantee.
          type: string
          minLength: 0
          maxLength: 20
        onHold:
          description: If true indicates this Guarantee Code is used only to hold the inventory during reservation process.
          type: boolean
        reserveInventory:
          description: If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        lateArrival:
          description: Represents the late arrival time.
          type: string
    allocation:
      type: object
      description: A Request message that sets the room allocations as a collection of room types and dates.
      properties:
        criteria:
          description: This element contains the block allocations as a collection of room types and dates.
          $ref: '#/components/schemas/allocationGridByRoomTypesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    blockAccessExclusionType:
      type: object
      description: Access Exclusion information indicating the actions allowed under a HUB or Hotel for which the access exclusion is set.
      properties:
        sourceType:
          description: The type of source (CRO or Hotel code) for which the rate access exclusion is set.
          type: string
          minLength: 0
          maxLength: 40
        sourceValue:
          description: CRO or Hotel code value.
          type: string
          minLength: 0
          maxLength: 80
        allowModifyReservation:
          description: Allow to modify a reservation under this access exclusion.
          type: boolean
        allowCancelReservation:
          description: Allow to cancel a reservation under this access exclusion.
          type: boolean
        allowCreateReservation:
          description: Allow to create a reservation under this access exclusion.
          type: boolean
        inactive:
          description: The rate access exclusion is inactive
          type: boolean
        excludeFromAvailability:
          description: Exclude a specific rate from availability
          type: boolean
    blockActualRevenueType:
      type: object
      description: Indicates the sum of revenue breakup per room type per block per allocation date for the reservations. Applicable for past dates, business date or future dates.
      properties:
        roomRevenue:
          description: Indicates room revenue amount.
          type: number
        foodRevenue:
          description: Indicates food revenue amount.
          type: number
        otherRevenue:
          description: Indicates other revenue amount.
          type: number
        nonRevenue:
          description: Indicates non revenue amount.
          type: number
        totalRevenue:
          description: Indicates total revenue amount.
          type: number
        roomRevenueTax:
          description: Indicates room revenue tax amount.
          type: number
        foodRevenueTax:
          description: Indicates food revenue tax amount.
          type: number
        otherRevenueTax:
          description: Indicates other revenue tax amount.
          type: number
        nonRevenueTax:
          description: Indicates non revenue tax amount.
          type: number
        totalRevenueTax:
          description: Indicates total revenue tax amount.
          type: number
        currency:
          description: Currency code to reflect the currency in which an amount may be expressed.
          type: string
    rateProgramRoomType:
      type: array
      description: Room type for which Rate Program Rate Applies.
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    breakfastType:
      type: object
      description: Information about breakfast charges.
      properties:
        breakfastIncluded:
          description: Indicates if the room rate quoted includes the breakfast cost.
          type: boolean
        price:
          description: The additional charges per person for breakfast, if breakfast is not included in the rate.
          $ref: '#/components/schemas/currencyAmountType'
        description:
          description: The exact breakfast method for this business block that is included or offered as an extra.
          type: string
          minLength: 0
          maxLength: 40
    cateringEventsProcessedInfoType:
      type: object
      description: Status/Info of the processed events.
      properties:
        hotelId:
          description: Hotel code where event will be copied.
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          description: BlockID of the event.
          $ref: '#/components/schemas/blockId'
        eventName:
          description: Name of event.
          type: string
          minLength: 0
          maxLength: 60
        eventType:
          description: Type of event.
          type: string
          minLength: 0
          maxLength: 20
        eventDate:
          description: Date of the event
          type: string
          format: date
          maxLength: 8
        room:
          description: The function space room where the event takes place .
          $ref: '#/components/schemas/codeDescriptionType'
        status:
          description: Status of the processed event. e.g Completed, Not Processed.
          type: string
        reason:
          description: Reason for not processing the event.
          type: string
        processingInfoType:
          description: Flag to indicate the warning messages from the API
          type: string
        processingInfoCode:
          description: Erorr/Warning code for not processing th event.
          type: string
          minLength: 0
          maxLength: 200
    blockToShift:
      type: object
      description: Request object to shift business block starting date.
      properties:
        criteria:
          description: Contains details of the block to be shifted along with the new start date to be applied.
          $ref: '#/components/schemas/shiftBlockCriteriaType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    configPostingAttributesType:
      type: object
      description: A config Package posting attributes type.
      properties:
        addToRate:
          description: The package price is added to the room rate.
          type: boolean
        printSeparateLine:
          description: The package price is printed on separate line of the folio.
          type: boolean
        sellSeparate:
          description: Can the package be sold separate from rate plan code?
          type: boolean
        postNextDay:
          description: package charges will be posted next business day.
          type: boolean
        forecastNextDay:
          description: Package will be forecasted for consumption the next business day.
          type: boolean
        deliveryTimeRequired:
          description: Indicates whether a delivery time is required for the package.
          type: boolean
        webBookable:
          description: Can package be sold via Web channel.
          type: boolean
        formula:
          description: The custom formula used for this package, if any.
          type: string
          minLength: 0
          maxLength: 2000
        formulaFunctionName:
          description: The custom formula function name used for this package, if any.
          type: string
          minLength: 0
          maxLength: 2000
        formulaFunctionArguments:
          description: The function argument name-value combination accepted by the custom formula used for this package.
          $ref: '#/components/schemas/functionArgumentsType'
        startTime:
          description: Start time the package is valid.
          type: string
        endTime:
          description: End time the package is valid.
          type: string
        catering:
          description: Is package used for catering?
          type: boolean
        postingRhythm:
          description: The posting rhythm for this package.
          $ref: '#/components/schemas/packagePostingRhythmType'
        priceCalculationRule:
          description: The price calculation rule for this package.
          $ref: '#/components/schemas/packageCalculationRuleType'
        ticket:
          description: Indicates whether a package is configured as a ticket or not.
          type: boolean
        inventoryItems:
          description: Package Code Inventory Items type.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/pkgInventoryItemType'
        calculatedPrice:
          description: Calculated Package Price based from Number of Adults, Children and Calculation Rule.
          type: number
    allocationRanges:
      type: object
      description: Request for setting block allocation for ranges of dates for a list of room types.
      properties:
        allocationRanges:
          description: Collection of Range information for the block allocation ranges operation.
          $ref: '#/components/schemas/blockAllocationRanges'
        genericRoomType:
          description: Indicates if the Allocation objects refer to Generic Room Types (Room Pools).
          type: boolean
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    blockType:
      type: object
      properties:
        blockIdList:
          description: Collection of unique block identifiers.
          $ref: '#/components/schemas/blockIdList'
        externalReferences:
          description: External Reference information for Reservation.
          $ref: '#/components/schemas/externalReferencesType'
        blockDetails:
          description: Detailed Block information for this block.
          $ref: '#/components/schemas/blockDetailsType'
        blockOwners:
          description: Criteria to assign the owners of a business block.
          $ref: '#/components/schemas/blockOwnersType'
        masterBlockInfo:
          description: Basic information of master and sub blocks structure in tree manner, this element only used while retrieving Block Type.
          $ref: '#/components/schemas/masterBlockInfoType'
        reservationPolicies:
          description: A list of reservation policies.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/reservationPoliciesType'
        reservationDetails:
          description: Details of room Information for the Block.
          $ref: '#/components/schemas/blockReservationDetailsType'
        catering:
          description: Details of catering Information for the Block.
          $ref: '#/components/schemas/cateringType'
        blockProfiles:
          description: A collection of all the profiles associated to this block. Please note that during a change operation this performs a full overlay if the attribute FullOverlay is set to true. In a full overlay, all the profiles that should be associated to the block should be provided during a change operation. Any profiles not provided will be detached from this block. By default the full overlay is considered false if this tag is left blank. If values are provided for profiles, only the full overlay functionality is provided at this time.
          type: object
          properties:
            blockProfile:
              description: The list of profiles associated with the block.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/blockProfilesType'
            fullOverlay:
              description: Indicates whether to perform a full overlay for the profiles. Currently only the Fulloverlay functionality is provided.
              type: boolean
        blockPackages:
          description: A Block Package represents a non-room product provided to guests. Block Pacakges may have associated inventory and charges.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/blockPackageType'
        inventoryItems:
          description: A collection of inventory items attached to a block.
          $ref: '#/components/schemas/blockInventoryItemsType'
        blockStatistics:
          description: Indicates the room and revenue statistics of the block.
          $ref: '#/components/schemas/blockStatisticsType'
        comments:
          description: List of notes for the Block.
          type: object
          properties:
            commentInfo:
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/commentInfoType'
            hasMore:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalResults:
              description: Total number of rows queried
              type: integer
            count:
              description: Total number of rows returned
              type: integer
        roomAllocations:
          description: Room Allocations for the Block.
          type: object
          properties:
            roomAllocationType:
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/roomAllocationTypeType'
            masterInfo:
              description: Room Allocations Master Information contains all the room types in the property.
              $ref: '#/components/schemas/roomAllocationMasterInfoType'
            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
            startDate:
              type: string
              format: date
              maxLength: 8
            numberOfDays:
              type: number
        userDefinedFields:
          description: Collections of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
        blockIndicators:
          description: Indicators of additional information attached to the block
          $ref: '#/components/schemas/indicatorsType'
        traces:
          description: List of block traces.
          $ref: '#/components/schemas/blockTracesType'
        statistics:
          description: Statistics summary information including Rooms Sold, Room Revenue, Food and Beverage Revenue, Average Room Rate,etc.
          type: array
          maxItems: 3
          items:
            $ref: '#/components/schemas/blockStatisticsSummaryType'
        blockSecurity:
          description: Block security information used for an external system. Only available if configured in OPERA Cloud.
          type: object
          properties:
            securedFromDIdisplayYn:
              description: Secured from DI Display.
              type: boolean
            allDescriptionDDSecured:
              description: All Description DD Secured.
              type: boolean
            ratesSecuredfromGNR:
              description: Rates Secured from GNR.
              type: boolean
            ratesSecuredfromAllDisplays:
              description: Rates Secured from All Displays.
              type: boolean
            housingInformationSecured:
              description: Housing Information Secured.
              type: boolean
            daysDepositRequired:
              description: Number of Days Deposit due to guarantee the guest booking.
              type: number
            advanceCancelDays:
              description: Number of days before the arrival date a reservation can be canceled without losing the deposit.
              type: number
            returnOneDayAtTimeYn:
              description: Return One Day at a time.
              type: boolean
            commissionableYn:
              description: Determines if Travel Agent commission will be paid on reservations booked through the HOLIDEX Plus TACP program.
              type: boolean
        ratePrograms:
          description: Rate Program contains rate information required for block creation, like room pool, rate amount, market code, etc. Only available if configured in OPERA Cloud.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/rateProgramType'
        externalAttributes:
          description: Block attributes used for external systems. Only available if configured in OPERA Cloud.
          type: object
          properties:
            housingProtected:
              description: Only available if configured in OPERA Cloud.
              type: boolean
            eventType:
              description: Contract type of a block, which is used for external system. Only available if configured in OPERA Cloud.
              $ref: '#/components/schemas/eventTypeType'
            gIId:
              description: Group IATA number validated by an external system and block can't be saved unless confirmed that GIID is valid. Only available if configured in OPERA Cloud.
              type: string
            rollEndDate:
              description: When this flag is set it will be used to roll Block End Date and Block Rate Program End Date in the night audit process. Only available if configured in OPERA Cloud.
              type: boolean
        genericRoomAllocations:
          description: Generic Room Type Allocations for the Block.
          type: object
          properties:
            roomAllocationType:
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/roomAllocationTypeType'
            masterInfo:
              description: Generic Room Allocations Master Information contains all the room types in the property.
              $ref: '#/components/schemas/roomAllocationMasterInfoType'
            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
            startDate:
              type: string
              format: date
              maxLength: 8
            numberOfDays:
              type: number
        alternateDates:
          description: Alternate Date information for the Block.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/blockAlternateDateType'
        sellMessages:
          description: List of sell messages for the Block.
          $ref: '#/components/schemas/sellMessageConfigsType'
        attachments:
          description: List of attachments for the Block.
          $ref: '#/components/schemas/attachmentsType'
        washSchedules:
          description: List of wash schedules for the Block.
          $ref: '#/components/schemas/blockWashSchedulesType'
        restrictions:
          description: List of restrictions for the Block.
          $ref: '#/components/schemas/blockRestrictionsType'
        accessExclusions:
          description: List of access exclusions for the block.
          $ref: '#/components/schemas/blockAccessExclusionsType'
        centralSalesLeads:
          description: Basic information about the Central Sales Lead and its Property Leads.
          $ref: '#/components/schemas/centralSalesLeadsType'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        markAsRecentlyAccessed:
          description: Mark this block as recently accessed.
          type: boolean
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
    traceResolveType:
      type: object
      properties:
        resolvedOn:
          description: Date the trace was resolved
          type: string
          format: date
          maxLength: 8
        resolvedBy:
          description: User that resolved the trace
          type: string
    packagePostingRhythmType:
      type: object
      description: Package Posting rhythm type.
      properties:
        everyXNightsStartingNightY:
          description: Post the package every X nights Staring from Night Y.
          type: object
          properties:
            startOnNightY:
              description: Starting night for consumption and posting prices.
              type: integer
            postEveryXNights:
              description: Occurance of nights when the package needs to be posted and consumed.
              type: integer
        certainNightsOfTheWeek:
          description: Post the package on certain nights of the week.
          type: object
          properties:
            sunday:
              type: boolean
            monday:
              type: boolean
            tuesday:
              type: boolean
            wednesday:
              type: boolean
            thursday:
              type: boolean
            friday:
              type: boolean
            saturday:
              type: boolean
        customStaySchedule:
          description: This user defined schedule lets you enter a posting rhythm over a 14-day period, starting with the arrival date, by assigning the day (number) within a guest stay for posting this package price.
          type: object
          properties:
            night1:
              description: Night 1 indicator.
              type: boolean
            night2:
              description: Night 2 indicator.
              type: boolean
            night3:
              description: Night 3 indicator.
              type: boolean
            night4:
              description: Night 4 indicator.
              type: boolean
            night5:
              description: Night 5 indicator.
              type: boolean
            night6:
              description: Night 6 indicator.
              type: boolean
            night7:
              description: Night 7 indicator.
              type: boolean
            night8:
              description: Night 8 indicator.
              type: boolean
            night9:
              description: Night 9 indicator.
              type: boolean
            night10:
              description: Night 10 indicator.
              type: boolean
            night11:
              description: Night 11 indicator.
              type: boolean
            night12:
              description: Night 12 indicator.
              type: boolean
            night13:
              description: Night 13 indicator.
              type: boolean
            night14:
              description: Night 14 indicator.
              type: boolean
        customNightSchedule:
          description: 'The start and end of the posting period is determined as follows: If the package is attached to a rate code: The period starts with the date when the rate code to which the package is attached becomes effective for the stay. The period ends with the date of the last night for that rate code (or the last night of the stay if the rate code remains in effect until the departure date). If the package is attached separately to the reservation: The Begin Date specified on the reservation when the package was attached is the start date for the period. The End Date specified on the reservation when the package was attached is the end date for the period. If no Begin Date and/or End Date are specified when the package is attached to the reservation, the Begin Date is assumed to be the arrival date and the End Date is assumed to be the departure date of the reservation, irrespective of when the package is attached to the reservation.'
          type: object
          properties:
            night1:
              description: Night 1 indicator.
              type: boolean
            night2:
              description: Night 2 indicator.
              type: boolean
            night3:
              description: Night 3 indicator.
              type: boolean
            night4:
              description: Night 4 indicator.
              type: boolean
            night5:
              description: Night 5 indicator.
              type: boolean
            night6:
              description: Night 6 indicator.
              type: boolean
            night7:
              description: Night 7 indicator.
              type: boolean
            night8:
              description: Night 8 indicator.
              type: boolean
            night9:
              description: Night 9 indicator.
              type: boolean
            night10:
              description: Night 10 indicator.
              type: boolean
            night11:
              description: Night 11 indicator.
              type: boolean
            night12:
              description: Night 12 indicator.
              type: boolean
            night13:
              description: Night 13 indicator.
              type: boolean
            night14:
              description: Night 14 indicator.
              type: boolean
        type:
          description: Posting Rhythm for the package.
          $ref: '#/components/schemas/postingRhythmType'
    subBlockIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    commentType:
      type: object
      description: An indication of a new paragraph for a sub-section of a formatted text message.
      properties:
        text:
          description: Formatted text content.
          $ref: '#/components/schemas/formattedTextTextType'
        image:
          description: An image for this paragraph.
          type: string
        url:
          description: A URL for this paragraph.
          type: string
        commentTitle:
          description: Specifies Comment's Title.
          type: string
          minLength: 0
          maxLength: 4000
        notificationLocation:
          description: Notification Location associated with the Note.
          type: string
          minLength: 0
          maxLength: 20
        type:
          description: Specifies type of the comment.
          type: string
          minLength: 0
          maxLength: 20
        typeDescription:
          description: Comment type Description.
          type: string
          minLength: 0
          maxLength: 200
        internal:
          description: When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.
          type: boolean
        confidential:
          description: When true, the comment may be confidential.
          type: boolean
        overrideInternal:
          description: When true, the note internal could be modified.
          type: boolean
        protectDescription:
          description: When true, the note title will be populated from the note type description and couldn't be modified.
          type: boolean
        hotelId:
          description: If specified comment belongs to the Hotel, otherwise it is a global comment.
          type: string
          minLength: 0
          maxLength: 20
        actionType:
          description: Specifies type of action described in the comments.
          type: string
          minLength: 0
          maxLength: 20
        actionDate:
          description: Indicates at which date an action described in the comment must be taken.
          type: string
          format: date
          maxLength: 8
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
    blockRatePlanInfoType:
      type: object
      description: Rate Plan info type extension for block.
      properties:
        shortInfo:
          description: Brief Information of the Rate Code.
          type: string
          minLength: 0
          maxLength: 2000
        longInfo:
          description: Detail Information of the Rate Code.
          type: string
          minLength: 0
          maxLength: 2000
        webPage:
          description: URL providing more information about the Rate Code.
          type: string
          minLength: 0
          maxLength: 2000
        description:
          description: Description of the Rate Code.
          type: string
          minLength: 0
          maxLength: 2000
        currencyCode:
          description: Currency Code of the rate code.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanLevel:
          description: All rate codes are associated with rate plan level ( or rate category )for Channels. So if rate plans are given in the request, get all rate codes associated with the rate plan level.
          type: string
          minLength: 0
          maxLength: 20
        guarantee:
          description: Guarantee details for rate plan code.
          $ref: '#/components/schemas/guaranteeType'
        cancelPenalty:
          description: Cancellation details for rate plan code.
          $ref: '#/components/schemas/cancelPenaltyType'
        mealPlans:
          description: Meal plan codes for rate plan code.
          $ref: '#/components/schemas/mealPlansType'
        ratePlanCode:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCategory:
          type: string
          minLength: 0
          maxLength: 20
        taxInclusive:
          description: Indicates if tax is included in the rate code amount.
          type: boolean
        serviceFeeInclusive:
          description: Indicates if service fee is included in the rate code amount.
          type: boolean
        primary:
          description: Is it a primary rate plan?
          type: boolean
        showRateAmount:
          description: Is the rate amount to be shown?
          type: boolean
        marketCode:
          description: Market Code associated with the RatePlanCode.
          type: string
          minLength: 0
          maxLength: 20
        sourceCode:
          description: Source Code associated with the RatePlanCode.
          type: string
          minLength: 0
          maxLength: 20
        negotiated:
          description: Indicates if the rate code is a negotiated rate code
          type: boolean
    resourceDiscountTypeType:
      type: string
      description: Indicates the option to select resources that will be discounted with the Resource Discount Percentage.
      enum:
      - AllDiscountableResources
      - ResourcesWithSameDiscountPercentage
      - AllDiscountableItems
      - ItemsWithSameDiscountPercentage
      - AllDiscountableMenusAndMenuItems
      - MenusAndMenuItemsWithSameDiscountPercentage
      - AllDiscountableSpaces
      - SpacesWithSameDiscountPercentage
      - ResourcesAndCateringPackageWithSameDiscountPercentage
      - AllCateringPackages
      - AllCateringPackagesWithSameDiscountPercentage
      - AllDiscountableResourcesAndCateringPackage
      - None
    functionArgumentType:
      type: object
      description: This type provided details of a function argument and the value it holds.
      properties:
        name:
          description: Specifies the name of the function argument.
          type: string
          minLength: 0
          maxLength: 200
        value:
          description: Specifies the value held by the function argument.
          type: string
          minLength: 0
          maxLength: 200
        position:
          description: Specifies the position of the function argument in the argument list.
          type: integer
        dataType:
          description: Specifies the datatype of the function argument.
          type: string
          minLength: 0
          maxLength: 40
        required:
          description: Argument of the function mandatory or not.
          type: boolean
    translationTextType80:
      type: object
      description: Contains Multiple translated texts and language codes.
      properties:
        defaultText:
          description: Default text with Character length from 0 to 80.
          type: string
          minLength: 0
          maxLength: 80
        translatedTexts:
          description: List of translated text and language codes.
          $ref: '#/components/schemas/translationsTextType'
    hotelUseType:
      type: object
      properties:
        hotelUseReason:
          description: Explains the reason why the business block can be updated only by the Hotel.
          type: string
          minLength: 0
          maxLength: 4000
        accessRestrictions:
          description: List of block access exclusion/restriction types. The field HotelUseOnly and Modify under this will behave the same. User can pass either of them. For new development use this field.
          $ref: '#/components/schemas/accessRestrictionsType'
        hotelUseOnly:
          description: Indicates whether this business block can be updated only by the Hotel to which it belongs. This is used to communicate to CRO that the business block can be only updated by the Hotel.
          type: boolean
    packageTransactionCodeType:
      type: object
      properties:
        description:
          description: The description of the code.
          type: string
          minLength: 0
          maxLength: 200
        code:
          description: Posting / transaction code.
          type: string
          minLength: 0
          maxLength: 20
        type:
          description: Code is inclusive or exclusive of other charges such as taxes.
          $ref: '#/components/schemas/amountDeterminationType'
    resDepositPoliciesType:
      type: array
      description: A list of deposit policies attached with the reservation.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resDepositPolicyType'
    accessRestrictionsType:
      type: array
      description: Block access exclusion/restriction type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockAccessRestrictionType'
    packageConsumptionType:
      type: object
      description: Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
      properties:
        defaultQuantity:
          description: The default quantity attached in the package.
          type: integer
        excludedQuantity:
          description: The quantity which has been excluded in the package.
          type: integer
        totalQuantity:
          description: The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType.
          type: integer
        allowanceConsumed:
          description: Indicates if Allowance(for POS packages) has been consumed/posted for today.
          type: boolean
    resDepositPolicyType:
      type: object
      description: A deposit policy attached with the reservation.
      properties:
        revenueType:
          description: Type of reservation.
          $ref: '#/components/schemas/depositCancelRevenueType'
        policy:
          description: Reservation deposit policy details.
          $ref: '#/components/schemas/depositPolicyType'
        comments:
          description: Comments attached with a deposit.
          type: string
          minLength: 0
          maxLength: 2000
        amountPaid:
          description: Total amount paid against the reservation deposit.
          $ref: '#/components/schemas/currencyAmountType'
        amountDue:
          description: Total amount due against the reservation deposit.
          $ref: '#/components/schemas/currencyAmountType'
        policyId:
          description: Unique ID of the Reservation Policy.
          $ref: '#/components/schemas/uniqueID_Type'
    restrictionStatusesType:
      type: string
      enum:
      - Closed
      - ClosedForArrival
      - ClosedForDeparture
      - MinimumStayThrough
      - MaximumStayThrough
      - MinimumLengthOfStay
      - MaximumLengthOfStay
      - LOSNotAvailable
      - MinimumAdvanceBooking
      - MaximumAdvanceBooking
      - Open
      - OpenForArrival
      - OpenForDeparture
    blockId:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    rateProgramRateType:
      type: object
      description: Room Pool Rate Program.
      properties:
        rateCode:
          description: Rate Program Code.
          type: string
          minLength: 0
          maxLength: 20
        rateMarketCode:
          description: RateMarketCode is a rate attribute required for external system in order to create a rate program. Only available if configured in OPERA Cloud.
          $ref: '#/components/schemas/codeDescriptionType'
        rateAmounts:
          description: Rate Program Amounts.
          $ref: '#/components/schemas/blockGridRatesType'
        roomTypes:
          description: Rate Program Room Types.
          $ref: '#/components/schemas/rateProgramRoomType'
        startDate:
          description: Start date of the Room Pool Rate Program.
          type: string
          format: date
          maxLength: 8
        endDate:
          description: End date of the Room Pool Rate Program.
          type: string
          format: date
          maxLength: 8
        commissionable:
          description: Rate Program Commissionable Indicator.
          type: boolean
        mobileCheckout:
          description: Rate Program Mobile Checkout Allowed Indicator.
          type: boolean
        primary:
          description: Rate Program Primary Rate Code Indicator.
          type: boolean
        sequence:
          description: Sequence Number of the Rate Program.
          type: integer
    dateTimeSpanType:
      type: object
      description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.
      properties:
        startDateTime:
          type: string
          format: date-time
        endDateTime:
          type: string
          format: date-time
    eventOrderType:
      type: object
      description: Event order distribution information.
      properties:
        distributed:
          description: Indicates if the Banquet Event Orders have been distributed.
          type: boolean
        distributedDate:
          description: This indicates which exchange rate date will be used for blocks when printing Banquet Event Orders. When the Distributed attribute is true this contains the date stamp of when the Distributed attribute was updated. When Distributed attribute is false, this is left blank. This date can also be taken into consideration as the 'Exchange Rate Date' when, for instance, converting catering revenue to base currency.
          type: string
          format: date
          maxLength: 8
        distributedDateTime:
          description: This indicates which exchange rate date will be used for blocks when printing Banquet Event Orders. When the Distributed attribute is true this contains the date/time stamp of when the Distributed attribute was updated. When Distributed attribute is false, this is left blank. This date can also be taken into consideration as the 'Exchange Rate Date' when, for instance, converting catering revenue to base currency.
          type: string
          format: date-time
    itemInfoType:
      type: object
      description: Basic information regarding an Item.
      properties:
        description:
          description: Detail description of an item.
          type: string
          minLength: 0
          maxLength: 2000
        availabilityPeriod:
          description: Defines a Time period when the item is available.
          $ref: '#/components/schemas/timeWindowType'
        timeSpan:
          description: Date Range to get the inventories of the items.
          $ref: '#/components/schemas/timeSpanType'
        quantity:
          description: Quantity of hold Item
          type: integer
        itemHoldId:
          description: ID reference for the hold Item
          type: number
        code:
          description: Item Code.
          type: string
          minLength: 0
          maxLength: 20
        name:
          description: Name of an item.
          type: string
          minLength: 0
          maxLength: 200
        itemPool:
          description: Indicates if it is an item pool. Not applicable for Item within the Item Pool.
          type: boolean
        sellSeparate:
          description: If true indicates that item is allowed to sell separately.
          type: boolean
        sellInReservation:
          description: If true indicates that item can be sold in reservation.
          type: boolean
        sellInEvent:
          description: If true indicates that item can be sold in event.
          type: boolean
        requiredForBooking:
          description: If true indicates that item is required for the reservation.
          type: boolean
        fixedCharge:
          description: If true indicates that item has fixed charge when it is attached to a reservation.
          type: boolean
        outsideStay:
          description: If true indicates that item could be held outside of the reservation stay days.
          type: boolean
        defaultDuration:
          description: Define the default duration in days when booking the item.
          type: integer
    blockIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    blockOwnersType:
      type: object
      description: Contains a list of block owners.
      properties:
        owner:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/blockOwnerType'
        lockBlockOwners:
          description: When this flag is true, the logged in user cannot modify the existing block owners for the current block.
          type: boolean
        lockRoomsOwners:
          description: When this flag is true, the logged in user cannot modify the existing room owners for the current block.
          type: boolean
        lockCateringOwners:
          description: When this flag is true, the logged in user cannot modify the existing catering owners for the current block.
          type: boolean
    guaranteeRequirementsType:
      type: object
      description: Specifies various requirement for the guarantee code.
      properties:
        requirementCode:
          description: Requirement Code.
          type: string
        cancellation:
          description: When true indicates cancellation on the reservation is required for this guarantee code.
          type: boolean
        phoneNumber:
          description: When true indicates phone number on the reservation is required for this guarantee code.
          type: boolean
        address:
          description: When true indicates address on the reservation is required for this guarantee code.
          type: boolean
        creditCard:
          description: When true indicates Credit Card on the reservation is required for this guarantee code.
          type: boolean
        arrivalTime:
          description: When true indicates arrival Time on the reservation is required for this guarantee code.
          type: boolean
        deposit:
          description: When true indicates deposit is required for this guarantee code.
          type: boolean
    depositPolicyType:
      type: object
      description: Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
      properties:
        amountPercent:
          description: Payment expressed as a fixed amount, or a percentage of/or room nights.
          $ref: '#/components/schemas/policyAmountPercentType'
        deadline:
          description: Payment deadline, absolute or relative.
          $ref: '#/components/schemas/policyDeadlineType'
        description:
          description: Text description of the Payment in a given language.
          type: string
          minLength: 0
          maxLength: 2000
        depositReceiptNo:
          description: Receipt number associated with the deposit policy
          type: integer
        transactionDate:
          description: Transaction Date associated with the deposit policy
          type: string
          format: date
          maxLength: 8
        depositReqReversed:
          description: Flag to indicate if deposit policy is reversed
          type: boolean
        formattedRule:
          description: Formatted Text Rule of the deposit policy.
          type: string
          minLength: 0
          maxLength: 2000
        typeOfCharges:
          description: Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both
          $ref: '#/components/schemas/depositCancelRevenueType'
        policyCode:
          description: Deposit Policy Code
          type: string
          minLength: 0
          maxLength: 20
        manual:
          description: Flag to indicate if the deposit policy is manual.
          type: boolean
        effective:
          description: Indicator if deposit policy is currently applicable or not.
          type: boolean
        estimatedAmount:
          description: Estimated Amount for the deposit policy.
          type: number
    reservationPoliciesType:
      type: object
      description: A collection of reservation deposit and cancellation policies.
      properties:
        cancellationPolicies:
          description: A collection of reservation cancellation policies..
          $ref: '#/components/schemas/resCancellationPoliciesType'
        depositPolicies:
          description: A collection of reservation deposit policies.
          $ref: '#/components/schemas/resDepositPoliciesType'
        reservationIdList:
          description: A list of Ids for reservation.
          $ref: '#/components/schemas/uniqueIDListType'
        name:
          description: Name identifier for the reservation.
          type: string
    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
    attachmentType:
      type: object
      description: Attached files.
      properties:
        fileName:
          description: Name of the file.
          type: string
          minLength: 0
          maxLength: 2000
        fileSize:
          description: Size of the file.
          type: integer
        description:
          description: Description for the file.
          type: string
          minLength: 0
          maxLength: 4000
        global:
          description: Flag to say if attachment is available across properties.
          type: boolean
        hotelId:
          description: Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        history:
          description: History data associated with Attachment.
          $ref: '#/components/schemas/dateTimeStampGroupType'
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
    productSourceType:
      type: string
      description: Sources of Products
      enum:
      - Reservation
      - RateHeader
      - RateDetail
    blockSourceOfSaleType:
      type: object
      description: Point of Sale of Block. Identifies the entity/channel who made the block reservation.
      properties:
        sourceCode:
          description: Identifies how this block came into the property.
          $ref: '#/components/schemas/sourceCodeInfoType'
        sourceType:
          description: The of entity/channel where this business block originated.
          type: string
          minLength: 0
          maxLength: 20
        sourceTypeDescription:
          description: The of entity/channel where this business block originated.
          type: string
          minLength: 0
          maxLength: 2000
    roomFeaturesType:
      type: array
      description: A recurring element that identifies the room features.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/roomFeatureType'
    usedInModuleType:
      type: string
      description: Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control.
      enum:
      - Blocks
      - Reservations
      - FunctionDiary
      - LookToBookSales
      - GroupRoomsControl
    blockTraceType:
      type: object
      description: Extended Trace object to hold information for a block.
      properties:
        timeInfo:
          description: Date of the trace.
          $ref: '#/components/schemas/traceTimeInfoType'
        reservationId:
          description: Reservation ID of the reservation for which the traces are to be retrieved.
          $ref: '#/components/schemas/reservationId'
        departmentId:
          description: Indicates the Department code.
          type: string
          minLength: 0
          maxLength: 20
        traceText:
          description: The information this trace contains.
          type: string
        resolveInfo:
          description: Information regarding the status of the trace
          $ref: '#/components/schemas/traceResolveType'
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
    configPackageTransactionType:
      type: object
      description: A HotelPackageTransaction type.
      properties:
        allowance:
          description: Package is marked as an allowance, in case charge is expected back to the guest account from external interface eg. POS. which need to be offset against a consumption allowance.
          type: boolean
        currency:
          description: The currency code for this package.
          type: string
          minLength: 0
          maxLength: 20
        postingType:
          description: The posting frequency for this package, e.g., daily, arrival, departure, etc.
          type: string
          minLength: 0
          maxLength: 20
        calculationRule:
          description: The price calculation rule for this package.
          type: string
          minLength: 0
          maxLength: 80
        packagePostingRules:
          description: The package posting rule details.
          $ref: '#/components/schemas/packagePostingRulesType'
    roomAllocationDetailsType:
      type: object
      properties:
        originalRooms:
          description: The total original( forecasted ) rooms for the block.
          type: integer
        roomType:
          description: The room type for which the allocation details are listed.
          type: string
          minLength: 0
          maxLength: 20
        currentRooms:
          description: The total current( projected + pickup ) rooms for the block.
          type: integer
        pickupRooms:
          description: The total pickup rooms for the block.
          type: integer
        inventory:
          description: The break up of projected rooms by occupancy.
          $ref: '#/components/schemas/blockGridInvType'
        rates:
          description: The break up of occupancy rates.
          $ref: '#/components/schemas/blockGridRatesType'
        netRates:
          description: Net occupancy rates.
          $ref: '#/components/schemas/blockGridRatesType'
        actualRevenue:
          description: The break up of actual revenue for room type. Applicable for past dates, business date or future dates.
          $ref: '#/components/schemas/blockActualRevenueType'
        potentialRevenue:
          description: The break up of potential revenue for room type. Applicable for business date or future dates.
          $ref: '#/components/schemas/blockPotenitalRevenueType'
    roomAllocationInfoType:
      type: object
      description: A collection of Allocation objects for a block that indicate room inventory or rate amounts.
      properties:
        roomGridDetails:
          description: Indicates the values of room inventory or rate amounts.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/roomGridDetailsType'
        roomGridInvSummary:
          description: Indicates the values of room inventory's summary.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/blockGridInvType'
        availableRoomGridInvSummary:
          description: Indicates the values of room available room grid inventory's summary.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/blockGridInvType'
        stayDate:
          description: Indicates the date of the room allocation or rate amount.
          type: string
          format: date
          maxLength: 8
        extendedStay:
          description: Indicates if the current date will require automatic block extension.
          type: boolean
    postingRhythmType:
      type: string
      description: Simple type for posting Rhythm types.
      enum:
      - EveryNight
      - ArrivalNight
      - EveryXNightsStartingNightY
      - CertainNightsOfTheWeek
      - LastNight
      - EveryNightExceptArrivalNight
      - EveryNightExceptLast
      - EveryNightExceptFirstAndLast
      - CustomStaySchedule
      - CustomNightSchedule
      - FloatingAllowancePerStay
      - TicketPosting
    shiftBlockCriteriaType:
      type: object
      properties:
        newStartDate:
          description: New start date of the business block.
          type: string
          format: date
          maxLength: 8
        removeAlternateDates:
          description: When true, this will remove alternate dates for this block before shifting dates.
          type: boolean
        validateAlternateDates:
          description: When true, this will validate alternate dates for this block before shifting dates.
          type: boolean
        overbookAll:
          description: When true, this will overbook allocated rooms if needed.
          type: boolean
        validatePreAllocatedRooms:
          description: When true, this will validate if there are rooms pre-allocated before shifting the block dates.
          type: boolean
        validateTraces:
          description: When true, this will validate if there are active traces before shifting the block dates.
          type: boolean
        overrideEventsProcessingWarnings:
          description: Indicates whether to ignore any warning during applying the changes to the events associated with the current block.
          type: boolean
    sourceCodeInfoType:
      type: object
      properties:
        sourceCode:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        sourceGroup:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
    cateringNextStatusListType:
      type: array
      description: Next catering status of the business block.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/bookingStatusDetailType'
    policyAmountPercentType:
      type: object
      description: Defines the percentage basis for calculating the fee amount or the amount.
      properties:
        basisType:
          description: Provides the basis for how the amount of the guarantee is calculated.
          $ref: '#/components/schemas/policyBasisTypeType'
        nights:
          description: The number of nights of the hotel stay that are used to calculate the fee amount.
          type: integer
        percent:
          description: The percentage used to calculate the amount.
          type: number
          minimum: 0
          maximum: 100
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    blockPackageType:
      type: object
      description: This contains the full information and schedule of the block package.
      properties:
        packageHeaderType:
          description: Package information from configuration.
          $ref: '#/components/schemas/packageCodeHeaderType'
        newTimeSpan:
          description: The changed dates(Start and End dates) for this product.
          $ref: '#/components/schemas/timeSpanType'
        consumptionDetails:
          description: Package consumption details. Includes information for quantity , allowance etc.
          $ref: '#/components/schemas/packageConsumptionType'
        packageCode:
          description: Package code. This is the unique code used for the package and is a required element.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record.
          type: string
          minLength: 0
          maxLength: 20
        startDate:
          description: Required value when changing a package. If the original start date was null, then null is required.
          type: string
          format: date
          maxLength: 8
        endDate:
          description: Required value when changing a package. If the original end date was null, then null is required.
          type: string
          format: date
          maxLength: 8
        packageGroup:
          description: Package group code. If this package is part of a package group, the group code is indicated here. This is a required element and is part of the key to fetch the correct package record .
          type: string
          minLength: 0
          maxLength: 20
    cateringEventsProcessedInfoList:
      type: array
      description: Status/Info of the processed events.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/cateringEventsProcessedInfoType'
    emailInfoType:
      type: object
      description: Information on an email for the customer.
      properties:
        email:
          description: eMail deatils for the profile.
          $ref: '#/components/schemas/emailType'
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        warnings:
          $ref: '#/components/schemas/warningsType'
    bookingStatusDetailType:
      type: object
      description: Booking Status details of the business block.
      properties:
        bookingStatus:
          description: Booking Status of the business block.
          $ref: '#/components/schemas/bookingStatusType'
        parentBookingStatus:
          description: Parent status of the booking status, if one exists.
          type: string
          minLength: 0
          maxLength: 20
        deductInventory:
          description: Indicates if blocked rooms are deducted from inventory.
          type: boolean
        catDeductInventory:
          description: Indicates if catering event's spaces are deducted from inventory
          type: boolean
        allowPickup:
          description: Indicates if business blocks with this status will be allowed for pickup or not.
          type: boolean
        returnToInventory:
          description: Indicates if blocked rooms will be returned to availability or not.
          type: boolean
        defaultReservationType:
          description: Default reservation type for the booking status.
          type: string
          minLength: 0
          maxLength: 20
        cancellationType:
          description: Cancellation reason type of the booking status. Populates only when the booking status is of return to inventory type.
          $ref: '#/components/schemas/blockCancellationTypeType'
        statusType:
          description: Indicates status type Inquiry, Actual, Cancel, etc.
          $ref: '#/components/schemas/blockStatusTypeType'
        catStatusType:
          description: Indicates status type Inquiry, Actual, Cancel, etc.
          $ref: '#/components/schemas/blockStatusTypeType'
    blockWashSchedulesType:
      type: array
      description: Wash Schedule attached to the block, which allows to release inventory based on selected wash schedule type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockWashScheduleType'
    allocationGridByRoomTypeType:
      type: object
      description: A collection of Allocation objects for a block defined by room type.
      properties:
        allocationGridDates:
          description: Allocation objects for a block by date ranges.
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/allocationGridByDateRangesType'
        sellLimitGridDates:
          description: Sell limits for a block by date ranges.
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/sellLimitGridByDateRangeType'
        roomType:
          description: Indicates the room type of the Allocation objects.
          type: string
          minLength: 0
          maxLength: 20
    warningType:
      type: object
      description: Used when a message has been successfully processed to report any warnings or business errors that occurred.
      properties:
        value:
          type: string
          description: Property Value
        shortText:
          description: An abbreviated version of the error in textual format.
          type: string
          maxLength: 2000
        code:
          description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.
          type: string
          minLength: 0
          maxLength: 20
        docURL:
          description: If present, this URL refers to an online description of the error that occurred.
          type: string
          maxLength: 2000
        status:
          description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
          type: string
          maxLength: 2000
        tag:
          description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
          type: string
          maxLength: 2000
        recordId:
          description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.
          type: string
          maxLength: 2000
        type:
          description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".
          type: string
          minLength: 0
          maxLength: 20
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        rph:
          description: Reference Place Holder used as an index for this warning.
          type: string
          minLength: 1
          maxLength: 8
    exceptionDetailType:
      title: Error Detail
      description: Complex type that contains error details for a REST call.
      type: object
      properties:
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).
        title:
          type: string
          description: Short, human-readable summary of the problem.  The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
        detail:
          type: string
          description: Human-readable description specific to this occurrence of the problem.
        instance:
          type: string
          description: Absolute URI that identifies the specific occurrence of the problem.  It may or may not provide additional information if dereferenced.
        o:errorCode:
          type: string
          description: Application error code, which is different from HTTP error code.
        o:errorPath:
          type: string
          description: Path to the problem at the resource or property level.
        o:errorDetails:
          description: Details of the error message, consisting of a hierarchical tree structure.
          type: array
          items:
            $ref: '#/components/schemas/errorInstance'
        links:
          $ref: '#/components/schemas/links'
    numericUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Numeric Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/numericUDFType'
    packageCalculationRuleType:
      type: string
      description: Simple type for package caluculation rules.
      enum:
      - FlatRate
      - PerPerson
      - PerAdult
      - PerChild
      - PerRoom
    offsetUnitType:
      type: string
      description: Indicates deadline offset unit type.
      enum:
      - Year
      - Month
      - Day
      - Hour
    reservationTypeInfoType:
      type: object
      properties:
        reservationType:
          type: string
          minLength: 0
          maxLength: 20
        chainCode:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
    blockPotenitalRevenueType:
      type: object
      description: Indicates the sum of revenue breakup per room type per block per allocation date for the reservations. Applicable for business date or future dates.
      properties:
        roomRevenue:
          description: Indicates room revenue amount.
          type: number
        foodRevenue:
          description: Indicates food revenue amount.
          type: number
        otherRevenue:
          description: Indicates other revenue amount.
          type: number
        nonRevenue:
          description: Indicates non revenue amount.
          type: number
        totalRevenue:
          description: Indicates total revenue amount.
          type: number
        roomRevenueTax:
          description: Indicates room revenue tax amount.
          type: number
        foodRevenueTax:
          description: Indicates food revenue tax amount.
          type: number
        otherRevenueTax:
          description: Indicates other revenue tax amount.
          type: number
        nonRevenueTax:
          description: Indicates non revenue tax amount.
          type: number
        totalRevenueTax:
          description: Indicates total revenue tax amount.
          type: number
        currency:
          description: Currency code to reflect the currency in which an amount may be expressed.
          type: string
    dateUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Date Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/dateUDFType'
    allocationRoomTypeInfoType:
      type: object
      description: The information about the room types contained in the block room allocation.
      properties:
        longDescription:
          description: Detail description of the Room Type.
          type: string
          minLength: 0
          maxLength: 2000
        webName:
          description: Name corresponding to a RoomType.
          type: string
          minLength: 0
          maxLength: 80
        webPage:
          description: URL providing more information about the Room Type.
          type: string
          minLength: 0
          maxLength: 2000
        roomFeatures:
          description: Collection of room features.
          $ref: '#/components/schemas/roomFeaturesType'
        roomTypeAttributes:
          description: Room type attributes.
          $ref: '#/components/schemas/roomTypeAttributesType'
        bookingChannelMappings:
          description: Booking Channels mapping for the Room Type.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/bookingChannelMappingType'
        bedTypeCodes:
          description: Bed type code associated with room.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        roomType:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        roomClass:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
        suite:
          description: Indicates room type is a suite.
          type: boolean
        component:
          description: Indicates room type is a Component Room.
          type: boolean
        invBlockCode:
          description: Block code.
          type: string
          minLength: 0
          maxLength: 40
        roomViewCode:
          description: Represents the room view code like City view, River view, Ocean view etc.
          type: string
          minLength: 0
          maxLength: 40
        promotionCode:
          description: Represents the promotional code.
          type: string
          minLength: 0
          maxLength: 40
        roomQualifierCode:
          description: Represents the room qualifier code like Deluxe,Economy,Suite etc.
          type: string
          minLength: 0
          maxLength: 40
        roomQualifierMatchIndicator:
          description: Represents the match indicator of room qualifier code returned in the response with the requested room qualifier code.
          type: string
          minLength: 0
          maxLength: 20
        available:
          description: Used to specify an availability status for the room type.
          type: boolean
    dateUDFType:
      type: object
      description: Used to hold user defined field of Date Type.
      properties:
        name:
          description: Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: string
          format: date
          maxLength: 8
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    eventTypeType:
      type: string
      description: Contract type.
      enum:
      - Convention
      - Contract
    blockNextStatusListType:
      type: array
      description: Next booking status of the business block.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/bookingStatusDetailType'
    roomTypeAttributesType:
      type: object
      description: Attributes of property room type.
      properties:
        defaultOccupancy:
          description: Default occupancy of property room type.
          type: integer
        maximumOccupancy:
          description: Max occupancy of property room type.
          type: integer
        noOfPhysicalRooms:
          description: Number of physical rooms of property room type.
          type: integer
        minimumOccupancy:
          description: Minimum occupancy of property room type.
          type: integer
        maximumAdults:
          description: Maximum adult occupancy of property room type.
          type: integer
        maximumChildren:
          description: Maximum children occupancy of property room type.
          type: integer
    restrictionStatusType:
      type: object
      description: The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.
      properties:
        code:
          description: Identifies the type of restriction. I.E. Closed, ClosedForArrival, etc.
          $ref: '#/components/schemas/restrictionStatusesType'
        unit:
          description: Defines restriction in conjunction with Restriction Code. Value must be specified for Restriction Codes MinimumStayThrough, MaximumStayThrough, MinimumLengthOfStay, MaximumLengthOfStay, MinimumAdvanceBooking, MaximumAdvanceBooking.
          type: integer
        lOS1:
          description: Indicates Length of Stay 1 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS2:
          description: Indicates Length of Stay 2 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS3:
          description: Indicates Length of Stay 3 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS4:
          description: Indicates Length of Stay 4 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS5:
          description: Indicates Length of Stay 5 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS6:
          description: Indicates Length of Stay 6 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
        lOS7:
          description: Indicates Length of Stay 7 or more is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.
          type: boolean
    imageSetType:
      type: object
      description: Represents on image set record.
      properties:
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        imageSet:
          description: The image set name.
          type: string
          minLength: 0
          maxLength: 800
        sequenceId:
          description: The image set sequence ID.
          type: integer
        imageStyle:
          description: The image set enumerated style.
          $ref: '#/components/schemas/imageStyleType'
        imageType:
          description: The image set type.
          type: string
          minLength: 0
          maxLength: 80
        hotelId:
          description: The image set hotel code.
          type: string
          minLength: 0
          maxLength: 20
        chainCode:
          description: The image set chain code.
          type: string
          minLength: 0
          maxLength: 20
        imageURL:
          description: The image set URL.
          type: string
          minLength: 0
          maxLength: 2000
        description:
          description: The image set description.
          type: string
          minLength: 0
          maxLength: 2000
        imageOrder:
          description: The image set order.
          type: integer
        website:
          description: The image set website.
          type: string
          minLength: 0
          maxLength: 2000
    uniqueIDListType:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    attachmentsType:
      type: array
      description: Attachment List.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/attachmentType'
    paymentTypesType:
      type: array
      description: Payment card code like AX,VI etc.
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    emailType:
      type: object
      description: Information on an email for the customer.
      properties:
        emailAddress:
          description: Defines the e-mail address.
          type: string
          minLength: 0
          maxLength: 2000
        type:
          description: Defines the purpose of the e-mail address (e.g. personal, business, listserve).
          type: string
          minLength: 0
          maxLength: 20
        typeDescription:
          description: Describes the Type code
          type: string
          minLength: 0
          maxLength: 2000
        emailFormat:
          description: Supported Email format.
          type: string
          enum:
          - Html
          - Text
        primaryInd:
          description: When true, indicates a primary information.
          type: boolean
        orderSequence:
          description: Display Order sequence.
          type: number
        createDateTime:
          description: Time stamp of the creation.
          type: string
          format: date-time
        creatorId:
          description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
          type: string
          minLength: 0
          maxLength: 200
        lastModifyDateTime:
          description: Time stamp of last modification.
          type: string
          format: date-time
        lastModifierId:
          description: Identifies the last software system or person to modify a record.
          type: string
          minLength: 0
          maxLength: 200
    blockReservationDetailsType:
      type: object
      description: Contains reservation related information for the block.
      properties:
        ratePlanCode:
          description: Rate Plan for the block.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/blockRatePlanInfoType'
        arrivalTime:
          description: Indicates the approximate check in time for the reservations made for the block.
          type: string
          format: date-time
        departureTime:
          description: Indicates the approximate check out time for the reservations made for the block.
          type: string
          format: date-time
        traceCode:
          description: Trace code for the block.
          $ref: '#/components/schemas/codeDescriptionType'
        breakfast:
          description: Indicates the breakfast information for the block room rates.
          $ref: '#/components/schemas/breakfastType'
        porterage:
          description: Indicates the Porterage information for the block room rates.
          $ref: '#/components/schemas/porterageType'
        taRecordLocator:
          description: Free format field to store information from Wholesaler for the block.
          type: string
          minLength: 0
          maxLength: 50
        cutOffDate:
          description: Cut off date of the block.
          type: string
          format: date
          maxLength: 8
        cutOffDays:
          description: Cut off days of the block.
          type: number
        cutoffScheduleCode:
          description: Cutoff Schedule Code for Business Block
          type: string
          minLength: 0
          maxLength: 20
        updateGridOnCutoffChange:
          description: Determines whether the CutOffDate or CutOffDays has changed for the block header. If CutOffDate or CutOffDays is changed then apply the changed cutoff date/ days as the new cutoff date/ days to all the room types in the Grid.
          type: boolean
        followupDate:
          description: This element informs about the systematic follow up on this business block. A Group Reservations Agent or Reservations Manager can use this date to identify when to followup with the customer.
          type: string
          format: date
          maxLength: 8
        decisionDate:
          description: Contains information about the date by which the group must make a decision on the block.
          type: string
          format: date
          maxLength: 8
        roomingListDueDate:
          description: Due date for the rooming list for the block. This is the date by which the guest list should be provided by the customer.
          type: string
          format: date
          maxLength: 8
        elastic:
          description: Elasticity of the block.
          type: number
        suppressRate:
          description: Are Rate amounts suppressed for the block.
          type: boolean
        printRate:
          description: Determines if the rate amounts are to be printed on the reservations picked up from the block. This becomes the default Print Rate setting for all reservations picked up from the block.
          type: boolean
        rateGuarantee:
          description: If this is true, then when a reservation is picked up for the block, the rate for that reservation is taken from the rate grid belonging to the block. If this is false, the rate amounts on the room grid are updated every time the Refresh Rates process is applied.
          type: boolean
        inventoryControl:
          description: Indicates whether the block is non elastic, elastic or sell limit block.
          $ref: '#/components/schemas/blockInventoryControlType'
        personsPerRoom:
          description: Indicates the expected number of guests per sleeping room when Occupancy Split Per Room Type parameter is N.
          type: number
        activePostingMasterReservations:
          description: Whether any active posting master reservations exist for the business block.
          type: boolean
        postingMastersCancellable:
          description: Indicates if posting master reservations can be cancelled.
          type: boolean
        housing:
          description: Determines whether or not the block can be managed at the CRS level.
          type: boolean
        guaranteeRequired:
          description: Determines whether the CRS guarantee is required or not for the block.
          type: boolean
        controlBlockLocally:
          description: Determines whether or not the block can be managed at the CRS level.
          type: boolean
        transactionCode:
          description: Transaction Code for the block
          type: string
          minLength: 0
          maxLength: 20
    blockStatusTypeType:
      type: string
      description: Simple type for specifying the block status type.
      enum:
      - Inquiry
      - Actual
      - Waitlist
      - Cancel
      - Referral
    blockStatusChangeHistoryType:
      type: array
      description: Collection of block status history.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/bookingStatusHistoryType'
    blockInventoryItemSourceType:
      type: object
      description: Defines whether the item is setup due to a Rate Plan, Package or a Block.
      properties:
        ratePlanCode:
          description: Rate Plan Code, If populated specifies that the item is setup due to a Rate Plan.
          type: string
          minLength: 0
          maxLength: 20
        packageCode:
          description: Package Code, If populated specifies that the item is setup due to a Package.
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          description: Block Unique ID, If populated specifies that the item is setup due to a Block.
          $ref: '#/components/schemas/blockId'
    blockAllocationRangeType:
      type: object
      description: Container for information related to block allocation range update operation
      properties:
        blockId:
          description: Specifies the Block ID which is the unique identifier for the Block for both internal and external systems.
          $ref: '#/components/schemas/blockId'
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        roomTypes:
          description: List of room types for which the range update has to be applied.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        beginDate:
          description: Begin date for range update operation.
          type: string
          format: date
          maxLength: 8
        endDate:
          description: End date for range update operation.
          type: string
          format: date
          maxLength: 8
        allocationType:
          description: Allocation type for which the range operation is applied.
          $ref: '#/components/schemas/allocationType'
        incrementFlag:
          description: Flag to indicate if the occupancy data is absolute or relative to the current value.
          type: boolean
        blockInventory:
          description: Occupancy data for range operation.
          $ref: '#/components/schemas/blockGridInvType'
        blockRates:
          description: Rate details for range operation.
          $ref: '#/components/schemas/blockGridRatesType'
        cutoffDate:
          description: Date after which unused block rooms should be returned to house.
          type: string
          format: date
          maxLength: 8
        cutoffDays:
          description: Number of days from block start date after which unused block rooms should be returned to house.
          type: integer
        overrideCutoffSchedule:
          description: A true value indicates that the cutoff schedule, if added to Business Block, can be overridden.
          type: boolean
        includedDays:
          type: string
          minLength: 0
          maxLength: 8
        rangeMode:
          description: Indicates whether the range is being applied on shoulder dates or core dates.
          $ref: '#/components/schemas/blockRangeModeType'
        overbookList:
          description: Date which has to be overbooked or excluded.
          type: array
          maxItems: 4000
          items:
            type: object
            properties:
              stayDate:
                description: Date which has to be overbooked or excluded.
                type: string
                format: date
                maxLength: 8
              roomType:
                description: Room type that has to be overbooked or excluded.
                type: string
                minLength: 0
                maxLength: 20
              overbook:
                description: A true value indicates that the date/room type should be overbooked for inventory. A false value indicates that this combination should be excluded from range.
                type: boolean
        genericRoomType:
          description: Indicates if the Allocation objects refer to Generic Room Types (Room Pools).
          type: boolean
    bookingStatusHistoryType:
      type: object
      properties:
        sequence:
          description: Number indicating the sequence of status change.
          type: integer
        bookingStatus:
          description: Booking status of the business block.
          $ref: '#/components/schemas/codeDescriptionType'
        modifyDateTime:
          description: Date and time of the status change.
          type: string
          format: date
          maxLength: 8
        modifierId:
          description: User who modified the status.
          type: string
          minLength: 0
          maxLength: 200
    companyType:
      type: object
      properties:
        companyName:
          description: Name of the company.
          type: string
          minLength: 0
          maxLength: 40
    sellLimitGridByDateRangeType:
      type: object
      description: Indicates the sell limits for a date range. This will be rooms.
      properties:
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
        sunday:
          type: boolean
        monday:
          type: boolean
        tuesday:
          type: boolean
        wednesday:
          type: boolean
        thursday:
          type: boolean
        friday:
          type: boolean
        saturday:
          type: boolean
        sellLimit:
          description: Indicates the sell limit for the date range.
          type: integer
    translationsTextType:
      type: array
      description: Language code for the translation.
      maxItems: 4000
      items:
        type: object
        properties:
          value:
            type: string
            description: Used for Character Strings, length 0 to 2000.
            minLength: 0
            maxLength: 2000
          language:
            description: Language identification.
            type: string
            minLength: 0
            maxLength: 20
        description: Language code for the translation.
    resCancelPenaltyType:
      type: object
      description: The CancelPenalty class defines the cancellation policy of the hotel facility.
      properties:
        deadline:
          description: Cancellation deadline, absolute or relative.
          $ref: '#/components/schemas/policyDeadlineType'
        amountPercent:
          description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights.
          $ref: '#/components/schemas/policyAmountPercentType'
        penaltyDescription:
          description: Text description of the Penalty in a given language.
          type: string
          minLength: 0
          maxLength: 2000
        offsetUnit:
          $ref: '#/components/schemas/offsetUnitType'
        formattedRule:
          description: Formatted Text Rule of the Cancellation Penalty.
          type: string
          minLength: 0
          maxLength: 2000
        policyCode:
          description: Policy Code.
          type: string
          minLength: 0
          maxLength: 20
        manual:
          description: Flag to indicate if the cancellation policy is manual.
          type: boolean
        nonRefundable:
          description: Indicates if the amount is refundable if booking is canceled.
          type: boolean
        effective:
          description: Indicator if Cancellation Penalty is currently applicable or not.
          type: boolean
    centralSalesLeadsType:
      type: object
      properties:
        centralLead:
          description: Basic information about the Central Lead.
          $ref: '#/components/schemas/leadInfoType'
        propertyLeads:
          description: Basic information about the Property Leads.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/leadInfoType'
      description: Basic information about the Central Lead and its linked Property Leads.
    blockAlternateDateType:
      type: object
      description: Information for Alternate date types
      properties:
        alternateBeginDate:
          description: Alternate Begin date.
          type: string
          format: date
          maxLength: 8
        blockRates:
          description: Rate details for Alternate Dates.
          $ref: '#/components/schemas/blockGridRatesType'
        roomCategory:
          description: The Room Category Label
          type: string
          minLength: 0
          maxLength: 20
        priority:
          description: The Priority given to these alternate dates.
          type: integer
    blockRestrictionType:
      type: object
      description: Restriction details for a block.
      properties:
        restrictionDate:
          description: Date for which the restriction applies.
          $ref: '#/components/schemas/timeSpanDaysOfWeekType'
        roomType:
          description: Room Type selected for the block restriction.
          type: string
          minLength: 0
          maxLength: 20
        blockRestrictionStatus:
          description: Indicates the type of restriction along with parameters for restriction, if any.
          $ref: '#/components/schemas/restrictionStatusType'
        actualTimeSpan:
          description: Actual time span of the restriction.
          $ref: '#/components/schemas/timeSpanType'
    configPackagePrimaryDetailsType:
      type: object
      description: A Config Package Info type.
      properties:
        description:
          description: The description of the package.
          type: string
          minLength: 0
          maxLength: 2000
        shortDescription:
          description: The short description of the package.
          type: string
          minLength: 0
          maxLength: 2000
        forecastGroup:
          description: The Forecast group package belongs to.
          type: string
          minLength: 0
          maxLength: 20
        arrangementCode:
          description: Arrangement Code.
          type: string
          minLength: 0
          maxLength: 20
        beginSellDate:
          description: Indicates the begin sell date of the package.
          type: string
          format: date
          maxLength: 8
        endSellDate:
          description: Indicates the end sell date of the package.
          type: string
          format: date
          maxLength: 8
    allocationType:
      type: string
      description: Simple type for block allocation used in room rate grid.
      enum:
      - Initial
      - Actual
      - Rates
      - Pickup
      - Contract
      - Available
      - Pickupperc
      - Changes
      - Released
      - Houseavailability
      - SellLimit
      - AvailableSellLimit
      - MasterAllocInitial
      - Allocated
      - SubAllocResv
      - CutoffDate
      - ForecastRooms
      - ForecastRates
    blockProfileTypeType:
      type: string
      description: Simple type for block profile types.
      enum:
      - Company
      - Group
      - Agent
      - Source
      - CompanyContact
      - AgentContact
      - SourceContact
    eventAttendeesType:
      type: object
      description: Event attendees information.
      properties:
        noOfAttendees:
          description: The maximum number of attendees for Catering events associated with the block.
          type: integer
        attendeesGuaranteed:
          description: This denotes that the number of Attendees are the minimum guaranteed by the customer.
          type: boolean
    blockAllocationRanges:
      type: object
      description: Collection of block allocation ranges.
      properties:
        blockAllocationRanges:
          description: Collection of Range information for the block allocation ranges operation.
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/blockAllocationRangeType'
    externalReferencesType:
      type: array
      description: This type contains unique information of external reference.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/externalReferenceType'
    criteria:
      type: object
      description: Request object for fetching block allocation summary asynchronously.
      properties:
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        occupancyDate:
          type: string
          format: date
        startLastModifiedDate:
          type: string
          format: date-time
        endLastModifiedDate:
          type: string
          format: date-time
        includeNetRates:
          description: 'Boolean flag that indicates whether net rates are to be fetched or not. By default, this value is false. '
          type: boolean
          default: false
    blockWashScheduleType:
      type: object
      description: 'Allows to select type of wash schedule: by number of rooms or by percentage.'
      properties:
        washDate:
          description: Date on which the block wash operation will be performed.
          type: string
          format: date
          maxLength: 8
        roomTypes:
          description: A single room type on which wash operation should be performed.
          type: array
          maxItems: 4000
          items:
            type: string
            minLength: 0
            maxLength: 20
        washByRooms:
          description: Wash by rooms contains the occupany details and sell values for a specific block wash schedule.
          $ref: '#/components/schemas/blockGridInvType'
        washByPercent:
          description: When using the Wash by % option, indicate a wash percentage that will be applied it to the whole block.
          type: number
          minimum: 0
          maximum: 100
    cancellationDetailsType:
      type: object
      description: This type holds information regarding booking status change to Cancel/ Lost.
      properties:
        cancellationNumber:
          description: Cancellation number of the block.
          $ref: '#/components/schemas/uniqueID_Type'
        cancellationCode:
          description: Code and description for cancellation reason.
          $ref: '#/components/schemas/codeDescriptionType'
        cancellationDate:
          description: Date on which block was canceled.
          type: string
          format: date
          maxLength: 8
        cancellationInfo:
          description: Cancellation information provided by the customer.
          type: string
          minLength: 0
          maxLength: 2000
        destination:
          description: Alternate destination where the business is being taken.
          type: string
          minLength: 0
          maxLength: 20
        lostToProperty:
          description: Holds the name of the property or competitor brand business was lost to.
          type: string
          minLength: 0
          maxLength: 100
    roomFeatureType:
      type: object
      description: Room Feature Information.
      properties:
        code:
          description: A code representing a room feature.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: A code representing a room feature.
          type: string
          minLength: 0
          maxLength: 2000
        orderSequence:
          description: Display Order sequence.
          type: number
        quantity:
          description: Indicates quantity.
          type: integer
    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.
    userDefinedFieldsType:
      type: object
      description: A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
      properties:
        characterUDFs:
          description: Collection of user defined fields of Character/String Type.
          $ref: '#/components/schemas/characterUDFsType'
        numericUDFs:
          description: Collection of user defined fields of Numeric Type.
          $ref: '#/components/schemas/numericUDFsType'
        dateUDFs:
          description: Collection of user defined fields of Date Type.
          $ref: '#/components/schemas/dateUDFsType'
    sellMessageConfigsType:
      type: object
      description: The SellMessageConfigsType is the list of sell messages, each comprising of all the sell message attributes and other details.
      properties:
        sellMessageConfig:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/sellMessageConfigType'
        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
    bookingStatusType:
      type: object
      description: Booking status code, description and configured color of the status. This will be used for block and event statuses.
      properties:
        status:
          description: Status code and description.
          $ref: '#/components/schemas/codeDescriptionType'
        color:
          description: Color from status configuration.
          $ref: '#/components/schemas/statusColorType'
    blockAccessExclusionsType:
      type: object
      description: Access Exclusion information indicating the actions allowed under a HUB or hotel for which the access exclusion is set.
      properties:
        blockAccessExclusion:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/blockAccessExclusionType'
        accessExclusionMessage:
          description: Exclusion message for the block.
          $ref: '#/components/schemas/blockAccessExclusionMessageType'
        hotelId:
          description: Hotel code to which the block belongs to.
          type: string
          minLength: 0
          maxLength: 20
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
    statusType:
      type: string
      description: Status of the process.
      enum:
      - Success
      - Error
      - Running
      - Stopped
      - Warning
      - Failed
      - Started
      - CompletedWithLogs
    blockInventoryControlType:
      type: string
      description: Simple type for block inventory control values. This determines if it is a Non Elastic, Elastic or Sell Limits block.
      enum:
      - NonElastic
      - Elastic
      - SellLimit
    marketCodeInfoType:
      type: object
      properties:
        marketCode:
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        marketGroup:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
    blockInventoryItemsType:
      type: array
      description: Inventory item attached to a block.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockInventoryItemType'
    dateRangeType:
      type: object
      description: Date Range with Start and End dates.
      properties:
        start:
          description: The starting value of the date range.
          type: string
          format: date
          maxLength: 8
        end:
          description: The ending value of the date range.
          type: string
          format: date
          maxLength: 8
    traceTimeInfoType:
      type: object
      properties:
        dateTimeSpan:
          description: Time span for the trace.
          $ref: '#/components/schemas/dateTimeSpanType'
        traceOn:
          description: Date of the trace.
          type: string
          format: date-time
        traceTime:
          description: Time of the trace
          type: string
          minLength: 0
          maxLength: 20
        enteredBy:
          description: User that entered this trace.
          type: string
    blockStatisticsType:
      type: object
      properties:
        allocatedRoomStatistics:
          description: Indicates the room statistics for allocated rooms.
          $ref: '#/components/schemas/roomStatisticsType'
        actualRoomStatistics:
          description: Indicates the room statistics for actualized rooms.
          $ref: '#/components/schemas/roomStatisticsType'
        cateringRevenueOnBooks:
          description: Indicates the catering revenue on the books.
          type: number
        actualCateringRevenue:
          description: Indicates actualized catering revenue.
          type: number
    blockAllocationSummary:
      type: array
      description: Response object for fetched block allocation summary.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockAllocationSummaryType'
    cancelPenaltyType:
      type: object
      description: The CancelPenalty class defines the cancellation policy of the hotel facility.
      properties:
        deadline:
          description: Cancellation deadline, absolute or relative.
          $ref: '#/components/schemas/policyDeadlineType'
        amountPercent:
          description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights.
          $ref: '#/components/schemas/policyAmountPercentType'
        penaltyDescription:
          description: Text description of the Penalty in a given language.
          type: string
          minLength: 0
          maxLength: 2000
        offsetUnit:
          $ref: '#/components/schemas/offsetUnitType'
        formattedRule:
          description: Formatted Text Rule of the Cancellation Penalty.
          type: string
          minLength: 0
          maxLength: 2000
        policyCode:
          description: Policy Code.
          type: string
          minLength: 0
          maxLength: 20
        manual:
          description: Flag to indicate if the cancellation policy is manual.
          type: boolean
        nonRefundable:
          description: Indicates if the amount is refundable if booking is canceled.
          type: boolean
        effective:
          description: Indicator if Cancellation Penalty is currently applicable or not.
          type: boolean
        estimatedAmount:
          description: Estimated Amount for the cancellation penalty.
          type: number
    functionArgumentsType:
      type: array
      description: Collection of function arguments and their corresponding values.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/functionArgumentType'
    blockGridRatesType:
      type: object
      description: Indicates the rate amount values per person occupancy.
      properties:
        onePerson:
          description: Indicates the one person occupancy rate amount.
          type: number
        twoPerson:
          description: Indicates the two person occupancy rate amount.
          type: number
        threePerson:
          description: Indicates the three person occupancy rate amount.
          type: number
        fourPerson:
          description: Indicates the four person occupancy rate amount.
          type: number
        extraPerson:
          description: Indicates the extra person occupancy rate amount.
          type: number
    blockClassificationType:
      type: string
      description: Simple type for block instructions to be used in requests for fetching blocks. Valid status values are MASTER_BLOCK, MASTER_TOUR, FIT_MASTER, MASTER_ALLOCATION, MASTER_ITINERARY, LEAD_MASTER, REGULAR_BOOKING, SUB_BLOCK, SUB_TOUR, FIT_CONTRACT, SUB_ALLOCATION, SUB_ITINERARY, LEAD.
      enum:
      - MasterBlock
      - MasterTour
      - MasterAllocation
      - MasterItinerary
      - LeadMaster
      - RegularBooking
      - SubBlock
      - SubTour
      - FitContract
      - SubAllocation
      - SubItinerary
      - Lead
      - FitMaster
      - Opportunity
    blockDetailsType:
      type: object
      description: Information about the Block Details
      properties:
        blockCode:
          description: Block code for the block.
          type: string
          minLength: 0
          maxLength: 20
        blockName:
          description: Name of the block.
          type: string
          minLength: 0
          maxLength: 2000
        blockAliases:
          description: Alias name(s) that can be used to search for the block.
          $ref: '#/components/schemas/blockAliasesType'
        timeSpan:
          description: The Time Span(Arrival, Departure) which covers the Block Span.
          $ref: '#/components/schemas/timeSpanType'
        originalTimeSpan:
          description: The Original Time Span(Arrival, Departure) which covers the Block Span.
          $ref: '#/components/schemas/timeSpanType'
        shoulderDates:
          description: The Shoulder Dates (Arrival, Departure) which covers the Block Shoulder Span.
          $ref: '#/components/schemas/timeSpanType'
        shoulderRatePlanCode:
          description: The shoulder rate plans which cover the block shoulder start and end dates.
          type: object
          properties:
            shoulderStart:
              description: The Rate Plan(s) for the days between the shoulder start date and the actual block start date.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/blockRatePlanInfoType'
            shoulderEnd:
              description: The Rate Plan(s) for the days between the actual block end date and the shoulder end date.
              type: array
              maxItems: 4000
              items:
                $ref: '#/components/schemas/blockRatePlanInfoType'
        blockStatus:
          description: Current status of the block.
          $ref: '#/components/schemas/bookingStatusDetailType'
        blockNextStatusList:
          description: List of possible next booking statuses of the business block.
          $ref: '#/components/schemas/blockNextStatusListType'
        blockStatusChangeHistory:
          description: List of booking status changes.
          $ref: '#/components/schemas/blockStatusChangeHistoryType'
        reservationType:
          description: Reservation Type info of the block.
          $ref: '#/components/schemas/reservationTypeInfoType'
        marketCode:
          description: Market code info of the block.
          $ref: '#/components/schemas/marketCodeInfoType'
        sourceOfSale:
          description: Point of Sale of block. Identifies the entity/channel who made the block reservation.
          $ref: '#/components/schemas/blockSourceOfSaleType'
        reservationMethod:
          description: Reservation Method of the block. Indicates how the individual reservations will be handled (Individual Call In, Rooming List, etc).
          $ref: '#/components/schemas/codeDescriptionType'
        bookingType:
          description: Business Block Type field on the Business Block
          $ref: '#/components/schemas/codeDescriptionType'
        status:
          description: Internal status for the block.
          type: string
          minLength: 0
          maxLength: 20
        blockType:
          description: Internal type of the block.
          type: string
          minLength: 0
          maxLength: 20
        blockOrigin:
          description: Origin information of the block PMS/ORS/SC/SFA
          type: string
          minLength: 0
          maxLength: 20
        overbookAll:
          description: Flag to determine if user wants to overbook sales allowance.
          type: boolean
        paymentMethod:
          description: Indicate which method of payment will be used for the block's charges.
          $ref: '#/components/schemas/codeDescriptionType'
        commissionPercent:
          description: Indicate what percentage of this block is eligible for commission.
          type: number
          minimum: 0
          maximum: 100
        conversionCode:
          description: Indicates the likelihood description of the block moving to the next active block status.
          type: string
          minLength: 0
          maxLength: 20
        conversionCodeDescription:
          description: Indicates the likelihood of the block moving to the next active block status.
          type: string
          minLength: 0
          maxLength: 2000
        rateProtectionDetails:
          description: Indicates the Rate Protection details for the block.
          $ref: '#/components/schemas/blockRateProtectionType'
        nonCompeteDetails:
          description: Indicates the non-competing industry details.
          $ref: '#/components/schemas/blockNonCompeteType'
        rankingCode:
          description: Indicates the ranking of the block.
          type: string
          minLength: 0
          maxLength: 20
        rankingCodeDescription:
          description: Indicates the ranking description of the block.
          type: string
          minLength: 0
          maxLength: 2000
        currencyCode:
          description: Currency Code attached to the business block.
          type: string
          minLength: 0
          maxLength: 20
        cancellationDetails:
          description: Information on the canceled block.
          $ref: '#/components/schemas/cancellationDetailsType'
        hotelName:
          description: A text field used to communicate the proper name of the hotel.
          type: string
          minLength: 0
          maxLength: 80
        tourCode:
          description: The tour code that this block belongs to, if the block is a part of a tour series.
          type: string
          minLength: 0
          maxLength: 20
        hotelUse:
          description: Indicates whether the block can be updated only by the Hotel to which it belongs.
          $ref: '#/components/schemas/hotelUseType'
        rateOverrideReason:
          description: Indicates the reason for overriding the rate amounts on a block.
          $ref: '#/components/schemas/codeDescriptionType'
        blockClassification:
          description: Indicate Block Classification.
          $ref: '#/components/schemas/blockClassificationType'
        isCentralSalesLead:
          description: Flag to determine if the given block is central lead or not.
          type: boolean
        centralSalesLeadResort:
          description: Resort name of central sales lead for this property lead.
          type: string
          minLength: 0
          maxLength: 80
        centralSalesLeadId:
          description: Central sales lead id of the central sales lead for this property lead.
          type: string
          minLength: 0
          maxLength: 20
        synchronized:
          description: Indicate if Master/Sub Blocks are Synchronized.
          type: boolean
        subBlockIdList:
          description: Sub Block code will be populated, when master block creation is in progress.
          $ref: '#/components/schemas/subBlockIdList'
        primaryOwners:
          description: Primary owners for the block.
          type: object
          properties:
            blockOwner:
              description: Primary Block Owner
              $ref: '#/components/schemas/blockOwnerType'
            roomsOwner:
              description: Primary Rooms Owner
              $ref: '#/components/schemas/blockOwnerType'
            cateringOwner:
              description: Primary Catering Owner
              $ref: '#/components/schemas/blockOwnerType'
            blockOwnerCount:
              description: Total number of Block Owners.
              type: number
            roomsOwnerCount:
              description: Total number of Rooms Owners.
              type: number
            cateringOwnerCount:
              description: Total number of Catering Owners.
              type: number
        primaryProfiles:
          description: Primary account and contact for the block.
          type: object
          properties:
            account:
              description: Primary Account
              $ref: '#/components/schemas/blockProfilesType'
            contact:
              description: Primary Contact
              $ref: '#/components/schemas/blockProfilesType'
            image:
              description: The primary profile image. If primary contact exists, Contact Image, otherwise primary Account Image
              $ref: '#/components/schemas/imageSetType'
        primaryRatePlanCodes:
          description: Primary rates for the block.
          type: object
          properties:
            blockRatePlanCode:
              description: Primary Block Rate
              $ref: '#/components/schemas/blockRatePlanInfoType'
            shoulderStartRatePlanCode:
              description: Primary Shoulder Start Rate
              $ref: '#/components/schemas/blockRatePlanInfoType'
            shoulderEndRatePlanCode:
              description: Primary Shoulder End Rate
              $ref: '#/components/schemas/blockRatePlanInfoType'
            blockRatePlanCodeCount:
              description: Total number of Block Rates.
              type: number
            shoulderStartRatePlanCodeCount:
              description: Total number of Shoulder Start Rates.
              type: number
            shoulderEndRatePlanCodeCount:
              description: Total number of Shoulder End Rates.
              type: number
        cateringOnlyBlock:
          description: Indicates if this is a catering only block.
          type: boolean
        flexibleDates:
          description: Indicates if alternate dates are allowed for the booking.
          type: boolean
        externalLocked:
          description: Indicates if the block is locked by an external system.
          type: boolean
        autoloadContractGrid:
          description: Indicates if contract grid will be auto loaded from original grid.
          type: boolean
        autoloadForecastGrid:
          description: Indicates if forecast grid will be auto loaded from original grid.
          type: boolean
        allowRateOverride:
          description: Indicates whether rates of a block can be overridden. Applicable only for blocks with a Rate Code.
          type: boolean
        hasLinkedActivities:
          description: Indicates if block has any linked activity(s).
          type: boolean
        manualCutOff:
          description: Indicates whether Block was cutoff manually.
          type: boolean
        wholesaleBlock:
          description: Indicates whether the business block should be considered as a wholesale block for revenue management block materialization forecasting
          type: boolean
        controlBlockLocally:
          description: Determines whether or not the block can be managed at the CRS level.
          type: boolean
        businessDateArrivalsExist:
          description: Indicate whether arrivals exists on current business date.
          type: boolean
        quoteReferenceNumber:
          description: Quote Reference Number is an alternate id number for the block that can be used in the SC Quote report and allows for tracking and managing revisions
          type: string
          minLength: 0
          maxLength: 200
        taxType:
          description: The Tax Type determines whether generates are applied when calculating prices and revenue. When populated, the Tax Type value will default on the Posting Master and will be used in the calculations for the Proforma Invoice report.
          type: string
          minLength: 0
          maxLength: 20
        overrideBlockCodeTemplate:
          description: Indicates whether block code template can be overridden.
          type: boolean
    applyEventAttendeesChangesToEventsType:
      type: string
      description: Non-Pkg Events on the same date.
      enum:
      - All
      - None
      - Same
      - NonPackage
      - MatchingNonPackage
      - Package
      - Date
    profileId:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    resCancellationPoliciesType:
      type: array
      description: A list of reservation cancellation policies.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resCancellationPolicyType'
    profileTypeType:
      type: string
      description: The types of Profile handled by the web service.
      enum:
      - Guest
      - Agent
      - Company
      - Group
      - Source
      - Employee
      - Hotel
      - Vendor
      - Contact
      - Purge
      - BusinessHeader
      - BillingAccount
      - Activity
      - Potential
      - Account
    reservationId:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    cateringType:
      type: object
      description: Contains catering related information for the block.
      properties:
        cateringStatus:
          description: Catering Status details of the block.
          $ref: '#/components/schemas/bookingStatusDetailType'
        cateringInternalStatus:
          description: Internal status for the catering.
          type: string
          minLength: 0
          maxLength: 20
        cateringNextStatusList:
          description: Catering Status details of the block.
          $ref: '#/components/schemas/cateringNextStatusListType'
        cateringStatusChangeHistory:
          description: List of catering status changes.
          $ref: '#/components/schemas/cateringStatusChangeHistoryType'
        cateringOwner:
          description: Catering Owner of the block.
          type: string
          minLength: 0
          maxLength: 20
        eventAttendees:
          description: The catering attendees information for events associated with the block.
          $ref: '#/components/schemas/eventAttendeesType'
        boardInfo:
          description: The name by which the group wishes to be identified in the hotel.
          type: string
          minLength: 0
          maxLength: 80
        onSiteName:
          description: The name of the customer's in-house representative or contact on the day of the catering event.
          type: string
          minLength: 0
          maxLength: 40
        contractNumber:
          description: Catering contract number for the block.
          type: string
          minLength: 0
          maxLength: 20
        functionInfo:
          description: This provides more detail the type of function for which the event is held. For example, Trade Show, Meeting, or Annual Convention.
          type: string
          minLength: 0
          maxLength: 60
        trackChanges:
          description: Indicates whether the catering change logging for the booking is active or not. Any change made to catering events and resources will be logged when this is true.
          type: boolean
        eventOrder:
          description: Indicates if the Banquet Event Orders have been distributed.
          $ref: '#/components/schemas/eventOrderType'
        cateringRevenue:
          description: Information about catering revenue.
          $ref: '#/components/schemas/cateringRevenueType'
        followUpDate:
          description: Date used by catering manager or coordinator to follow up on the event.
          type: string
          format: date
          maxLength: 8
        decisionDate:
          description: Date by which event group must make a decision on the booking.
          type: string
          format: date
          maxLength: 8
        pkgsTmplt:
          description: Indicates whether event packages or templates can be applied to the block.
          type: boolean
        cancellationDetails:
          description: Information on the catering cancellation.
          $ref: '#/components/schemas/cancellationDetailsType'
        resourceDiscountPercentage:
          description: Indicates the resource discount percentage to be applied to resource items associated with the catering event.
          type: number
          minimum: 0
          maximum: 100
        hasPackageEvents:
          description: Indicates if the block has any package events.
          type: boolean
        applyBoardInfoToAllEvents:
          description: Indicates whether BoardInfo changes can be applied to all events of the block.
          type: boolean
        applyMoveEvents:
          description: Indicates whether catering event dates are moved when the block dates are changed.
          type: boolean
        overrideEventsProcessingWarnings:
          description: Indicates whether to ignore any warning during applying the changes to the events associated with the current block.
          type: boolean
        applyEventsGuaranteeToAllEvents:
          description: Indicates whether Guarantee changes can be applied to all events of the block.
          type: boolean
        applyEventAttendeesChangesToEvents:
          description: Indicates to which the events of the block can the attendees changes be applied.
          $ref: '#/components/schemas/applyEventAttendeesChangesToEventsType'
        resourceDiscountType:
          description: Attibute that indicates to which type of resource the discount should be applied to.
          $ref: '#/components/schemas/resourceDiscountTypeType'
    leadInfoType:
      type: object
      properties:
        blockIdList:
          description: Collection of unique block identifiers.
          $ref: '#/components/schemas/blockIdList'
        hotelId:
          description: Hotel Id.
          type: string
          minLength: 0
          maxLength: 20
        blockType:
          description: Indicate Block Classification.
          $ref: '#/components/schemas/blockClassificationType'
        timeSpan:
          description: The Time Span of the block.
          $ref: '#/components/schemas/timeSpanType'
        blockName:
          description: Lead description.
          type: string
          minLength: 0
          maxLength: 2000
        blockStatus:
          description: Current block status of the lead.
          $ref: '#/components/schemas/bookingStatusType'
        cateringStatus:
          description: Current catering status of the lead.
          $ref: '#/components/schemas/bookingStatusType'
        roomNightsBlocked:
          description: Number of blocked rooms for the lead.
          type: integer
          minimum: 0
        roomNightsPickedup:
          description: Number of reserved rooms for the lead.
          type: integer
          minimum: 0
    allocationGridByDateRangesType:
      type: object
      description: A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.
      properties:
        roomAllocationInfo:
          description: Allocation objects for a block.
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/allocationGridByDateRangeType'
        allocation:
          description: Indicates the type of the Allocation objects.
          type: string
          minLength: 0
          maxLength: 40
    characterUDFType:
      type: object
      description: Used to hold user defined field of Character/String Type.
      properties:
        name:
          description: Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.
          type: string
          minLength: 0
          maxLength: 20
        value:
          description: Value of user defined field.
          type: string
          minLength: 0
          maxLength: 2000
        alternateName:
          description: Label of user defined field used by vendors or customers.
          type: string
          minLength: 0
          maxLength: 2000
    policyDeadlineType:
      type: object
      description: Cancellation deadline, absolute or relative.
      properties:
        absoluteDeadline:
          description: Defines the absolute deadline. Either this or the offset attributes may be used.
          type: string
          format: date-time
        offsetFromArrival:
          description: The number of days before arrival that allows cancellation without penalties.
          type: integer
        offsetDropTime:
          description: Time on offset day the cancellation penalties applies.
          type: string
          format: date-time
        offsetFromBookingDate:
          description: The number of days after booking deposit must be paid.
          type: integer
    roomAllocationMasterInfoType:
      type: object
      properties:
        roomTypes:
          description: Detailed information about Room Type in the Hotel.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/allocationRoomTypeInfoType'
        genericRoomTypes:
          description: Detailed information about Room Type in the Hotel.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/allocationRoomTypeInfoType'
    porterageType:
      type: object
      description: Information about porterage charges.
      properties:
        porterageIncluded:
          description: Indicates if the room rate quoted includes any porterage cost.
          type: boolean
        price:
          description: The additional charges per person for porterage service, if porterage is not included in the rate.
          $ref: '#/components/schemas/currencyAmountType'
    blockProfilesType:
      type: object
      description: A collection of Profile objects or Unique IDs of Profiles.
      properties:
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems.
          $ref: '#/components/schemas/uniqueIDListType'
        profile:
          description: Provides detailed information regarding either a company or a customer profile.
          $ref: '#/components/schemas/profileType'
        blockProfileType:
          description: Determines the type of the block profile.
          $ref: '#/components/schemas/blockProfileTypeType'
    allocationGridByRoomTypesType:
      type: object
      description: A collection of Allocation objects for a block defined by room type.
      properties:
        hotelId:
          description: Opera Hotel code for the Set Allocation Grid request.
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          description: Unique block identifier of the block for which the allocations need to be set.
          $ref: '#/components/schemas/blockId'
        allocationRoomTypes:
          description: Allocation objects of a block grouped by room types.
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/allocationGridByRoomTypeType'
        genericRoomType:
          description: Indicates if the Allocation objects refer to Generic Room Types (Room Pools).
          type: boolean
    block:
      type: object
      description: Request object for creation of blocks. This object contains block details with unique identifiers for each block. The standard optional Opera Context element is also included.
      properties:
        blocks:
          description: Contains the detailed information regarding the block.
          $ref: '#/components/schemas/blocksType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    mealPlanCodeType:
      type: object
      description: Meal plan codes associated with the rate codes.
      properties:
        code:
          description: Meal plan code.
          type: string
          minLength: 0
          maxLength: 40
        included:
          description: Represents if the meal plan code is included in rate code or not.
          type: boolean
        breakfastIncluded:
          description: Represents if the meal plan code is available for breakfast or not.
          type: boolean
        lunchIncluded:
          description: Represents if the meal plan code is available for lunch or not.
          type: boolean
        dinnerIncluded:
          description: Represents if the meal plan code is available for dinner or not.
          type: boolean
    formattedTextTextType:
      type: object
      description: Provides text and indicates whether it is formatted or not.
      properties:
        value:
          type: string
          description: Property Value
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
    resCancellationPolicyType:
      type: object
      description: A cancellation policy attached with the reservation.
      properties:
        revenueType:
          description: Type of reservation.
          $ref: '#/components/schemas/depositCancelRevenueType'
        policy:
          description: Cancellation policy details.
          $ref: '#/components/schemas/resCancelPenaltyType'
        percentageDue:
          description: The percentage amount due for reservation cancellation.
          type: number
          minimum: 0
          maximum: 100
        comments:
          description: Comments attached with the reservation cancellation.
          type: string
          minLength: 0
          maxLength: 2000
        policyId:
          description: Unique ID of the Reservation Policy.
          $ref: '#/components/schemas/uniqueID_Type'
    hotelCodeListType:
      type: array
      description: Hotel code.
      maxItems: 4000
      items:
        type: string
        minLength: 0
        maxLength: 20
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    blockRestrictionsType:
      type: object
      description: List of restrictions belonging to a block.
      properties:
        blockId:
          description: Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA.
          $ref: '#/components/schemas/blockId'
        blockRestriction:
          description: Block restriction details.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/blockRestrictionType'
        hotelId:
          description: Hotel to which the block belongs to.
          type: string
          minLength: 0
          maxLength: 20
    blockTracesType:
      type: array
      description: List of Block traces.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockTraceType'
    blockAccessRestrictionType:
      type: string
      description: Simple type for block access exclusion/restriction types.
      enum:
      - Availability
      - Create
      - Modify
      - Cancel
    profileType:
      type: object
      description: Type provides the detailed information about the profile and its children.
      properties:
        customer:
          description: Detailed customer information for this profile.
          $ref: '#/components/schemas/customerType'
        company:
          description: Detailed company information for this profile.
          $ref: '#/components/schemas/companyType'
        profileType:
          description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.
          $ref: '#/components/schemas/profileTypeType'
    externalReferenceType:
      type: object
      description: This type contains unique information of external reference.
      properties:
        id:
          description: Unique ID of external reference.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: ID extension for external reference.
          type: integer
        idContext:
          description: ID context for external reference.
          type: string
          minLength: 0
          maxLength: 80
    blockAccessExclusionMessageType:
      type: object
      description: Access exclusion message.
      properties:
        exclusionMessage:
          description: Access Exclusion message for the block.
          type: string
          minLength: 0
          maxLength: 4000
    depositCancelRevenueType:
      type: string
      description: The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
      enum:
      - Rooms
      - Catering
      - All
    roomGridDetailsType:
      type: object
      description: Indicates the values of room inventory or rate amount per room type.
      properties:
        inventory:
          description: Indicates the room inventory values per person occupancy.
          $ref: '#/components/schemas/blockGridInvType'
        rate:
          description: Indicates the rate amount values per person occupancy.
          $ref: '#/components/schemas/blockGridRatesType'
        roomType:
          description: Indicates the room type for which the inventory or rate values are applicable.
          type: string
          minLength: 0
          maxLength: 20
        genericRoomType:
          description: Indicates the Generic Room Type (Room Pool) the Room Type belongs to.
          type: string
          minLength: 0
          maxLength: 20
    masterBlockInfoType:
      type: object
      properties:
        blockIdList:
          description: Collection of unique block identifiers.
          $ref: '#/components/schemas/blockIdList'
        hotelId:
          description: Master/Sub Block's Hotel Code.
          type: string
          minLength: 0
          maxLength: 20
        blockType:
          description: Indicate Block Classification.
          $ref: '#/components/schemas/blockClassificationType'
        timeSpan:
          description: The Time Span(Arrival, Departure) which covers the Block Span.
          $ref: '#/components/schemas/timeSpanType'
        blockName:
          description: Block description.
          type: string
          minLength: 0
          maxLength: 2000
        blockStatus:
          description: Current status of the block.
          $ref: '#/components/schemas/bookingStatusType'
        cateringStatus:
          description: Catering Status details of the block.
          $ref: '#/components/schemas/bookingStatusType'
        roomNights:
          description: Pertain value for blocked rooms for a block.
          type: integer
        roomNightsPickedup:
          description: Pertain value for reserved rooms for a block.
          type: integer
        syncBlockDates:
          description: Indicates to check if Block Dates to be in sync.
          type: boolean
        syncOtherBlockDetails:
          description: Indicates whether other BlockDetails to be in Sync.
          type: boolean
        syncBlockStatusDetails:
          description: Indicates if Block Status Details to be in sync.
          type: boolean
        syncPackages:
          description: Indicates if packages to be in Sync.
          type: boolean
        subBlockInfo:
          description: Basic information pertaining to the sub block.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/masterSubBlockBaseInfoType'
        masterSubHotels:
          description: Pertains valid hotel code list for logged in user against Master/Sub header record.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/hotelCodeListType'
      description: Basic information pertaining to the master block.
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '503':
      description: Service Unavailable
    '413':
      description: Request Entity Too Large
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '403':
      description: Forbidden
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    x-hotelid:
      name: x-hotelid
      description: Mandatory parameter to identify the hotel code where the end user is logged in
      in: header
      required: true
      schema:
        type: string
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    externalData:
      name: externalData
      description: Pass this header as true, if payload needs DVM
      in: header
      schema:
        type: string
    Accept-Language:
      name: Accept-Language
      description: Language code
      in: header
      schema:
        type: string
    x-app-key:
      name: x-app-key
      description: Client or Partner's Application Key
      in: header
      required: true
      schema:
        type: string
        pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    x-request-id:
      name: x-request-id
      description: Request Id of an incoming request
      in: header
      schema:
        type: string
        pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html