OPERA Cloud Block API

{
  "swagger": "2.0",
  "info": {
    "title": "OPERA Cloud Block API",
    "description": "APIs to cater for Business Block functionality in OPERA Cloud. <br /><br /> A block is a group of rooms held for guests who are attending an event, meeting, or function. You can create blocks for family reunions, business conferences, weddings, and so on. You can also set aside rooms for the event (block).<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"
    }
  },
  "schemes": [
    "https"
  ],
  "basePath": "/blk/v1",
  "produces": [
    "application/json"
  ],
  "paths": {
    "/allocation": {
      "post": {
        "summary": "Create Sub allocation",
        "description": "Use this API to create sub allocation. <p><strong>OperationId:</strong>postSubAllocation</p>",
        "operationId": "postSubAllocation",
        "parameters": [
          {
            "name": "subAllocation",
            "in": "body",
            "required": true,
            "description": "Request object for creation of Sub Allocation. This object contains sub allocation details with unique identifiers for each sub allocation along with Master Allocation information. The standard optional Opera Context element is also included.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/definitions/subAllocation"
                }
              ]
            }
          },
          {
            "$ref": "#/parameters/authKey"
          },
          {
            "$ref": "#/parameters/externalData"
          },
          {
            "$ref": "#/parameters/x-app-key"
          },
          {
            "$ref": "#/parameters/x-request-id"
          },
          {
            "$ref": "#/parameters/x-originating-application"
          },
          {
            "$ref": "#/parameters/x-hotelid"
          },
          {
            "$ref": "#/parameters/x-externalsystem"
          },
          {
            "$ref": "#/parameters/Accept-Language"
          }
        ],
        "responses": {
          "201": {
            "headers": {
              "Content-Language": {
                "type": "string",
                "description": "Audience language",
                "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
                "x-example": "en-GB"
              },
              "Location": {
                "type": "string",
                "description": "Location of newly created resource"
              }
            },
            "description": "HATEOAS links which help the consumer to navigate to resources",
            "schema": {
              "$ref": "#/definitions/status"
            }
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          },
          "405": {
            "$ref": "#/responses/405"
          },
          "406": {
            "$ref": "#/responses/406"
          },
          "413": {
            "$ref": "#/responses/413"
          },
          "414": {
            "$ref": "#/responses/414"
          },
          "415": {
            "$ref": "#/responses/415"
          },
          "500": {
            "$ref": "#/responses/500"
          },
          "502": {
            "$ref": "#/responses/502"
          },
          "503": {
            "$ref": "#/responses/503"
          }
        },
        "consumes": [
          "application/json;charset=UTF-8"
        ],
        "produces": [
          "application/json;charset=UTF-8"
        ],
        "tags": [
          "Block"
        ]
      }
    },
    "/blockActivityLog": {
      "get": {
        "summary": "Get the Block activity log",
        "description": "Use this API to facilitate retrieving the block activity log. <p><strong>OperationId:</strong>getBlockActivityLog</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>",
        "operationId": "getBlockActivityLog",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Indicates maximum number of records a Web Service should return.",
            "type": "integer"
          },
          {
            "name": "offset",
            "in": "query",
            "default": 0,
            "required": false,
            "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.",
            "type": "integer"
          },
          {
            "name": "hotelId",
            "in": "query",
            "required": false,
            "description": "Hotel code.",
            "type": "string"
          },
          {
            "name": "module",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Activity module.",
            "uniqueItems": true,
            "enum": [
              "Reservation",
              "Contract",
              "Allotment",
              "Outlookview",
              "Profile",
              "Accountreceivables",
              "GdsConvRateCodes",
              "RateCode",
              "Billing",
              "Activity"
            ]
          },
          {
            "name": "moduleParamsParameterName",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "Name of the parameter.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "moduleParamsParameterValue",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "Value of the parameter.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "activityGroup",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "activityType",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "activityParamsFromDate",
            "in": "query",
            "required": false,
            "description": "Search from date for the user activity log.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "activityParamsToDate",
            "in": "query",
            "required": false,
            "description": "Search to date for the user activity log.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "activityParamsSearchText",
            "in": "query",
            "required": false,
            "description": "Search text for the user activity log.",
            "type": "string"
          },
          {
            "name": "userByIDsUserId",
            "in": "query",
            "type": "array",
            "maxItems": 4000,
            "collectionFormat": "multi",
            "items": {
              "type": "integer"
            },
            "required": false
          },
          {
            "name": "userForIDsUserId",
            "in": "query",
            "type": "array",
            "maxItems": 4000,
            "collectionFormat": "multi",
            "items": {
              "type": "integer"
            },
            "required": false
          },
          {
            "$ref": "#/parameters/authKey"
          },
          {
            "$ref": "#/parameters/externalData"
          },
          {
            "$ref": "#/parameters/x-app-key"
          },
          {
            "$ref": "#/parameters/x-request-id"
          },
          {
            "$ref": "#/parameters/x-originating-application"
          },
          {
            "$ref": "#/parameters/x-hotelid"
          },
          {
            "$ref": "#/parameters/x-externalsystem"
          },
          {
            "$ref": "#/parameters/Accept-Language"
          }
        ],
        "responses": {
          "200": {
            "headers": {
              "Content-Language": {
                "type": "string",
                "description": "Audience language",
                "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
                "x-example": "en-GB"
              }
            },
            "description": "Response object for fetching block activity log. This object contains collection of user activity log for the block, Success, Warnings and Errors related to this operation",
            "schema": {
              "$ref": "#/definitions/blockActivityLog"
            }
          },
          "204": {
            "description": "BlockActivityLog not found."
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          },
          "405": {
            "$ref": "#/responses/405"
          },
          "406": {
            "$ref": "#/responses/406"
          },
          "413": {
            "$ref": "#/responses/413"
          },
          "414": {
            "$ref": "#/responses/414"
          },
          "415": {
            "$ref": "#/responses/415"
          },
          "500": {
            "$ref": "#/responses/500"
          },
          "502": {
            "$ref": "#/responses/502"
          },
          "503": {
            "$ref": "#/responses/503"
          }
        },
        "consumes": [
          "application/json;charset=UTF-8"
        ],
        "produces": [
          "application/json;charset=UTF-8"
        ],
        "tags": [
          "Block"
        ]
      }
    },
    "/blockWash": {
      "put": {
        "summary": "Update Block Allocation Wash",
        "description": "This API removes block allocation to a range of dates for a set of room types. <p><strong>OperationId:</strong>putBlockAllocationWash</p>",
        "operationId": "putBlockAllocationWash",
        "parameters": [
          {
            "name": "blockAllocationWash",
            "in": "body",
            "required": true,
            "description": "Request object for block wash operation.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/definitions/blockAllocationWash"
                }
              ]
            }
          },
          {
            "$ref": "#/parameters/authKey"
          },
          {
            "$ref": "#/parameters/externalData"
          },
          {
            "$ref": "#/parameters/x-app-key"
          },
          {
            "$ref": "#/parameters/x-request-id"
          },
          {
            "$ref": "#/parameters/x-originating-application"
          },
          {
            "$ref": "#/parameters/x-hotelid"
          },
          {
            "$ref": "#/parameters/x-externalsystem"
          },
          {
            "$ref": "#/parameters/Accept-Language"
          }
        ],
        "responses": {
          "200": {
            "headers": {
              "Content-Language": {
                "type": "string",
                "description": "Audience language",
                "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
                "x-example": "en-GB"
              },
              "Location": {
                "type": "string",
                "description": "Location of newly created resource"
              }
            },
            "description": "Response Body.",
            "schema": {
              "$ref": "#/definitions/status"
            }
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          },
          "405": {
            "$ref": "#/responses/405"
          },
          "406": {
            "$ref": "#/responses/406"
          },
          "413": {
            "$ref": "#/responses/413"
          },
          "414": {
            "$ref": "#/responses/414"
          },
          "415": {
            "$ref": "#/responses/415"
          },
          "500": {
            "$ref": "#/responses/500"
          },
          "502": {
            "$ref": "#/responses/502"
          },
          "503": {
            "$ref": "#/responses/503"
          }
        },
        "consumes": [
          "application/json;charset=UTF-8"
        ],
        "produces": [
          "application/json;charset=UTF-8"
        ],
        "tags": [
          "Block"
        ]
      },
      "get": {
        "summary": "Get Block Wash Information",
        "description": "This API retrieves block information needed to perform block wash operation. <p><strong>OperationId:</strong>getBlockWashInfo</p>",
        "operationId": "getBlockWashInfo",
        "parameters": [
          {
            "name": "hotelId",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X."
          },
          {
            "name": "blockId",
            "in": "query",
            "required": false,
            "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
            "type": "string"
          },
          {
            "name": "blockIdType",
            "in": "query",
            "required": false,
            "description": "A reference to the type of object defined by the UniqueID element.",
            "type": "string"
          },
          {
            "name": "genericRoomType",
            "in": "query",
            "required": false,
            "description": "Indicates if the Allocation objects refer to Generic Room Types (Room Pools).",
            "type": "boolean"
          },
          {
            "$ref": "#/parameters/authKey"
          },
          {
            "$ref": "#/parameters/externalData"
          },
          {
            "$ref": "#/parameters/x-app-key"
          },
          {
            "$ref": "#/parameters/x-request-id"
          },
          {
            "$ref": "#/parameters/x-originating-application"
          },
          {
            "$ref": "#/parameters/x-hotelid"
          },
          {
            "$ref": "#/parameters/x-externalsystem"
          },
          {
            "$ref": "#/parameters/Accept-Language"
          }
        ],
        "responses": {
          "200": {
            "headers": {
              "Content-Language": {
                "type": "string",
                "description": "Audience language",
                "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
                "x-example": "en-GB"
              }
            },
            "description": "Block information required for performing a wash operation on a block.",
            "schema": {
              "$ref": "#/definitions/blockWashInfo"
            }
          },
          "204": {
            "description": "BlockWashInfo not found."
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          },
          "405": {
            "$ref": "#/responses/405"
          },
          "406": {
            "$ref": "#/responses/406"
          },
          "413": {
            "$ref": "#/responses/413"
          },
          "414": {
            "$ref": "#/responses/414"
          },
          "415": {
            "$ref": "#/responses/415"
          },
          "500": {
            "$ref": "#/responses/500"
          },
          "502": {
            "$ref": "#/responses/502"
          },
          "503": {
            "$ref": "#/responses/503"
          }
        },
        "consumes": [
          "application/json;charset=UTF-8"
        ],
        "produces": [
          "application/json;charset=UTF-8"
        ],
        "tags": [
          "Block"
        ]
      }
    },
    "/blocks": {
      "get": {
        "summary": "Get Blocks",
        "description": "Use this API to retrieve a list of blocks for requested query parameters. A wide range of query parameters is available to support various persona requirements, so it is recommended to include, at least, the hotel block date range, stay date range, and/or number of days as query parameters. You can use more query parameters to narrow your results. This API is not designed to support sync between two systems or initial upload of data. If x-hubid is used as a header, it returns matching data from multiple hotels within the same chain. <p><strong>OperationId:</strong>getBlocks</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>",
        "operationId": "getBlocks",
        "deprecated": true,
        "parameters": [
          {
            "name": "hotelId",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "markAsRecentlyAccessed",
            "in": "query",
            "required": false,
            "description": "Mark this block as recently accessed.",
            "type": "boolean"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "maximum": 200,
            "description": "Indicates maximum number of records a Web Service should return.",
            "type": "integer"
          },
          {
            "name": "offset",
            "in": "query",
            "default": 0,
            "required": false,
            "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.",
            "type": "integer"
          },
          {
            "name": "multipleHotelsSearchHotelIds",
            "in": "query",
            "type": "array",
            "maxItems": 4000,
            "collectionFormat": "multi",
            "description": "Hotel code.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "superSearch",
            "in": "query",
            "required": false,
            "description": "Free form text field for searching block fields",
            "type": "string"
          },
          {
            "name": "blockIdList",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "blockIdType",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "A reference to the type of object defined by the UniqueID element.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "externalReferenceIds",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "externalSystemCodes",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "blockCode",
            "in": "query",
            "required": false,
            "description": "Block code",
            "type": "string"
          },
          {
            "name": "blockName",
            "in": "query",
            "required": false,
            "description": "Block Name",
            "type": "string"
          },
          {
            "name": "blockOwner",
            "in": "query",
            "type": "array",
            "maxItems": 4000,
            "collectionFormat": "multi",
            "description": "Block Owner.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "blockStatus",
            "in": "query",
            "type": "array",
            "maxItems": 4000,
            "collectionFormat": "multi",
            "description": "Block Status.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "cateringStatus",
            "in": "query",
            "type": "array",
            "maxItems": 4000,
            "collectionFormat": "multi",
            "description": "Catering Status.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "reservationMethod",
            "in": "query",
            "type": "array",
            "maxItems": 50,
            "collectionFormat": "multi",
            "description": "Mode of reservation (e.g. EML, TEL, FRTDSK ).",
            "items": {
              "type": "string",
              "maxLength": 20
            },
            "required": false
          },
          {
            "name": "createdByUser",
            "in": "query",
            "required": false,
            "description": "user who created the Block(s).",
            "type": "string"
          },
          {
            "name": "blockStartEndDate",
            "in": "query",
            "required": false,
            "description": "The ending value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "blockStartStartDate",
            "in": "query",
            "required": false,
            "description": "The starting value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "blockEndEndDate",
            "in": "query",
            "required": false,
            "description": "The ending value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "blockEndStartDate",
            "in": "query",
            "required": false,
            "description": "The starting value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "reservationArrival",
            "in": "query",
            "required": false,
            "description": "Date when guests plan to arrive(first night stay date).",
            "type": "string",
            "format": "date"
          },
          {
            "name": "reservationDeparture",
            "in": "query",
            "required": false,
            "description": "Date when guests plan to leave(last stay day date).",
            "type": "string",
            "format": "date"
          },
          {
            "name": "includeShoulderDates",
            "in": "query",
            "required": false,
            "description": "Whether to include shoulder dates when considering stay date.",
            "type": "boolean"
          },
          {
            "name": "stayDate",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date"
          },
          {
            "name": "blockCreatedOnEndDate",
            "in": "query",
            "required": false,
            "description": "The ending value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "blockCreatedOnStartDate",
            "in": "query",
            "required": false,
            "description": "The starting value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "decisionEndDate",
            "in": "query",
            "required": false,
            "description": "The ending value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "decisionStartDate",
            "in": "query",
            "required": false,
            "description": "The starting value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "cutOffEndDate",
            "in": "query",
            "required": false,
            "description": "The ending value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "cutOffStartDate",
            "in": "query",
            "required": false,
            "description": "The starting value of the date range.",
            "type": "string",
            "format": "date"
          },
          {
            "name": "category",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "Simple type for block instructions to be used in requests for fetching blocks. Valid status values are Group, Source, TravelAgent, Contact, Company.",
            "uniqueItems": true,
            "items": {
              "type": "string",
              "enum": [
                "Group",
                "Source",
                "Agent",
                "Contact",
                "Company",
                "Account"
              ]
            },
            "required": false
          },
          {
            "name": "name",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "Attached profile name",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "attachedProfileId",
            "in": "query",
            "required": false,
            "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
            "type": "string"
          },
          {
            "name": "attachedProfileIdType",
            "in": "query",
            "required": false,
            "description": "A reference to the type of object defined by the UniqueID element.",
            "type": "string"
          },
          {
            "name": "leads",
            "in": "query",
            "required": false,
            "description": "Show Leads in the search result.",
            "type": "boolean"
          },
          {
            "name": "tourSeries",
            "in": "query",
            "required": false,
            "description": "Show tour series in the search result.",
            "type": "boolean"
          },
          {
            "name": "onlyPickupBlocks",
            "in": "query",
            "required": false,
            "description": "Fetch only blocks which are open for pickup, if true. If the value is false, fetch all block statuses.",
            "type": "boolean"
          },
          {
            "name": "onlyOpportunities",
            "in": "query",
            "required": false,
            "description": "Indicates that only Opportunity blocks will be fetched.",
            "type": "boolean"
          },
          {
            "name": "excludeMasterBlocks",
            "in": "query",
            "required": false,
            "description": "Indicates that all master blocks will be excluded from the results. (Master Blocks, Master Allocations, Master Tours, and Master Itineraries).",
            "type": "boolean"
          },
          {
            "name": "ratePlanCode",
            "in": "query",
            "type": "array",
            "maxItems": 4000,
            "collectionFormat": "multi",
            "description": "Rate Plan Code.",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "tourCode",
            "in": "query",
            "required": false,
            "description": "Tour code for the block.",
            "type": "string"
          },
          {
            "name": "attributeName",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "orderType",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "uniqueItems": true,
            "items": {
              "type": "string",
              "enum": [
                "Asc",
                "Desc"
              ]
            },
            "required": false
          },
          {
            "name": "returnEligibleMasterAllocations",
            "in": "query",
            "type": "boolean",
            "description": "Return only master allocations that are eligible to be the master for the business block to be converted to sub allocation specified in `targetSubAllocationBlockId`.",
            "required": false
          },
          {
            "name": "targetSubAllocationBlockId",
            "in": "query",
            "type": "string",
            "description": "The ID of the regular business block that is being converted to sub allocation.",
            "required": false
          },
          {
            "name": "returnEligibleMasterTours",
            "in": "query",
            "type": "boolean",
            "description": "Return only master tours or master itineraries that are eligible to be the master for the business block being converted to either a sub tour or a sub itinerary.",
            "required": false
          },
          {
            "name": "fetchInstructions",
            "in": "query",
            "type": "array",
            "collectionFormat": "multi",
            "description": "Type for block instructions that can be used in requests for partial operations.",
            "uniqueItems": true,
            "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",
  

# --- truncated at 32 KB (2197 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-blk.json