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.
", "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/config/v1", "produces": [ "application/json" ], "paths": { "/blockCancellationReasons": { "get": { "summary": "Get Block Cancellation Reasons", "description": "Use this API to get Block Cancellation Reasons.OperationId:getBlockCancellationReasons
", "operationId": "getBlockCancellationReasons", "parameters": [ { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$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 Cancellation Reasons.", "schema": { "$ref": "#/definitions/blockCancellationReasonsDetails" } }, "204": { "description": "BlockCancellationReasons 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": [ "ChainConfig" ] }, "post": { "summary": "Create Block Cancellation Reasons", "description": "Use this API to create Block Cancellation Reasons.OperationId:postBlockCancellationReasons
", "operationId": "postBlockCancellationReasons", "parameters": [ { "name": "blockCancellationReasonsCriteria", "in": "body", "required": true, "description": "Request object for creating Block Cancellation Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/blockCancellationReasonsCriteria" } ] } }, { "$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": [ "ChainConfig" ] } }, "/blockCancellationReasons/{blockCancellationReasonsId}": { "put": { "summary": "Change Block Cancellation Reason", "description": "Use this API to update Block Cancellation Reason.OperationId:putBlockCancellationReasons
", "operationId": "putBlockCancellationReasons", "parameters": [ { "name": "blockCancellationReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Block Cancellation Reasons." }, { "name": "blockCancellationReasonsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Block Cancellation Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/blockCancellationReasonsToBeChanged" } ] } }, { "$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": [ "ChainConfig" ] }, "delete": { "summary": "Delete Block Cancellation Reason", "description": "Use this API to delete Block Cancellation Reason.OperationId:deleteBlockCancellationReasons
", "operationId": "deleteBlockCancellationReasons", "parameters": [ { "name": "blockCancellationReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Block Cancellation Reasons." }, { "name": "blockCancellationReasonsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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" }, "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": [ "ChainConfig" ] } }, "/blockLostBookingCodes": { "get": { "summary": "Get Block Lost Booking Codes", "description": "Use this API to get Block Lost Booking Codes.OperationId:getBlockLostBookingCodes
", "operationId": "getBlockLostBookingCodes", "parameters": [ { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$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 Lost Booking Codes.", "schema": { "$ref": "#/definitions/blockLostBookingCodesDetails" } }, "204": { "description": "BlockLostBookingCodes 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": [ "ChainConfig" ] }, "post": { "summary": "Create Block Lost Booking Codes", "description": "Use this API to create Block Lost Booking Codes.OperationId:postBlockLostBookingCodes
", "operationId": "postBlockLostBookingCodes", "parameters": [ { "name": "blockLostBookingCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Block Lost Booking Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/blockLostBookingCodesCriteria" } ] } }, { "$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": [ "ChainConfig" ] } }, "/blockLostBookingCodes/{blockLostBookingCodesId}": { "put": { "summary": "Change Block Lost Booking Code", "description": "Use this API to update Block Lost Booking Code.OperationId:putBlockLostBookingCodes
", "operationId": "putBlockLostBookingCodes", "parameters": [ { "name": "blockLostBookingCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Block Lost Booking Codes." }, { "name": "blockLostBookingCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Block Lost Booking Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/blockLostBookingCodesToBeChanged" } ] } }, { "$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": [ "ChainConfig" ] }, "delete": { "summary": "Delete Block Lost Booking Code", "description": "Use this API to delete Block Lost Booking Code.OperationId:deleteBlockLostBookingCodes
", "operationId": "deleteBlockLostBookingCodes", "parameters": [ { "name": "blockLostBookingCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Block Lost Booking Codes." }, { "name": "blockLostBookingCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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" }, "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": [ "ChainConfig" ] } }, "/blockRateOverrideReasons": { "get": { "summary": "Get Block Rate Override Reasons", "description": "Use this API to get Block Rate Override Reasons.OperationId:getBlockRateOverrideReasons
", "operationId": "getBlockRateOverrideReasons", "parameters": [ { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$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 Rate Override Reasons.", "schema": { "$ref": "#/definitions/blockRateOverrideReasonsDetails" } }, "204": { "description": "BlockRateOverrideReasons 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": [ "ChainConfig" ] }, "post": { "summary": "Create Block Rate Override Reasons", "description": "Use this API to create Block Rate Override Reasons.OperationId:postBlockRateOverrideReasons
", "operationId": "postBlockRateOverrideReasons", "parameters": [ { "name": "blockRateOverrideReasonsCriteria", "in": "body", "required": true, "description": "Request object for creating Block Rate Override Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/blockRateOverrideReasonsCriteria" } ] } }, { "$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": [ "ChainConfig" ] } }, "/blockRateOverrideReasons/{blockRateOverrideReasonsId}": { "put": { "summary": "Change Block Rate Override Reason", "description": "Use this API to update Block Rate Override Reason.OperationId:putBlockRateOverrideReasons
", "operationId": "putBlockRateOverrideReasons", "parameters": [ { "name": "blockRateOverrideReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Block Rate Override Reasons." }, { "name": "blockRateOverrideReasonsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Block Rate Override Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/blockRateOverrideReasonsToBeChanged" } ] } }, { "$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": [ "ChainConfig" ] }, "delete": { "summary": "Delete Block Rate Override Reason", "description": "Use this API to delete Block Rate Override Reason.OperationId:deleteBlockRateOverrideReasons
", "operationId": "deleteBlockRateOverrideReasons", "parameters": [ { "name": "blockRateOverrideReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Block Rate Override Reasons." }, { "name": "blockRateOverrideReasonsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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" }, "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": [ "ChainConfig" ] } }, "/blockRefusedReasons": { "get": { "summary": "Get Block Refused Reasons", "description": "Use this API to get Block Refused Reasons.OperationId:getBlockRefusedReasons
", "operationId": "getBlockRefusedReasons", "parameters": [ { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$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 Refused Reasons.", "schema": { "$ref": "#/definitions/blockRefusedReasonsDetails" } }, "204": { "description": "BlockRefusedReasons 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": [ "ChainConfig" ] }, "post": { "summary": "Create Block Refused Reasons", "description": "Use this API to create Block Refused Reasons.OperationId:postBlockRefusedReasonspostBlo
", "operationId": "postBlockRefusedReasonspostBlo", "parameters": [ { "name": "blockRefusedReasonsCriteria", "in": "body", "required": true, "description": "Request object for creating Block Refused Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/blockRefusedReasonsCriteria" } ] } }, { "$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": [ "ChainConfig" ] } }, "/blockRefusedReasons/{blockRefusedReasonsId}": { "put": { "summary": "Change Block Refused Reason", "description": "Use this API to update Block Refused Reason.OperationId:putBlockRefusedReasons
", "operationId": "putBlockRefusedReasons", "parameters": [ { "name": "blockRefusedReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Block Refused Reasons." }, { "name": "blockRefusedReasonsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Block Refused Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/blockRefusedReasonsToBeChanged" } ] } }, { "$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": [ "ChainConfig" ] }, "delete": { "summary": "Delete Block Refused Reason", "description": "Use this API to delete Block Refused Reason.OperationId:deleteBlockRefusedReasons
", "operationId": "deleteBlockRefusedReasons", "parameters": [ { "name": "blockRefusedReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Block Refused Reasons." }, { "name": "blockRefusedReasonsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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" }, "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": [ "ChainConfig" ] } }, "/blockStatusCodes": { "get": { "summary": "Get block status codes", "description": "This API fetches a list of configured status codes for the chain. It returns status code, description, and status type such as non-deduct, deduct, cancel, waitlist, inquiry, and actual. Status attributes, such as starting status, function diary visibility, allows pickup, and log catering changes are also returned in the response. Please note, that status codes are configured in a strict sequence that must be followed. In order to find available next statuses for the current block status, please use operation getNextBlockStatusCodes.OperationId:getBlockStatusCodes
", "operationId": "getBlockStatusCodes", "parameters": [ { "name": "blockStatusCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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 status codes.", "schema": { "$ref": "#/definitions/statusCodeDetails" } }, "204": { "description": "BlockStatusCodes 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": [ "BlockConfig" ] }, "post": { "summary": "Create a block status code", "description": "You can use this API to create a new block status code.OperationId:postBlockStatusCode
", "operationId": "postBlockStatusCode", "parameters": [ { "name": "blockStatusCodeDetails", "in": "body", "required": true, "description": "Request object for creating a block status code.", "schema": { "allOf": [ { "$ref": "#/definitions/blockStatusCodeDetails" } ] } }, { "$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": [ "BlockConfig" ] } }, "/blockStatusCodes/nextStatusCodes": { "get": { "summary": "Get next block status codes", "description": "Retrieve the next block Status Codes for a property.OperationId:getNextBlockStatusCodes
", "operationId": "getNextBlockStatusCodes", "parameters": [ { "name": "configuredOnly", "in": "query", "required": false, "description": "When set to true, only configured next status codes will be included (available status list will not be included).", "type": "boolean" }, { "name": "blockStatusCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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 fetch next block status codes.", "schema": { "$ref": "#/definitions/nextBlockStatusCodeDetails" } }, "204": { "description": "NextBlockStatusCodes 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": [ "BlockConfig" ] } }, "/blockStatusCodes/{blockStatusCode}": { "delete": { "summary": "Delete block status code", "description": "You can use this API to delete block status code.OperationId:deleteBlockStatusCode
", "operationId": "deleteBlockStatusCode", "parameters": [ { "name": "blockStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "OPERA Block status code" }, { "$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": "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": [ "BlockConfig" ] }, "put": { "summary": "Change block status code", "description": "You can use this API to change block status code.OperationId:putBlockStatusCode
", "operationId": "putBlockStatusCode", "parameters": [ { "name": "blockStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "OPERA Block status code" }, { "name": "blockStatusCodeDetails", "in": "body", "required": true, "description": "Request object for updating block status code.", "schema": { "allOf": [ { "$ref": "#/definitions/blockStatusCodeDetails" } ] } }, { "$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": [ "BlockConfig" ] } }, "/blockStatusCodes/{srcBlockStatusCode}/nextStatusCodes": { "put": { "summary": "Change next block status codes", "description": "Update the next Block status.OperationId:putNextBlockStatusCodes
", "operationId": "putNextBlockStatusCodes", "parameters": [ { "name": "srcBlockStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "OPERA Block status code" }, { "name": "nextBlockStatusCode", "in": "body", "required": true, "description": "Request object for change block status code flow. Batch insert/update/delete of next status code list of a particular status code.", "schema": { "allOf": [ { "$ref": "#/definitions/nextBlockStatusCode" } ] } }, { "$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": [ "BlockConfig" ] } }, "/destinationCodes": { "get": { "summary": "Get Destination Codes", "description": "Use this API to get Destination Codes.OperationId:getDestinationCodes
", "operationId": "getDestinationCodes", "parameters": [ { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$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 Destination Codes.", "schema": { "$ref": "#/definitions/destinationCodesDetails" } }, "204": { "description": "DestinationCodes 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": [ "ChainConfig" ] }, "post": { "summary": "Create Destination Codes", "description": "This API allows creation on Destination Codes. Destination Codes are used in OPERA Cloud during the block cancellation process, and they usually represent either a competitor hotel / chain, or a geographic destination that a specific block has been lost to.OperationId:postDestinationCodes
", "operationId": "postDestinationCodes", "parameters": [ { "name": "destinationCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Destination Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/destinationCodesCriteria" } ] } }, { "$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": [ "ChainConfig" ] } }, "/destinationCodes/{destinationCodesId}": { "put": { "summary": "Change Destination Codes", "description": "Use this API to update Destination Codes.OperationId:putDestinationCodes
", "operationId": "putDestinationCodes", "parameters": [ { "name": "destinationCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Destination Codes." }, { "name": "destinationCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Destination Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/destinationCodesToBeChanged" } ] } }, { "$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": [ "ChainConfig" ] }, "delete": { "summary": "Delete Destination Codes", "description": "Use this API to delete Destination Codes.OperationId:deleteDestinationCodes
", "operationId": "deleteDestinationCodes", "parameters": [ { "name": "destinationCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Destination Codes." }, { "name": "destinationCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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" }, "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": [ "ChainConfig" ] } }, "/hotels/{hotelId}/blockCutoffScheduleRange": { "put": { "summary": "Set block cutoff schedule range", "description": "You can use this API to set block cutoff schedule range. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:setBlockCutoffScheduleRange
", "operationId": "setBlockCutoffScheduleRange", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Unique OPERA Hotel code" }, { "name": "blockCutoffScheduleRange", "in": "body", "required": true, "description": "Request object to a create block cutoff schedule with date range.", "schema": { "allOf": [ { "$ref": "#/definitions/blockCutoffScheduleRange" } ] } }, { "$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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/blockSalesAllowance": { "get": { "summary": "Get Block Sales Allowance", "description": "You can use this API to get Block Sales Allowance.OperationId:getBlockSalesAllowance
This API allows a time span of 90 days.
", "operationId": "getBlockSalesAllowance", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "endDateRange", "in": "query", "required": false, "description": "The ending value of the date range.", "type": "string", "format": "date" }, { "name": "startDateRange", "in": "query", "required": false, "description": "The starting value of the date range.", "type": "string", "format": "date" }, { "name": "includeRestricted", "in": "query", "required": false, "description": "Indicate to include restricted room types.", "type": "boolean" }, { "name": "roomTypesCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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 FetchBlockSalesAllowance operation which will contain all the information of sales allowance.", "schema": { "$ref": "#/definitions/blockSalesAllowance" } }, "204": { "description": "BlockSalesAllowance 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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/blockSalesAllowance/activityLog": { "get": { "summary": "Get the Block Sales Allowance activity log", "description": "Use this API to facilitate retrieving the Block Sales Allowance activity log.OperationId:getBlockSalesAllowanceActivityLog
", "operationId": "getBlockSalesAllowanceActivityLog", "parameters": [ { "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": "hotelId", "in": "path", "required": true, "description": "Hotel code.", "minLength": 1, "maxLength": 20, "type": "string" }, { "name": "changeLogDate", "in": "query", "required": false, "description": "Search date for the user activity log.", "type": "string", "format": "date" }, { "name": "salesAllowanceDate", "in": "query", "required": false, "description": "Sales Allowance date for the user activity log.", "type": "string", "format": "date" }, { "name": "userId", "in": "query", "type": "integer", "required": false, "description": "User Id for the user activity log." }, { "$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 sales allowance activity log. This object contains collection of user activity log for the block sales allowance changes.", "schema": { "$ref": "#/definitions/blockSalesAllowanceActivityLog" } }, "204": { "description": "Block sales allowance activity log 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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/blockSalesAllowanceRange": { "delete": { "summary": "Delete block sales allowance range", "description": "You can use this API to delete block sales allowance range.OperationId:deleteBlockSalesAllowanceRange
This API allows a time span of 90 days.
", "operationId": "deleteBlockSalesAllowanceRange", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "endDate", "in": "query", "required": true, "description": "The ending value of the date range.", "type": "string", "format": "date" }, { "name": "startDate", "in": "query", "required": true, "description": "The starting value of the date range.", "type": "string", "format": "date" }, { "name": "friday", "in": "query", "required": false, "type": "boolean" }, { "name": "monday", "in": "query", "required": false, "type": "boolean" }, { "name": "saturday", "in": "query", "required": false, "type": "boolean" }, { "name": "sunday", "in": "query", "required": false, "type": "boolean" }, { "name": "thursday", "in": "query", "required": false, "type": "boolean" }, { "name": "tuesday", "in": "query", "required": false, "type": "boolean" }, { "name": "wednesday", "in": "query", "required": false, "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" }, "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": [ "BlockConfig" ] }, "put": { "summary": "Set block sales allowance range", "description": "You can use this API to set block sales allowance range.OperationId:setBlockSalesAllowanceRange
", "operationId": "setBlockSalesAllowanceRange", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "blockSalesAllowanceRange", "in": "body", "required": true, "description": "Operation to a create block sales allowance with date range.", "schema": { "allOf": [ { "$ref": "#/definitions/blockSalesAllowanceRange" } ] } }, { "$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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/cutoffSchedules": { "get": { "summary": "Get block cutoff schedule codes.", "description": "This API fetches a list of configured cutoff schedule codes for the property. It returns cutoff schedule code, description, start date, end date and default cutoff days. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:getCutoffSchedules
The maximum allowable limit for this API is 20.
", "operationId": "getCutoffSchedules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Unique OPERA Hotel code" }, { "name": "cutoffCodes", "in": "query", "type": "array", "maxItems": 40, "collectionFormat": "multi", "description": "Cutoff Schedule Codes to be searched.", "items": { "type": "string" } }, { "name": "cutoffCodeStartDate", "in": "query", "type": "string", "description": "Cutoff Schedule Code start date.", "format": "date" }, { "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" }, { "$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 cutoff schedule codes which will contain all the information of 'CutoffCodes' like code, date range, default days, and description.", "schema": { "$ref": "#/definitions/cutoffScheduleDetails" } }, "204": { "description": "Cutoff Schedule Codes 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": [ "BlockConfig" ] }, "post": { "summary": "Create a block cutoff schedule code.", "description": "You can use this API to create a new block cutoff schedule code. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:postCutoffScheduleCode
", "operationId": "postCutoffScheduleCode", "parameters": [ { "name": "CutoffScheduleCodeDetails", "in": "body", "required": true, "description": "Request object for creating a block cutoff schedule code.", "schema": { "allOf": [ { "$ref": "#/definitions/cutoffCodeCriteria" } ] } }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Unique OPERA Hotel Id" }, { "$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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/cutoffSchedules/{cutoffCodeId}": { "get": { "summary": "Get cutoff Schedules Details for a cutoff schedule code.", "description": "This API fetches a list of cutoff schedule details for a cutoff schedule code. It returns stay date, room type and cutoff days for cutoff schedule. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:getCutoffSchedulesDetails
The maximum allowable limit for this API is 365.
", "operationId": "getCutoffSchedulesDetails", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Unique OPERA Hotel code" }, { "name": "cutoffCodeId", "in": "path", "type": "integer", "description": "Unique cutoff schedule code for which details will be fetched.", "required": true }, { "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" }, { "$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 cutoff code schedule details which will contain stay date, cutoff days, and room type .", "schema": { "$ref": "#/definitions/cutoffScheduleDetails" } }, "204": { "description": "Cutoff Schedule 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": [ "BlockConfig" ] }, "put": { "summary": "Change block cutoff schedule code", "description": "You can use this API to change block cutoff schedule code. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:putCutoffScheduleCode
", "operationId": "putCutoffScheduleCode", "parameters": [ { "name": "cutoffCodeId", "in": "path", "required": true, "type": "integer", "description": "OPERA Block cutoff schedule code Id." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Unique OPERA Hotel Id" }, { "name": "blockCutoffCodeDetails", "in": "body", "required": true, "description": "Request object for updating block cutoff schedule code.", "schema": { "allOf": [ { "$ref": "#/definitions/cutoffCodeCriteria" } ] } }, { "$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": [ "BlockConfig" ] }, "delete": { "summary": "Delete cutoff schedule code.", "description": "You can use this API to delete cutoff schedule code.OperationId:removeCutoffScheduleCode
", "operationId": "deleteCutoffScheduleCode", "parameters": [ { "name": "cutoffCodeId", "in": "path", "required": true, "type": "integer", "description": "Unique Cutoff Schedule Code Id." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Unique OPERA Hotel Code." }, { "$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": "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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/salesManagers": { "get": { "summary": "Get Sales Managers by Hotel.", "description": "You can use this API to retrieve multiple Sales Managers for a hotel, you can narrow the results using different search criteria.OperationId:getSalesManagers
The maximum allowable limit for this API is 20.
", "operationId": "getSalesManagers", "deprecated": true, "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel Id" }, { "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": "ownerCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "firstName", "in": "query", "required": false, "description": "First name required to fetch Sales Manager information.", "type": "string" }, { "name": "lastName", "in": "query", "required": false, "description": "Last name required to fetch Sales Manager information.", "type": "string" }, { "$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": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria", "schema": { "$ref": "#/definitions/salesManagersInfo" } }, "204": { "description": "SalesManagers 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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/salesManagers/searches": { "post": { "summary": "Get Sales Managers by Hotel.", "description": "You can use this API to retrieve multiple Sales Managers for a hotel, you can narrow the results using different search criteria.OperationId:searchSalesManagers
The maximum allowable limit for this API is 20.
", "operationId": "searchSalesManagers", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel Id" }, { "in": "body", "name": "searchSalesManagersRequest", "required": false, "schema": { "$ref": "#/definitions/searchSalesManagersRequest" } }, { "$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": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria", "schema": { "$ref": "#/definitions/salesManagersInfo" } }, "204": { "description": "SalesManagers 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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/salesManagers/{salesManagerId}/salesManagerGoals": { "get": { "summary": "Get Sales Manager Goals by Hotel", "description": "You can use this API to retrieve individual Sales Manager Goals for a hotel, you can narrow the results using different search criteria.OperationId:getSalesManagerGoals
The maximum allowable limit for this API is 20.
", "operationId": "getSalesManagerGoals", "parameters": [ { "name": "salesManagerId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Sales Manager Id required to fetch Sales Manager goals information" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel Id" }, { "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": "future", "in": "query", "required": false, "description": "Use this indicator to fetch goal's having Production From or Arrival From dates later than the current business date or quarter", "type": "boolean" }, { "name": "fetchInstructions", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Fetch instructions that can be used to fetch details of particular Sales Manager type,ex: Group Room, Transient Room, Catering, Activity.", "uniqueItems": true, "items": { "type": "string", "enum": [ "GroupRoomsWithCatering", "TransientRoom", "Activity" ] }, "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 details of Sales Manager Goal.", "schema": { "$ref": "#/definitions/salesManagerGoalsInfo" } }, "204": { "description": "SalesManagerGoals 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": [ "BlockConfig" ] }, "post": { "summary": "Create Sales Manager Goals", "description": "Use this API to Create Sales Manager Goals for a Sales Manager ID.You must know the OPERA Sales Manager ID for this API.OperationId:postSalesManagerGoals
", "operationId": "postSalesManagerGoals", "parameters": [ { "name": "salesManagerId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Sales Manager Id required to fetch Sales Manager goals information" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel Id" }, { "name": "createSalesManagerGoals", "in": "body", "required": true, "description": "Request object for Creating Sales Manager Goal(s).", "schema": { "allOf": [ { "$ref": "#/definitions/createSalesManagerGoals" } ] } }, { "$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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/salesManagers/{salesManagerId}/salesManagerGoals/{salesGoalId}": { "put": { "summary": "Update Sales Manager Goal in a hotel by ID", "description": "Use this API to update Sales Manager Goal.You must know the OPERA Sales Manager ID and Goal ID for this API.OperationId:putSalesManagerGoals
", "operationId": "putSalesManagerGoals", "parameters": [ { "name": "salesGoalId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Sales Goal Id assigned to a Sales Manager." }, { "name": "salesManagerId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Sales Manager Id required to put Sales Manager goals information" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel Id" }, { "name": "salesManagerGoalsInfo", "in": "body", "required": true, "description": "Request object for modifying Sales Manager's goal.", "schema": { "allOf": [ { "$ref": "#/definitions/salesManagerGoalsInfo" } ] } }, { "$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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/washSchedules": { "post": { "summary": "Create block wash schedule", "description": "Create a block wash schedule.OperationId:postWashSchedule
", "operationId": "postWashSchedule", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "washScheduleCriteria", "in": "body", "required": true, "description": "Operation to create new Wash Schedule Configuration under the selected property.", "schema": { "allOf": [ { "$ref": "#/definitions/washScheduleCriteria" } ] } }, { "$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": [ "BlockConfig" ] } }, "/hotels/{hotelId}/washSchedules/{washScheduleCode}": { "delete": { "summary": "Delete block wash schedule", "description": "Delete a block wash schedule.OperationId:deleteWashSchedule
", "operationId": "deleteWashSchedule", "parameters": [ { "name": "washScheduleCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Block Wash Code" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "$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": "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": [ "BlockConfig" ] }, "put": { "summary": "Change block wash schedule", "description": "Change a block wash schedule.OperationId:putWashSchedule
", "operationId": "putWashSchedule", "parameters": [ { "name": "washScheduleCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Block Wash Code" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "washScheduleCriteria", "in": "body", "required": true, "description": "Operation to change existing Wash Schedule Configuration.", "schema": { "allOf": [ { "$ref": "#/definitions/washScheduleCriteria" } ] } }, { "$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": [ "BlockConfig" ] } }, "/reservationMethods": { "get": { "summary": "Get Reservation Methods", "description": "Use this API to get Reservation Methods.OperationId:getReservationMethods
", "operationId": "getReservationMethods", "parameters": [ { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$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 Reservation Methods.", "schema": { "$ref": "#/definitions/reservationMethodsDetails" } }, "204": { "description": "ReservationMethods 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": [ "ChainConfig" ] }, "post": { "summary": "Create Reservation Methods", "description": "Use this API to create Reservation Methods.OperationId:postReservationMethods
", "operationId": "postReservationMethods", "parameters": [ { "name": "reservationMethodsCriteria", "in": "body", "required": true, "description": "Request object for creating Reservation Methods.", "schema": { "allOf": [ { "$ref": "#/definitions/reservationMethodsCriteria" } ] } }, { "$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": [ "ChainConfig" ] } }, "/reservationMethods/{reservationMethodsId}": { "put": { "summary": "Change Reservation Methods", "description": "Use this API to update Reservation Methods.OperationId:putReservationMethods
", "operationId": "putReservationMethods", "parameters": [ { "name": "reservationMethodsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Reservation Methods." }, { "name": "reservationMethodsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Reservation Methods.", "schema": { "allOf": [ { "$ref": "#/definitions/reservationMethodsToBeChanged" } ] } }, { "$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": [ "ChainConfig" ] }, "delete": { "summary": "Delete Reservation Methods", "description": "Use this API to delete Reservation Methods.OperationId:deleteReservationMethods
", "operationId": "deleteReservationMethods", "parameters": [ { "name": "reservationMethodsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Reservation Methods." }, { "name": "reservationMethodsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "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" }, "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": [ "ChainConfig" ] } }, "/salesManagers": { "get": { "summary": "Get Sales Managers.", "description": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria.OperationId:getSalesManagersMultipleHotelIds
The maximum allowable limit for this API is 20.
", "operationId": "getSalesManagersMultipleHotelIds", "deprecated": true, "parameters": [ { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": true }, { "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": "ownerCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "firstName", "in": "query", "required": false, "description": "First name required to fetch Sales Manager information.", "type": "string" }, { "name": "lastName", "in": "query", "required": false, "description": "Last name required to fetch Sales Manager information.", "type": "string" }, { "$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": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria", "schema": { "$ref": "#/definitions/salesManagersInfo" } }, "204": { "description": "SalesManagersMultipleHotelIds 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": [ "BlockConfig" ] } }, "/salesManagers/searches": { "post": { "summary": "Get Sales Managers.", "description": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria.OperationId:searchSalesManagersMultipleHotelIds
The maximum allowable limit for this API is 20.
", "operationId": "searchSalesManagersMultipleHotelIds", "parameters": [ { "in": "body", "name": "searchSalesManagersMultipleHotelIdsRequest", "required": false, "schema": { "$ref": "#/definitions/searchSalesManagersMultipleHotelIdsRequest" } }, { "$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": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria", "schema": { "$ref": "#/definitions/salesManagersInfo" } }, "204": { "description": "SalesManagersMultipleHotelIds 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": [ "BlockConfig" ] } }, "/salesManagers/{salesManagerId}/salesManagerGoals": { "delete": { "summary": "Delete Sale Manager Goals", "description": "Use this API to delete Sales Manager Goals.OperationId:removeSalesManagerGoals
", "operationId": "removeSalesManagerGoals", "parameters": [ { "name": "salesManagerId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Sales Managers Id" }, { "name": "salesGoalId", "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 }, { "$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": "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": [ "BlockConfig" ] }, "get": { "summary": "Get Sales Manager Goals", "description": "You can use this API to retrieve individual Sales Manager Goals, you can narrow the results using different search criteria.OperationId:getSalesManagerGoalsMultipleHotelIds
The maximum allowable limit for this API is 20.
", "operationId": "getSalesManagerGoalsMultipleHotelIds", "parameters": [ { "name": "salesManagerId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Sales Manager Id required to fetch Sales Manager goals information" }, { "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": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "future", "in": "query", "required": false, "description": "Use this indicator to fetch goal's having Production From or Arrival From dates later than the current business date or quarter", "type": "boolean" }, { "name": "fetchInstructions", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Fetch instructions that can be used to fetch details of particular Sales Manager type,ex: Group Room, Transient Room, Catering, Activity.", "uniqueItems": true, "items": { "type": "string", "enum": [ "GroupRoomsWithCatering", "TransientRoom", "Activity" ] }, "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 details of Sales Manager Goal.", "schema": { "$ref": "#/definitions/salesManagerGoalsInfo" } }, "204": { "description": "SalesManagerGoalsMultipleHotelIds 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": [ "BlockConfig" ] } }, "/salesManagers/{salesManagerId}/salesManagerGoals/{salesGoalId}": { "delete": { "summary": "Delete Sale Manager Goal", "description": "Use this API to delete Sales Manager Goal.OperationId:removeSalesManagerGoal
", "operationId": "removeSalesManagerGoal", "parameters": [ { "name": "salesGoalId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Sales Goal Id assigned to a Sales Manager." }, { "name": "salesManagerId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Sales Managers Id" }, { "$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": "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": [ "BlockConfig" ] } }, "/services/block/status": { "get": { "summary": " ping", "description": "Ping Block Configuration ServiceOperationId:pingBlockConfigService
", "operationId": "pingBlockConfigService", "parameters": [ { "$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 for Ping operation.", "schema": { "$ref": "#/definitions/operaVersion" } }, "204": { "description": "pingBlockConfigService 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": [ "BlockConfig" ] } }, "/services/chainConfig/status": { "get": { "summary": " ping", "description": "NAOperationId:pingChainConfigServices
", "operationId": "pingChainConfigServices", "parameters": [ { "$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 for Ping operation.", "schema": { "$ref": "#/definitions/operaVersion" } }, "204": { "description": "pingChainConfigServices 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": [ "ChainConfig" ] } }, "/upsert/hotels/{hotelId}/washSchedules/{washScheduleCode}": { "put": { "summary": "Create/Change block wash schedule", "description": "Create/Change a block wash schedule.OperationId:putUpsertWashSchedule
", "operationId": "putUpsertWashSchedule", "parameters": [ { "name": "washScheduleCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Block Wash Code" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "washScheduleCriteria", "in": "body", "required": true, "description": "Operation to change existing Wash Schedule Configuration.", "schema": { "allOf": [ { "$ref": "#/definitions/washScheduleCriteria" } ] } }, { "$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": [ "BlockConfig" ] } }, "/washSchedules": { "get": { "summary": "Get block wash schedule", "description": "Get block wash schedules.OperationId:getWashSchedule
", "operationId": "getWashSchedule", "parameters": [ { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "washCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "$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 FetchWashSchedule operation which will contain all the information of 'WashCodes' like Days prior to arrival, Occupancy detail, Sell limit and Wash by percent value if exists.", "schema": { "$ref": "#/definitions/washScheduleDetails" } }, "204": { "description": "WashSchedule 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": [ "BlockConfig" ] } } }, "parameters": { "externalData": { "name": "externalData", "type": "string", "description": "Pass this header as true, if payload needs DVM", "in": "header" }, "authKey": { "name": "authorization", "description": "Bearer token that needs to be passed which is generated post user authentication", "type": "string", "in": "header", "required": true }, "x-app-key": { "name": "x-app-key", "description": "Client or Partner's Application Key", "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}$", "in": "header", "required": true }, "x-request-id": { "name": "x-request-id", "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}", "description": "Request Id of an incoming request", "in": "header" }, "x-originating-application": { "name": "x-originating-application", "type": "string", "description": "Customer's Integration Application Id", "in": "header" }, "x-hotelid": { "name": "x-hotelid", "type": "string", "description": "Mandatory parameter to identify the hotel code where the end user is logged in", "in": "header", "required": true }, "x-externalsystem": { "name": "x-externalsystem", "type": "string", "maxLength": 40, "description": "External system code.", "in": "header", "x-example": "EXTERNALSYSTEMCODE" }, "Accept-Language": { "name": "Accept-Language", "type": "string", "description": "Language code", "in": "header" }, "x-hubid": { "name": "x-hubid", "type": "string", "description": "x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid", "in": "header" } }, "responses": { "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "405": { "description": "Method not allowed" }, "406": { "description": "Not acceptable." }, "413": { "description": "Request Entity Too Large" }, "414": { "description": "Request URI Too Large" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "System Error", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "definitions": { "blockCancellationReasonsDetails": { "type": "object", "description": "Response object for fetching Block Cancellation Reasons.", "properties": { "blockCancellationReasons": { "description": "Collection of Block Cancellation Reasons.", "$ref": "#/definitions/blockCancellationReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockCancellationReasonsType": { "type": "array", "description": "List of Block Cancellation Reasons.", "maxItems": 4000, "items": { "$ref": "#/definitions/blockCancellationReasonType" } }, "blockCancellationReasonType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Indicates whether the Block Cancellation Reason is inactive or not, returns TRUE when inactive", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "translationTextType2000": { "type": "object", "description": "Contains Multiple translated texts and language codes.", "properties": { "defaultText": { "description": "Default text with Character length from 0 to 2000.", "type": "string", "minLength": 0, "maxLength": 2000 }, "translatedTexts": { "description": "List of translated text and language codes.", "$ref": "#/definitions/translationsTextType" } } }, "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." } }, "links": { "type": "array", "items": { "$ref": "#/definitions/instanceLink" } }, "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" } } }, "warningsType": { "type": "array", "description": "Used in conjunction with the Success element to define a business error.", "maxItems": 4000, "items": { "$ref": "#/definitions/warningType" } }, "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": "#/definitions/errorInstance" } }, "links": { "$ref": "#/definitions/links" } }, "required": [ "type", "title" ] }, "errorInstance": { "title": "Error Instance Details", "description": "Complex type that contains error instance details for a REST call.", "type": "object", "properties": { "type": { "type": "string", "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." }, "title": { "type": "string", "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, "detail": { "type": "string", "description": "Human-readable description specific to this occurrence of the problem." }, "instance": { "type": "string", "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, "o:errorCode": { "type": "string", "description": "Application error code, which is different from HTTP error code." }, "o:errorPath": { "type": "string", "description": "Path to the problem at the resource or property level." } }, "required": [ "type", "title" ] }, "blockCancellationReasonsCriteria": { "type": "object", "description": "Request object for creating Block Cancellation Reasons.", "properties": { "blockCancellationReasons": { "description": "Block Cancellation Reasons to be created.", "$ref": "#/definitions/blockCancellationReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "status": { "type": "object", "description": "Response Body.", "properties": { "warnings": { "$ref": "#/definitions/warningsType" }, "links": { "$ref": "#/definitions/links" } } }, "blockCancellationReasonsToBeChanged": { "type": "object", "description": "Request object for changing Block Cancellation Reasons.", "properties": { "blockCancellationReasons": { "description": "Block Cancellation Reasons to be changed.", "$ref": "#/definitions/blockCancellationReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockLostBookingCodesDetails": { "type": "object", "description": "Response object for fetching Block Lost Booking Codes.", "properties": { "blockLostBookingCodes": { "description": "Collection of Block Lost Booking Codes.", "$ref": "#/definitions/blockLostBookingCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockLostBookingCodesType": { "type": "array", "description": "List of Block Lost Booking Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/blockLostBookingCodeType" } }, "blockLostBookingCodeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Indicates whether the Block Lost Reason is inactive or not, returns TRUE when inactive", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "blockLostBookingCodesCriteria": { "type": "object", "description": "Request object for creating Block Lost Booking Codes.", "properties": { "blockLostBookingCodes": { "description": "Block Lost Booking Codes to be created.", "$ref": "#/definitions/blockLostBookingCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockLostBookingCodesToBeChanged": { "type": "object", "description": "Request object for changing Block Lost Booking Codes.", "properties": { "blockLostBookingCodes": { "description": "Block Lost Booking Codes to be changed.", "$ref": "#/definitions/blockLostBookingCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRateOverrideReasonsDetails": { "type": "object", "description": "Response object for fetching Block Rate Override Reasons.", "properties": { "blockRateOverrideReasons": { "description": "Collection of Block Rate Override Reasons.", "$ref": "#/definitions/blockRateOverrideReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRateOverrideReasonsType": { "type": "array", "description": "List of Block Rate Override Reasons.", "maxItems": 4000, "items": { "$ref": "#/definitions/blockRateOverrideReasonType" } }, "blockRateOverrideReasonType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "blockRateOverrideReasonsCriteria": { "type": "object", "description": "Request object for creating Block Rate Override Reasons.", "properties": { "blockRateOverrideReasons": { "description": "Block Rate Override Reasons to be created.", "$ref": "#/definitions/blockRateOverrideReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRateOverrideReasonsToBeChanged": { "type": "object", "description": "Request object for changing Block Rate Override Reasons.", "properties": { "blockRateOverrideReasons": { "description": "Block Rate Override Reasons to be changed.", "$ref": "#/definitions/blockRateOverrideReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRefusedReasonsDetails": { "type": "object", "description": "Response object for fetching Block Refused Reasons.", "properties": { "blockRefusedReasons": { "description": "Collection of Block Refused Reasons.", "$ref": "#/definitions/blockRefusedReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRefusedReasonsType": { "type": "array", "description": "List of Block Refused Reasons.", "maxItems": 4000, "items": { "$ref": "#/definitions/blockRefusedReasonType" } }, "blockRefusedReasonType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Indicates whether the Block Refused Reason is inactive or not, returns TRUE when inactive", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "blockRefusedReasonsCriteria": { "type": "object", "description": "Request object for creating Block Refused Reasons.", "properties": { "blockRefusedReasons": { "description": "Block Refused Reasons to be created.", "$ref": "#/definitions/blockRefusedReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRefusedReasonsToBeChanged": { "type": "object", "description": "Request object for changing Block Refused Reasons.", "properties": { "blockRefusedReasons": { "description": "Block Refused Reasons to be changed.", "$ref": "#/definitions/blockRefusedReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "statusCodeDetails": { "type": "object", "description": "Response object for fetching block status codes.", "properties": { "blockStatusCodes": { "description": "Collection of configured Block Status Codes.", "$ref": "#/definitions/blockStatusCodeListType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockStatusCodeListType": { "type": "array", "description": "Block status code information.", "maxItems": 4000, "items": { "$ref": "#/definitions/blockStatusCodeType" } }, "blockStatusCodeType": { "type": "object", "description": "Block status code information.", "properties": { "status": { "description": "Code and Description used to define a status e.g. (INT, TENT, DEF, CXL) (initial, tentative, definite, cancelled).", "$ref": "#/definitions/codeDescriptionType" }, "roomStatusType": { "description": "Room status type selected for status code.", "$ref": "#/definitions/blockStatusCodeStatusType" }, "cateringStatusType": { "description": "Catering status type selected for status code. When the OPS Sales & Catering license code is active, the Sales & Catering status type for the status code is displayed.", "$ref": "#/definitions/blockStatusCodeStatusType" }, "defaultReservationType": { "description": "Default reservation type to be used for the status code. The reservation type and status code must have the same deduct/no deduct status.", "$ref": "#/definitions/codeDescriptionType" }, "reasonType": { "description": "Reason type for every block reservation cancellation. Block Cancellation Reason, Block Refused Reasons, and Block Lost Reasons.", "type": "string" }, "color": { "description": "Color code for the status code.", "$ref": "#/definitions/statusColorType" }, "allowPickup": { "description": "Indicates if the rooms with this status code will be allowed for pickup or not.", "type": "boolean" }, "returnToInventory": { "description": "Indicates if the rooms with this status code can be returned to availability or not.", "type": "boolean" }, "starting": { "description": "Indicates if the status code is the starting status of the status cycle or not.", "type": "boolean" }, "leadStatus": { "description": "Indicates the default status for all new leads. Only one lead status can be selected as the default.", "type": "boolean" }, "logCatering": { "description": "Indicates if the status code logs the catering changes or not.", "type": "boolean" }, "showDiary": { "description": "Indicates if the function diary will be shown within the Sales and Catering.", "type": "boolean" }, "orderBy": { "description": "Indicates the order the status code is displayed in the status cycle.", "type": "integer" }, "inUse": { "description": "Returns true if the status code is already used in Block / Event / Status Flow.", "type": "boolean" }, "cateringInUse": { "description": "Returns true if the status code is already used in Events.", "type": "boolean" }, "opportunity": { "description": "Indicates that the business block created with this Status is an Opportunity.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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 } } }, "blockStatusCodeStatusType": { "type": "string", "description": "Simple type for block status code's room status type and catering status type. Valid status values are Waitlist,Cancel,Lost,Refused,Actual,Inquiry,NonDeductInv,DeductInv and Referral.", "enum": [ "Waitlist", "Cancel", "Lost", "Refused", "Actual", "Inquiry", "NonDeductInv", "DeductInv", "Referral" ] }, "statusColorType": { "type": "string", "description": "Status code color configuration type.", "enum": [ "White", "Red", "Blue", "Cyan", "Magenta", "Green", "Brown", "Black", "Yellow", "Gray" ] }, "blockStatusCodeDetails": { "type": "object", "description": "Request object for updating block status code.", "properties": { "blockStatusCode": { "description": "Block status code information to be applied.", "$ref": "#/definitions/blockStatusCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "nextBlockStatusCodeDetails": { "type": "object", "description": "Response object for fetching next block status codes.", "properties": { "nextBlockStatusCodeList": { "description": "List of block status code flow which compose of a particular status code and its selected next statuses. Moreover, available next status can be not included if ConfigureOnly is set to true.", "$ref": "#/definitions/nextBlockStatusCodeListType" }, "blockStatusCodeMasterList": { "description": "Block status code information e.g. Color, Description, etc.", "$ref": "#/definitions/blockStatusCodeListType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "nextBlockStatusCodeListType": { "type": "array", "description": "Block status code with its next configured and/or available status codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/nextBlockStatusCodeType" } }, "nextBlockStatusCodeType": { "type": "object", "description": "Next block status codes information. Contains list of all configured and/or available next status codes for a particular status code.", "properties": { "nextConfiguredStatusList": { "description": "List of all configured next status codes for the main status code.", "$ref": "#/definitions/nextBlockStatusCodeInfoListType" }, "nextAvailableStatusList": { "description": "List of all available next status codes for the main status code.", "$ref": "#/definitions/nextBlockStatusCodeInfoListType" }, "status": { "description": "Main block status code.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "nextBlockStatusCodeInfoListType": { "type": "array", "description": "List of all configured next status codes for the main status code.", "maxItems": 4000, "items": { "$ref": "#/definitions/nextBlockStatusCodeInfoType" } }, "nextBlockStatusCodeInfoType": { "type": "object", "description": "Information of next block status code.", "properties": { "status": { "description": "Next block status code.", "type": "string", "minLength": 0, "maxLength": 20 }, "order": { "description": "Order of next block status code", "type": "integer" } } }, "nextBlockStatusCode": { "type": "object", "description": "Request object for change block status code flow. Batch insert/update/delete of next status code list of a particular status code.", "properties": { "nextBlockStatusCodeList": { "description": "Contains list of all available next status codes for a particular status code.", "$ref": "#/definitions/nextBlockStatusCodeListType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "destinationCodesDetails": { "type": "object", "description": "Response object for fetching Destination Codes.", "properties": { "destinationCodes": { "description": "Collection of Destination Codes.", "$ref": "#/definitions/destinationCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "destinationCodesType": { "type": "array", "description": "List of Destination Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/destinationCodeType" } }, "destinationCodeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "destinationCodesCriteria": { "type": "object", "description": "Request object for creating Destination Codes.", "properties": { "destinationCodes": { "description": "Destination Codes to be created.", "$ref": "#/definitions/destinationCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "destinationCodesToBeChanged": { "type": "object", "description": "Request object for changing Destination Codes.", "properties": { "destinationCodes": { "description": "Destination Codes to be changed.", "$ref": "#/definitions/destinationCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockSalesAllowance": { "type": "object", "description": "Response object for FetchBlockSalesAllowance operation which will contain all the information of sales allowance.", "properties": { "salesAllowances": { "description": "Collection of Block Sales Allowance fetched.", "$ref": "#/definitions/blockSalesAllowanceListType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockSalesAllowanceListType": { "type": "array", "description": "Block's sales allowance information.", "maxItems": 4000, "items": { "$ref": "#/definitions/blockSalesAllowanceType" } }, "blockSalesAllowanceType": { "type": "object", "description": "Contains single entry information for Block's Sales Allowance.", "properties": { "hotelId": { "description": "Contains Hotel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "salesAllowanceDate": { "description": "Contains sales allowance date.", "type": "string", "format": "date", "maxLength": 8 }, "roomType": { "description": "Contains room type.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomPool": { "description": "Contains room pool code.", "type": "string", "minLength": 0, "maxLength": 20 }, "allowance": { "description": "Contains allocated number of rooms for allowance.", "type": "integer" }, "booked": { "description": "Contains number of rooms are booked/consumed from sales allowance.", "type": "integer" }, "overBooked": { "description": "Contains number of rooms are overbooked from sales allowance.", "type": "integer" }, "cutoffDate": { "description": "Contains cutoff date for sales allowance.", "type": "string", "format": "date", "maxLength": 8 } } }, "blockSalesAllowanceRange": { "type": "object", "description": "Operation to a create block sales allowance with date range.", "properties": { "criteria": { "description": "Criteria to fetch block sales allowance.", "$ref": "#/definitions/blockSalesAllowanceRangeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockSalesAllowanceRangeType": { "type": "object", "description": "Indicates the block sales allowance for a date range.", "properties": { "hotelId": { "description": "Contains Hotel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "quantity": { "description": "Contains quantity for sales allowance.", "type": "integer" }, "cutoffDays": { "description": "Number of days before sales allowance date, after which unused quantity should set to 0.", "type": "integer" }, "incrementFlag": { "description": "Flag to indicate if the sales allowance update is absolute or relative to the current value.", "type": "boolean" }, "overwriteExistingSalesAllowance": { "description": "Flag to indicate if the sales allowance already exists for criteria then overwrite the records.", "type": "boolean" }, "start": { "description": "The starting value of the date range.", "type": "string", "format": "date", "maxLength": 8 }, "end": { "description": "The ending value of the date range.", "type": "string", "format": "date", "maxLength": 8 }, "sunday": { "type": "boolean" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "validateExistingSalesAllowance": { "description": "Flag to validate existing sales allowance records within criteria.", "type": "boolean" } } }, "salesManagersInfo": { "type": "object", "description": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria", "properties": { "salesManagers": { "description": "Collection of Sales Managers information.", "$ref": "#/definitions/salesManagersType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "salesManagersType": { "type": "object", "description": "Collection of Sales Managers information.", "properties": { "salesManager": { "description": "Sales Manager's information.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/salesManagerType" } }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, "offset": { "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, "limit": { "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "salesManagerType": { "type": "object", "description": "Sales Manager's information.", "properties": { "hotelId": { "description": "Hotel Code of the Sales Manager", "type": "string", "minLength": 0, "maxLength": 20 }, "nameId": { "description": "Unique Name ID for the Sales Manager", "$ref": "#/definitions/uniqueID_Type" }, "salesManagerCode": { "description": "Sales Manager's code", "type": "string", "minLength": 0, "maxLength": 20 }, "name": { "description": "Sales Manager's name", "type": "string" }, "groupRoomWithCatering": { "description": "Indicates if the Sales manager has Group Room with Catering Goal", "type": "boolean" }, "transientRoom": { "description": "Indicates if the Sales manager has Transient Room Goal", "type": "boolean" }, "activity": { "description": "Indicates if the Sales manager has Activity Goal", "type": "boolean" } } }, "uniqueID_Type": { "type": "object", "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).", "properties": { "id": { "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", "type": "string", "minLength": 0, "maxLength": 80 }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "salesManagerGoalsInfo": { "type": "object", "description": "You can use this API to retrieve individual Sales Manager Goals for a hotel, you can narrow the results using different search criteria", "properties": { "salesManagerGoals": { "description": "Collection of Sales Manager Goals information.", "$ref": "#/definitions/salesManagerGoalsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "salesManagerGoalsType": { "type": "array", "description": "Detail Information about Sales Manager's goal.", "maxItems": 4000, "items": { "$ref": "#/definitions/salesManagerGoalType" } }, "salesManagerGoalType": { "type": "object", "description": "Detail Information about Sales Manager's goal.", "properties": { "hotelId": { "description": "Hotel Code of the Sales Manager", "type": "string", "minLength": 0, "maxLength": 20 }, "nameId": { "description": "Unique Name ID for the Sales Manager", "$ref": "#/definitions/uniqueID_Type" }, "goalID": { "description": "Unique Goal ID for the Sales Manager", "$ref": "#/definitions/uniqueID_Type" }, "goalType": { "description": "Specifies the Goal Type", "type": "string" }, "arrivalGoal": { "description": "Specifies if this is a Arrival or a Production Goal", "type": "boolean" }, "productionStartDate": { "description": "Specifies the Production Start Date", "type": "string", "format": "date", "maxLength": 8 }, "productionEndDate": { "description": "Specifies the Production End Date", "type": "string", "format": "date", "maxLength": 8 }, "productionPeriodCode": { "description": "Specifies the Production Period Code", "type": "string" }, "arrivalStartDate": { "description": "Specifies the Arrival Start Date", "type": "string", "format": "date", "maxLength": 8 }, "arrivalEndDate": { "description": "Specifies the Arrival End Date", "type": "string", "format": "date", "maxLength": 8 }, "arrivalPeriodCode": { "description": "Specifies the Arrival Period Code", "type": "string" }, "marketCode": { "description": "Market Code assigned for the goal", "type": "string" }, "roomNights": { "description": "Room Nights assigned for the goal", "type": "integer" }, "roomRevenue": { "description": "Room Revenue assigned for the Goal", "$ref": "#/definitions/currencyAmountType" }, "averageRate": { "description": "Average Rate assigned for the Goal", "$ref": "#/definitions/currencyAmountType" }, "cateringCovers": { "description": "Number of meals or covers assigned for the Goal", "type": "integer" }, "fBRevenue": { "description": "Food and Beverage revenue assigned for the Goal", "$ref": "#/definitions/currencyAmountType" }, "averageFBCheck": { "description": "Average Food and Beverage check assigned for the Goal", "$ref": "#/definitions/currencyAmountType" }, "otherRevenue": { "description": "Other revenue assigned for the Goal", "$ref": "#/definitions/currencyAmountType" }, "activityType": { "description": "Specifies the type of activity being set as a goal", "type": "string" }, "activitiesCount": { "description": "Specifies the number of activities of Activity Type being set as a goal", "type": "integer" }, "groupRoomsWithCatering": { "description": "Goal type used to fetch goals related to Group Rooms and Catering business", "type": "boolean" }, "transientRoom": { "description": "Goal type used to fetch non group goals related to Rooms business", "type": "boolean" }, "activity": { "description": "Indicates if the Sales manager has Activity Goal", "type": "boolean" }, "future": { "description": "Use this indicator to fetch goal's having Production From or Arrival From dates later than the current business date or quarter", "type": "boolean" } } }, "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 } } }, "createSalesManagerGoals": { "type": "object", "description": "Request object for Creating Sales Manager Goal(s).", "properties": { "salesManagerGoals": { "description": "Collection of Sales Manager Goals information which should be created.", "$ref": "#/definitions/salesManagerGoalsType" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "washScheduleCriteria": { "type": "object", "description": "Operation to create new Wash Schedule Configuration under the selected property.", "properties": { "washCodes": { "description": "Wash Schedule Configuration to be created.", "$ref": "#/definitions/washCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "washCodesType": { "type": "array", "description": "Wash Code, which will allow the user to define standard schedules that can be attached to blocks prior to the block's cutoff date to automate this process.", "maxItems": 4000, "items": { "$ref": "#/definitions/washCodeType" } }, "washCodeType": { "type": "object", "description": "A representation of the information contained by a Wash Code.", "properties": { "description": { "description": "Description of the Wash Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "washCodeDetails": { "description": "Detail information of the Wash Code. It will contain number of rooms to be washed which is linked to a block by a Percentage or Specific number of rooms.", "$ref": "#/definitions/washCodeDetailsType" }, "hotelId": { "description": "Hotel Code to which the Wash Code belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Wash Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "washCodeDetailsType": { "type": "array", "description": "Wash Code Detail for a single entry.", "maxItems": 4000, "items": { "$ref": "#/definitions/washCodeDetailType" } }, "washCodeDetailType": { "type": "object", "description": "Allows for a choice to populate the detail information based on the choice between 'Wash by number of rooms' and 'Wash by %'.", "properties": { "washByRoom": { "$ref": "#/definitions/washByRoomType" }, "washByPercent": { "type": "integer" }, "daysPriorToArrival": { "description": "Number of days prior to arrival of a block or block's cutoff day.", "type": "integer" } } }, "washByRoomType": { "type": "object", "description": "A representation of the single entry information for 'Wash by number of rooms' type.", "properties": { "occupancy1": { "description": "Contains the number of 'Occupancy1'. Based on the parameter it should be replaced by the number of 'Rooms'.", "type": "integer" }, "occupancy2": { "description": "Contains the number of 'Occupancy2'.", "type": "integer" }, "occupancy3": { "description": "Contains the number of 'Occupancy3'.", "type": "integer" }, "occupancy4": { "description": "Contains the number of 'Occupancy4'.", "type": "integer" }, "sell": { "description": "Contains the available Sell Limit rooms for a Sell Limit block.", "type": "integer" } } }, "reservationMethodsDetails": { "type": "object", "description": "Response object for fetching Reservation Methods.", "properties": { "reservationMethods": { "description": "Collection of Reservation Methods.", "$ref": "#/definitions/reservationMethodsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "reservationMethodsType": { "type": "array", "description": "List of Reservation Methods.", "maxItems": 4000, "items": { "$ref": "#/definitions/reservationMethodType" } }, "reservationMethodType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "reservationMethodsCriteria": { "type": "object", "description": "Request object for creating Reservation Methods.", "properties": { "reservationMethods": { "description": "Reservation Methods to be created.", "$ref": "#/definitions/reservationMethodsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "reservationMethodsToBeChanged": { "type": "object", "description": "Request object for changing Reservation Methods.", "properties": { "reservationMethods": { "description": "Reservation Methods to be changed.", "$ref": "#/definitions/reservationMethodsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "washScheduleDetails": { "type": "object", "description": "Response object for FetchWashSchedule operation which will contain all the information of 'WashCodes' like Days prior to arrival, Occupancy detail, Sell limit and Wash by percent value if exists.", "properties": { "washCodes": { "description": "Collection of Block Wash Schedule fetched.", "$ref": "#/definitions/washCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cutoffCodeDetail": { "type": "object", "description": "A representation of the single entry information for cutoff schedule detail.", "properties": { "id": { "description": "Cutoff Schedule detail Id.", "type": "integer" }, "stayDate": { "description": "Contains stay date.", "type": "string", "format": "date", "maxLength": 8 }, "cutoffDays": { "description": "Contains the number of cutoff Days to be set for specific date and room type.", "type": "integer" }, "roomType": { "description": "Contains the room types.", "type": "string" } } }, "blockCutoffScheduleRange": { "type": "object", "description": "Operation to a create block cutoff schedule details by providing date range, room type, days of week and cutoff days.", "properties": { "criteria": { "description": "Criteria to create block cutoff schedule.", "$ref": "#/definitions/blockCutoffScheduleRangeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cutoffScheduleDetails": { "type": "object", "description": "Object which will contain all the information of 'CutoffCodes'. ", "properties": { "cutoffCodes": { "type": "array", "description": "Cutoff Code, which will allow the user to define standard cutoff schedules. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.", "maxItems": 4000, "items": { "$ref": "#/definitions/cutoffCodeType" } }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, "offset": { "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, "limit": { "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cutoffCodeCriteria": { "type": "object", "description": "Object which will contain all the information of 'CutoffCodes'. ", "properties": { "cutoffCodes": { "type": "array", "description": "Cutoff Code, which will allow the user to define standard cutoff schedules. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.", "maxItems": 4000, "items": { "$ref": "#/definitions/cutoffCodeType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cutoffCodeType": { "type": "object", "description": "A representation of the information contained by a Cutoff Code.", "properties": { "cutoffCodeDetails": { "type": "array", "description": "Detail information of the Cutoff Code.", "maxItems": 4000, "items": { "$ref": "#/definitions/cutoffCodeDetailType" } }, "hotelCode": { "description": "Hotel Code to which the cutoff Code belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Unique Cutoff Schedule Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "id": { "description": "Unique Cutoff Schedule Code Id", "type": "integer" }, "description": { "description": "Description of the Cutoff Schedule Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "cutoffCodeStartDate": { "type": "string", "description": "Cutoff Schedule Code Start Date.", "format": "date" }, "cutoffCodeEndDate": { "type": "string", "description": "Cutoff Schedule Code End Date.", "format": "date" }, "defaultDays": { "description": "Cutoff Schedule Code Default Days. This value will be used if no pre defined schedule exist for a date or room type.", "type": "integer" } } }, "cutoffCodeDetailType": { "type": "object", "description": "Cutoff Code Detail for a single entry", "properties": { "cutoffCodeDetail": { "$ref": "#/definitions/cutoffCodeDetail" } } }, "blockCutoffScheduleRangeType": { "type": "object", "description": "Object to create block cutoff schedule details by providing date range, room type, days of week and cutoff days.", "properties": { "hotelId": { "description": "Contains Hotel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "cutoffCodeId": { "description": "Contains Cutoff Schedule Code Id.", "type": "integer" }, "roomTypes": { "description": "Contains Room Types.", "type": "array", "maxItems": 20, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "cutoffDays": { "description": "Number of cutoff Days.", "type": "integer" }, "overwriteExistingcutoffschedule": { "description": "Flag to indicate if the cutoff schedule already exists for criteria then overwrite the records.", "type": "boolean" }, "stayDateFrom": { "description": "The starting value of the date range.", "type": "string", "format": "date" }, "stayDateTo": { "description": "The ending value of the date range.", "type": "string", "format": "date" }, "sunday": { "type": "boolean" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" } } }, "managedByOptions": { "description": "Describes of the Configuration is Managed by Enterprise or Property.", "type": "string", "enum": [ "EnterpriseManaged", "PropertyManaged", "EnterpriseEnforced", "PropertyOverridden" ] }, "blockSalesAllowanceActivityLogListType": { "type": "object", "properties": { "activityLog": { "type": "array", "maxItems": 200, "items": { "$ref": "#/definitions/blockSalesAllowanceActivityLogType" } }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, "offset": { "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, "limit": { "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "blockSalesAllowanceActivityLogType": { "type": "object", "properties": { "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "logDate": { "type": "string", "format": "date-time", "description": "Date on which change happened." }, "salesAllowanceDate": { "type": "string", "format": "date-time", "description": "sales Allowance Date" }, "oldQuantity": { "type": "number", "description": "Value of sales allowance before the change." }, "newQuantity": { "type": "number", "description": "Value of sales allowance after the change." }, "refActionId": { "type": "number" }, "logUserId": { "type": "number", "description": "ID of user who made the change." }, "logUserName": { "type": "string", "description": "Name of user who made the change." }, "actionType": { "type": "string", "minLength": 0, "maxLength": 100, "description": "Action type." }, "ipAddress": { "description": "The IP Address of the machine that performed the activity", "type": "string", "minLength": 0, "maxLength": 20 } } }, "blockSalesAllowanceActivityLog": { "type": "object", "description": "Response object for fetching block sales allowance activity log.", "properties": { "blockSalesAllowance": { "description": "Response object for Block Sales Allowance activity Log.", "$ref": "#/definitions/blockSalesAllowanceActivityLogListType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "operaVersionNumberType": { "type": "string", "description": "Current Opera Version Number", "minLength": 0, "maxLength": 40 }, "operaVersion": { "type": "object", "description": "Response for Ping operation.", "properties": { "operaVersion": { "description": "Opera version number.", "$ref": "#/definitions/operaVersionNumberType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "searchSalesManagersMultipleHotelIdsRequest": { "type": "object", "properties": { "hotelIds": { "type": "array", "maxItems": 4000, "items": { "type": "string" }, "description": "" }, "limit": { "type": "integer", "description": "Indicates maximum number of records a Web Service should return." }, "offset": { "type": "integer", "default": 0, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, "ownerCodes": { "type": "array", "maxItems": 4000, "items": { "type": "string" }, "description": "" }, "firstName": { "type": "string", "description": "First name required to fetch Sales Manager information." }, "lastName": { "type": "string", "description": "Last name required to fetch Sales Manager information." } }, "required": [ "hotelIds" ] }, "searchSalesManagersRequest": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Indicates maximum number of records a Web Service should return." }, "offset": { "type": "integer", "default": 0, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, "ownerCodes": { "type": "array", "maxItems": 4000, "items": { "type": "string" }, "description": "" }, "firstName": { "type": "string", "description": "First name required to fetch Sales Manager information." }, "lastName": { "type": "string", "description": "Last name required to fetch Sales Manager information." } } } }, "tags": [ { "name": "ChainConfig", "description": "The ChainConfigService Web Service offers capability of creating, managing, and retrieving of chain configuration." }, { "name": "BlockConfig", "description": "The Block Configuration module offers capability of creating, managing, and retrieving of Block configuration." } ], "externalDocs": { "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } }