{ "swagger": "2.0", "info": { "title": "OPERA Cloud Reservation Master Data Management API", "description": "APIs to cater for Reservation Configuration in OPERA Cloud. In this module you can retrieve, create, modify or delete configuration related to Reservations, Blocks and Leisure Management.

Compatible with OPERA Cloud release 26.2.0.0.

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": "/rsv/config/v1", "produces": [ "application/json" ], "paths": { "/alertCodes": { "get": { "summary": "Get Alert Code Templates", "description": "Retrieve all configured Alert Code Templates.

OperationId:getAlertCodeTemplates

", "operationId": "getAlertCodeTemplates", "parameters": [ { "name": "alertCodes", "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 information regarding alert templates.", "schema": { "$ref": "#/definitions/alertCodeTemplates" } }, "204": { "description": "AlertCodeTemplates 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": [ "ReservationConfig" ] }, "put": { "summary": "Change Alert Code Template", "description": "Update an existing alert code template.

OperationId:putAlertCodeTemplates

", "operationId": "putAlertCodeTemplates", "parameters": [ { "name": "alertTemplates", "in": "body", "required": true, "description": "Request object for modifying the existing alert code templates.", "schema": { "allOf": [ { "$ref": "#/definitions/alertTemplates" } ] } }, { "$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": [ "ReservationConfig" ] }, "delete": { "summary": "Delete Alert Code Template", "description": "Delete an existing alert code template.

OperationId:deleteAlertCodeTemplates

", "operationId": "deleteAlertCodeTemplates", "parameters": [ { "name": "alertCodeTemplateCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", "items": { "type": "string" }, "required": true }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create Alert Code Template", "description": "Create a new Alert Code Template.

OperationId:postAlertCodeTemplates

", "operationId": "postAlertCodeTemplates", "parameters": [ { "name": "alertTemplates", "in": "body", "required": true, "description": "Request object for creating a new alert code template.", "schema": { "allOf": [ { "$ref": "#/definitions/alertTemplates" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/autoAttachElements": { "put": { "summary": "Delete Auto Attach Elements", "description": "Delete an Auto Attach Element Rule on a property.

OperationId:deleteAutoAttachElements

", "operationId": "deleteAutoAttachElements", "parameters": [ { "name": "autoAttachElements", "in": "body", "required": true, "description": "Delete auto attach configuration rule(s) for resort.", "schema": { "allOf": [ { "$ref": "#/definitions/autoAttachElements" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/blockConversions": { "get": { "summary": "Get Block Conversions", "description": "Use this API to get Block Conversions.

OperationId:getBlockConversions

", "operationId": "getBlockConversions", "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 Conversions.", "schema": { "$ref": "#/definitions/blockConversionsDetails" } }, "204": { "description": "BlockConversions 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 Conversions", "description": "Use this API to create Block Conversions.

OperationId:postBlockConversions

", "operationId": "postBlockConversions", "parameters": [ { "name": "blockConversionsCriteria", "in": "body", "required": true, "description": "Request object for creating Block Conversions.", "schema": { "allOf": [ { "$ref": "#/definitions/blockConversionsCriteria" } ] } }, { "$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" ] } }, "/blockConversions/{blockConversionCode}": { "put": { "summary": "Change Block Conversions", "description": "Use this API to update Block Conversions.

OperationId:changeBlockConversions

", "operationId": "changeBlockConversions", "parameters": [ { "name": "blockConversionCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Block Conversions." }, { "name": "blockConversionsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Block Conversions.", "schema": { "allOf": [ { "$ref": "#/definitions/blockConversionsToBeChanged" } ] } }, { "$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 Conversions", "description": "Use this API to delete Block Conversions.

OperationId:removeBlockConversions

", "operationId": "removeBlockConversions", "parameters": [ { "name": "blockConversionCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Block Conversions." }, { "name": "blockConversionsCodes", "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" ] } }, "/blockRankings": { "get": { "summary": "Get Block Rankings", "description": "Use this API to get Block Rankings.

OperationId:getBlockRankings

", "operationId": "getBlockRankings", "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 Rankings.", "schema": { "$ref": "#/definitions/blockRankingsDetails" } }, "204": { "description": "BlockRankings 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 Rankings", "description": "Use this API to create Block Rankings.

OperationId:postBlockRankings

", "operationId": "postBlockRankings", "parameters": [ { "name": "blockRankingsCriteria", "in": "body", "required": true, "description": "Request object for creating Block Rankings.", "schema": { "allOf": [ { "$ref": "#/definitions/blockRankingsCriteria" } ] } }, { "$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" ] } }, "/blockRankings/{blockRankingsCode}": { "put": { "summary": "Change Block Ranking", "description": "Use this API to update Block Ranking.

OperationId:changeBlockRankings

", "operationId": "changeBlockRankings", "parameters": [ { "name": "blockRankingsCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Block Rankings." }, { "name": "blockRankingsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Block Rankings.", "schema": { "allOf": [ { "$ref": "#/definitions/blockRankingsToBeChanged" } ] } }, { "$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 Ranking", "description": "Use this API to delete Block Ranking.

OperationId:removeBlockRankings

", "operationId": "removeBlockRankings", "parameters": [ { "name": "blockRankingsCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Block Rankings." }, { "name": "blockRankingsCodes", "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" ] } }, "/bookingTypes": { "get": { "summary": "Get Booking Types", "description": "Use this API to get Booking Types.

OperationId:getBookingTypes

", "operationId": "getBookingTypes", "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 Booking Types.", "schema": { "$ref": "#/definitions/bookingTypesDetails" } }, "204": { "description": "BookingTypes 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 Booking Types", "description": "Use this API to create Booking Types.

OperationId:postBookingTypes

", "operationId": "postBookingTypes", "parameters": [ { "name": "bookingTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Booking Types.", "schema": { "allOf": [ { "$ref": "#/definitions/bookingTypesCriteria" } ] } }, { "$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" ] } }, "/bookingTypes/{bookingTypesId}": { "put": { "summary": "Change Booking Type", "description": "Use this API to update Booking Type.

OperationId:putBookingTypes

", "operationId": "putBookingTypes", "parameters": [ { "name": "bookingTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Booking Types." }, { "name": "bookingTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Booking Types.", "schema": { "allOf": [ { "$ref": "#/definitions/bookingTypesToBeChanged" } ] } }, { "$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 Booking Type", "description": "Use this API to delete Booking Type.

OperationId:deleteBookingTypes

", "operationId": "deleteBookingTypes", "parameters": [ { "name": "bookingTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Booking Types." }, { "name": "bookingTypesCodes", "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" ] } }, "/cancellationCodes": { "get": { "summary": "Get Cancellation Codes", "description": "Use this API to get Cancellation Codes.

OperationId:getCancellationCodes

", "operationId": "getCancellationCodes", "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 Cancellation Codes.", "schema": { "$ref": "#/definitions/cancellationCodesDetails" } }, "204": { "description": "CancellationCodes 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 Cancellation Codes", "description": "Use this API to create Cancellation Codes.

OperationId:postCancellationCodes

", "operationId": "postCancellationCodes", "parameters": [ { "name": "cancellationCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Cancellation Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/cancellationCodesCriteria" } ] } }, { "$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" ] } }, "/cancellationCodes/{cancellationCodesId}": { "put": { "summary": "Change Cancellation Codes", "description": "Use this API to update Cancellation Codes.

OperationId:putCancellationCodes

", "operationId": "putCancellationCodes", "parameters": [ { "name": "cancellationCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of cancellation codes" }, { "name": "cancellationCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Cancellation Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/cancellationCodesToBeChanged" } ] } }, { "$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 Cancellation Codes", "description": "Use this API to delete Cancellation Codes.

OperationId:deleteCancellationCodes

", "operationId": "deleteCancellationCodes", "parameters": [ { "name": "cancellationCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of cancellation codes" }, { "name": "cancellationCodes", "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" ] } }, "/cancelpolicies": { "get": { "summary": "Get Cancellation policies in hotel level", "description": "Use this API to get Cancellation policies in hotel level.

OperationId:getCancellationPolicy

", "operationId": "getCancellationPolicy", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel code.", "items": { "type": "string" }, "required": false }, { "name": "policyCodeListCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Indicator that tells whether to include inactive in search results.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch Cancellation Policies.", "schema": { "$ref": "#/definitions/cancellationPolicyDetails" } }, "204": { "description": "CancellationPolicy 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": [ "HotelConfig" ] } }, "/cancelpolicy/{cancelpolicycode}": { "post": { "summary": "Create Cancellation policies in hotel level", "description": "Use this API to create Cancellation policies in hotel level.

OperationId:postCancellationPolicy

", "operationId": "postCancellationPolicy", "parameters": [ { "name": "cancelpolicycode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of policy." }, { "name": "cancellationPolicyCriteria", "in": "body", "required": true, "description": "Request object that holds the details of Cancellation Policy to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/cancellationPolicyCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete Cancellation policies in hotel level", "description": "Use this API to delete Cancellation policies in hotel level.

OperationId:deleteCancellationPolicy

", "operationId": "deleteCancellationPolicy", "parameters": [ { "name": "cancelpolicycode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of policy." }, { "name": "hotelId", "in": "query", "required": true, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Change Cancellation policies in hotel level", "description": "Use this API to update Cancellation policies in hotel level.

OperationId:changeCancellationPolicy

", "operationId": "changeCancellationPolicy", "parameters": [ { "name": "cancelpolicycode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of policy." }, { "name": "cancellationPolicyToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of Cancellation Policy to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/cancellationPolicyToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] } }, "/cancelpolicytemplate/{cancelpolicytemplate}": { "post": { "summary": "Create template Cancellation policies", "description": "Use this API to create template Cancellation policies.

OperationId:postTemplateCancellationPolicy

", "operationId": "postTemplateCancellationPolicy", "parameters": [ { "name": "cancelpolicytemplate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of policy template." }, { "name": "templateCancellationPolicyCriteria", "in": "body", "required": true, "description": "Request object that holds the details of template Cancellation Policy to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/templateCancellationPolicyCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete template Cancellation policies", "description": "Use this API to delete template Cancellation policies.

OperationId:deleteTemplateCancellationPolicy

", "operationId": "deleteTemplateCancellationPolicy", "parameters": [ { "name": "cancelpolicytemplate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of policy template." }, { "name": "policyCode", "in": "query", "required": false, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Change template Cancellation policies", "description": "Use this API to update template Cancellation policies.

OperationId:changeTemplateCancellationPolicy

", "operationId": "changeTemplateCancellationPolicy", "parameters": [ { "name": "cancelpolicytemplate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of policy template." }, { "name": "templateCancellationPolicyToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of template Cancellation Policy to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/templateCancellationPolicyToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] } }, "/cancelpolicytemplates": { "get": { "summary": "Get template Cancellation policies", "description": "Use this API to get template Cancellation policies.

OperationId:getTemplateCancellationPolicy

", "operationId": "getTemplateCancellationPolicy", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel code.", "items": { "type": "string" }, "required": false }, { "name": "policyCodeListCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Indicator that tells whether to include inactive in search results.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch template Cancellation Policies.", "schema": { "$ref": "#/definitions/templateCancellationPolicyDetails" } }, "204": { "description": "TemplateCancellationPolicy 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": [ "HotelConfig" ] } }, "/depositpolicies": { "get": { "summary": "Get deposit policies in hotel level", "description": "Use this API to get deposit policies in hotel level.

OperationId:getDepositPolicy

", "operationId": "getDepositPolicy", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel code.", "items": { "type": "string" }, "required": false }, { "name": "policyCodeListCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Indicator that tells whether to include inactive in search results.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch Deposit Policies in hotel level.", "schema": { "$ref": "#/definitions/depositPolicyDetails" } }, "204": { "description": "DepositPolicy 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": [ "HotelConfig" ] } }, "/depositpolicy/{depositpolicycode}": { "post": { "summary": "Create deposit policy in hotel level", "description": "Use this API to create deposit policy in hotel level.

OperationId:postDepositPolicy

", "operationId": "postDepositPolicy", "parameters": [ { "name": "depositpolicycode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of deposit policy." }, { "name": "depositPolicyCriteria", "in": "body", "required": true, "description": "Request object that holds the details of hotel level Deposit Policy to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/depositPolicyCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete deposit policy in hotel level", "description": "Use this API to delete deposit policy in hotel level.

OperationId:deleteDepositPolicy

", "operationId": "deleteDepositPolicy", "parameters": [ { "name": "depositpolicycode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of deposit policy." }, { "name": "hotelId", "in": "query", "required": true, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Change deposit policy in hotel level", "description": "Use this API to update deposit policy in hotel level.

OperationId:changeDepositPolicy

", "operationId": "changeDepositPolicy", "parameters": [ { "name": "depositpolicycode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of deposit policy." }, { "name": "depositPolicyToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of hotel level Deposit Policy to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/depositPolicyToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] } }, "/depositpolicytemplate/{depositpolicytemplate}": { "post": { "summary": "Create template deposit policy", "description": "Use this API to create template deposit policy.

OperationId:postTemplateDepositPolicy

", "operationId": "postTemplateDepositPolicy", "parameters": [ { "name": "depositpolicytemplate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of deposit policy template." }, { "name": "templateDepositPolicyCriteria", "in": "body", "required": true, "description": "Request object that holds the details of template Deposit Policy to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/templateDepositPolicyCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Change template deposit policy", "description": "Use this API to update template deposit policy.

OperationId:changeTemplateDepositPolicy

", "operationId": "changeTemplateDepositPolicy", "parameters": [ { "name": "depositpolicytemplate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of deposit policy template." }, { "name": "templateDepositPolicyToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of template Deposit Policy to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/templateDepositPolicyToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete template deposit policy", "description": "Use this API to delete template deposit policy.

OperationId:deleteTemplateDepositPolicy

", "operationId": "deleteTemplateDepositPolicy", "parameters": [ { "name": "depositpolicytemplate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of deposit policy template." }, { "name": "policyCode", "in": "query", "required": false, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] } }, "/depositpolicytemplates": { "get": { "summary": "Get template deposit policies", "description": "Use this API to get template deposit policies.

OperationId:getTemplateDepositPolicy

", "operationId": "getTemplateDepositPolicy", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel code.", "items": { "type": "string" }, "required": false }, { "name": "policyCodeListCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Indicator that tells whether to include inactive in search results.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch template Deposit Policies.", "schema": { "$ref": "#/definitions/templateDepositPolicyDetails" } }, "204": { "description": "TemplateDepositPolicy 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": [ "HotelConfig" ] } }, "/discountReasons": { "get": { "summary": "Get Discount Reasons", "description": "Use this API to get Discount Reasons.

OperationId:getDiscountReasons

", "operationId": "getDiscountReasons", "parameters": [ { "name": "fetchAdvanced", "in": "query", "required": false, "description": "Determines whether to fetch records checked as Advanced or not.", "type": "boolean" }, { "name": "fetchInactive", "in": "query", "default": "false", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "fetchNonAdvanced", "in": "query", "required": false, "description": "Determines whether to fetch records that are not checked as Advanced 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 Discount Reasons.", "schema": { "$ref": "#/definitions/discountReasonsDetails" } }, "204": { "description": "DiscountReasons 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 Discount Reasons", "description": "Use this API to create Discount Reasons.

OperationId:postDiscountReasons

", "operationId": "postDiscountReasons", "parameters": [ { "name": "discountReasonsCriteria", "in": "body", "required": true, "description": "Request object for creating Discount Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/discountReasonsCriteria" } ] } }, { "$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" ] } }, "/discountReasons/{discountReasonsId}": { "put": { "summary": "Change Discount Reasons", "description": "Use this API to update Discount Reasons.

OperationId:putDiscountReasons

", "operationId": "putDiscountReasons", "parameters": [ { "name": "discountReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Discount Reasons." }, { "name": "discountReasonsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Discount Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/discountReasonsToBeChanged" } ] } }, { "$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 Discount Reasons", "description": "Use this API to delete Discount Reasons.

OperationId:deleteDiscountReasons

", "operationId": "deleteDiscountReasons", "parameters": [ { "name": "discountReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Discount Reasons." }, { "$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" ] } }, "/ecoupons": { "get": { "summary": "Get eCoupon Codes", "description": "Get existing property eCoupon Codes.

OperationId:getECouponCodes

", "operationId": "getECouponCodes", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "offset", "in": "query", "default": 0, "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "eCouponCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCardECouponCodes", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "ratePlansCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCardRatePlans", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "includeInactive", "in": "query", "default": "false", "required": false, "description": "Indicator that tells whether to include inactive rules in search results .", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to fetch eCoupon codes.", "schema": { "$ref": "#/definitions/eCouponCodes" } }, "204": { "description": "ECouponCodes 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": [ "ReservationConfig" ] } }, "/entryPoints": { "get": { "summary": "Get Entry Points", "description": "Use this API to get Entry Points.

OperationId:getEntryPoints

", "operationId": "getEntryPoints", "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 Entry Points.", "schema": { "$ref": "#/definitions/entryPointsDetails" } }, "204": { "description": "EntryPoints 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 Entry Points", "description": "Use this API to create Entry Points.

OperationId:postEntryPoints

", "operationId": "postEntryPoints", "parameters": [ { "name": "entryPointsCriteria", "in": "body", "required": true, "description": "Request object for creating Entry Points.", "schema": { "allOf": [ { "$ref": "#/definitions/entryPointsCriteria" } ] } }, { "$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" ] } }, "/entryPoints/{entryPointsId}": { "put": { "summary": "Change Entry Points", "description": "Use this API to update Entry Points.

OperationId:putEntryPoints

", "operationId": "putEntryPoints", "parameters": [ { "name": "entryPointsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Entry Points." }, { "name": "entryPointsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Entry Points.", "schema": { "allOf": [ { "$ref": "#/definitions/entryPointsToBeChanged" } ] } }, { "$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 Entry Points", "description": "Use this API to delete Entry Points.

OperationId:deleteEntryPoints

", "operationId": "deleteEntryPoints", "parameters": [ { "name": "entryPointsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Entry Points." }, { "name": "entryPointsCodes", "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" ] } }, "/globalActionCodes": { "get": { "summary": "Get Global Action Codes", "description": "Use this API to get Global Action Codes.

OperationId:getGlobalActionCodes

", "operationId": "getGlobalActionCodes", "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 Global Action Codes.", "schema": { "$ref": "#/definitions/globalActionCodesDetails" } }, "204": { "description": "GlobalActionCodes 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 Global Action Codes", "description": "Use this API to create Global Action Codes.

OperationId:postGlobalActionCodes

", "operationId": "postGlobalActionCodes", "parameters": [ { "name": "globalActionCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Global Action Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/globalActionCodesCriteria" } ] } }, { "$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" ] } }, "/globalActionCodes/{actionCode}": { "put": { "summary": "Change Global Action Codes", "description": "Use this API to update Global Action Codes.

OperationId:changeGlobalActionCodes

", "operationId": "changeGlobalActionCodes", "parameters": [ { "name": "actionCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Global Action." }, { "name": "globalActionCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Global Action Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/globalActionCodesToBeChanged" } ] } }, { "$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 Global Action Codes", "description": "Use this API to delete Global Action Codes.

OperationId:removeGlobalActionCodes

", "operationId": "removeGlobalActionCodes", "parameters": [ { "name": "actionCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Global Action." }, { "name": "globalActionCodesCodes", "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" ] } }, "/globalAlerts": { "put": { "summary": "Delete a Global Alert Code", "description": "Delete a Global Alert for a property.

OperationId:deleteGlobalAlerts

", "operationId": "deleteGlobalAlerts", "parameters": [ { "name": "globalAlerts", "in": "body", "required": true, "description": "Request object for removing the existing Global Alerts.", "schema": { "allOf": [ { "$ref": "#/definitions/globalAlerts" } ] } }, { "$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": [ "ReservationConfig" ] }, "get": { "summary": "Get Global Alerts", "description": "Retrieve all configured Global Alerts for a property.

OperationId:getGlobalAlerts

", "operationId": "getGlobalAlerts", "parameters": [ { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "alertCodes", "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": "welcomeOffer", "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" } }, "description": "Response object for fetching Global Alerts.", "schema": { "$ref": "#/definitions/globalAlertsInfo" } }, "204": { "description": "GlobalAlerts 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": [ "ReservationConfig" ] } }, "/globalAlerts/copy": { "put": { "summary": "Copy Global Alerts", "description": "Copy a Global Alert for a property.

OperationId:copyGlobalAlerts

", "operationId": "copyGlobalAlerts", "parameters": [ { "name": "globalAlertsCopy", "in": "body", "required": true, "description": "Request object for copying Global Alerts.", "schema": { "allOf": [ { "$ref": "#/definitions/globalAlertsCopy" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/guaranteeCodeTemplates": { "get": { "summary": "Get template Guarantee Codes", "description": "Use this API to get template Guarantee Codes.

OperationId:getTemplateGuaranteeCodes

", "operationId": "getTemplateGuaranteeCodes", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "guaranteeCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "inactive", "in": "query", "required": false, "description": "Is Guarantee Code Inactive?", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch template Guarantee Codes.", "schema": { "$ref": "#/definitions/templateGuaranteeCodesDetails" } }, "204": { "description": "TemplateGuaranteeCodes 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": [ "HotelConfig" ] } }, "/guaranteeCodeTemplates/{guaranteeCode}": { "post": { "summary": "Create template Guarantee Code", "description": "Use this API to create template Guarantee Code.

OperationId:postTemplateGuaranteeCode

", "operationId": "postTemplateGuaranteeCode", "parameters": [ { "name": "guaranteeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guarantee." }, { "name": "templateGuaranteeCodeCriteria", "in": "body", "required": true, "description": "Request object that holds the details of template Guarantee Code to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/templateGuaranteeCodeCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete template Guarantee Code", "description": "Use this API to delete template Guarantee Code.

OperationId:deleteTemplateGuaranteeCode

", "operationId": "deleteTemplateGuaranteeCode", "parameters": [ { "name": "guaranteeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guarantee." }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Change template Guarantee Code", "description": "Use this API to update template Guarantee Code.

OperationId:changeTemplateGuaranteeCode

", "operationId": "changeTemplateGuaranteeCode", "parameters": [ { "name": "guaranteeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guarantee." }, { "name": "templateGuaranteeCodeToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of template Guarantee Code to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/templateGuaranteeCodeToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] } }, "/guaranteeCodes": { "get": { "summary": "Get Guarantee Codes", "description": "Use this API to get Guarantee Codes.

OperationId:getGuaranteeCodes

", "operationId": "getGuaranteeCodes", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "guaranteeCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "inactive", "in": "query", "required": false, "description": "Is Guarantee Code Inactive?", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch Guarantee Codes.", "schema": { "$ref": "#/definitions/guaranteeCodesDetails" } }, "204": { "description": "GuaranteeCodes 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": [ "HotelConfig" ] }, "post": { "summary": "Create Guarantee Code", "description": "Use this API to create Guarantee Code.

OperationId:postGuaranteeCode

", "operationId": "postGuaranteeCode", "parameters": [ { "name": "guaranteeCodeCriteria", "in": "body", "required": true, "description": "Request object that holds the details of Guarantee Code to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/guaranteeCodeCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/guaranteeCodes/{guaranteeCode}": { "put": { "summary": "Change Guarantee Code", "description": "Use this API to update Guarantee Code.

OperationId:changeGuaranteeCode

", "operationId": "changeGuaranteeCode", "parameters": [ { "name": "guaranteeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of guarantee." }, { "name": "guaranteeCodeToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of Guarantee Code to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/guaranteeCodeToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete Guarantee Code", "description": "Use this API to delete Guarantee Code.

OperationId:deleteGuaranteeCode

", "operationId": "deleteGuaranteeCode", "parameters": [ { "name": "guaranteeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of guarantee." }, { "name": "hotelId", "in": "query", "required": false, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] } }, "/guestMessages": { "get": { "summary": "Get Guest Message Templates", "description": "Retrieve the configured Guest Message Templates.

OperationId:getGuestMessageTemplates

", "operationId": "getGuestMessageTemplates", "parameters": [ { "name": "guestMessageCodes", "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 information regarding guest message templates.", "schema": { "$ref": "#/definitions/guestMessageTemplates" } }, "204": { "description": "GuestMessageTemplates 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": [ "ReservationConfig" ] }, "put": { "summary": "Change Guest Message Templates", "description": "Update an existing Guest Message Template.

OperationId:putGuestMessageTemplates

", "operationId": "putGuestMessageTemplates", "parameters": [ { "name": "guestMessageTemplates", "in": "body", "required": true, "description": "Request object for modifying an existing guest message template.", "schema": { "allOf": [ { "$ref": "#/definitions/guestMessageTemplates" } ] } }, { "$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": [ "ReservationConfig" ] }, "delete": { "summary": "Delete an existing guest message template", "description": "Delete an existing Guest Message Template.

OperationId:deleteGuestMessageTemplates

", "operationId": "deleteGuestMessageTemplates", "parameters": [ { "name": "guestMessageTemplateCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": true }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create a new guest message template", "description": "Message templates enable you to define standard message texts within OPERA Cloud to ensure consistency in the format of guest messages. You can use this API to create a new Guest Message Template.

OperationId:postGuestMessageTemplates

", "operationId": "postGuestMessageTemplates", "parameters": [ { "name": "guestMessageTemplates", "in": "body", "required": true, "description": "Request object for creating a new guest message template.", "schema": { "allOf": [ { "$ref": "#/definitions/guestMessageTemplates" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/alertCodes": { "get": { "summary": "Get Alert Codes", "description": "You can use this API to get Alert Codes.

OperationId:getAlertCodes

", "operationId": "getAlertCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "code", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "alertCodes", "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 information regarding alert templates.", "schema": { "$ref": "#/definitions/alertCodes" } }, "204": { "description": "AlertCodes 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": [ "ReservationConfig" ] }, "put": { "summary": "Change Alert Codes", "description": "You can use this API to change Alert Codes.

OperationId:putAlertCodes

", "operationId": "putAlertCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "alertCodes", "in": "body", "required": true, "description": "Request object for modifying an existing alert.", "schema": { "allOf": [ { "$ref": "#/definitions/alertCodes" } ] } }, { "$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": [ "ReservationConfig" ] }, "delete": { "summary": "Delete an Alert Code", "description": "You can use this API to delete an Alert Code.

OperationId:deleteAlertCodes

", "operationId": "deleteAlertCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "codes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Configuration code.", "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": [ "ReservationConfig" ] }, "post": { "summary": "Create a new alert code", "description": "You can use this API to create a new alert code.

OperationId:postAlertCodes

", "operationId": "postAlertCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "alertCodes", "in": "body", "required": true, "description": "Request object for creating a new group of alerts.", "schema": { "allOf": [ { "$ref": "#/definitions/alertCodes" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/autoAttachElements": { "get": { "summary": "Get Auto Attach Elements", "description": "Retrieve the Auto Attach Element Rules that are configured. Auto attach elements are rules defined to auto-update various fields (elements) on a new reservation. Rules can be associated with rate codes, memberships, room types, preferences etc. An example could be 'If rate code is PROMO1 then update specials on the reservation to include FB (Fruit Basket).

OperationId:getAutoAttachElements

", "operationId": "getAutoAttachElements", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "List of Hotels.", "items": { "type": "string" }, "required": false }, { "name": "code", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "criteriaCode", "in": "query", "required": false, "description": "The name of the rule.", "type": "string" }, { "name": "type", "in": "query", "required": false, "type": "string", "uniqueItems": true, "enum": [ "Item", "Product", "ResvPreference", "Trace", "RoomFeatures", "Preference", "Promotions", "AdvancedDiscount" ], "description": "Available only when Reservation Discounts and Advanced Discounts are active" }, { "name": "basedOn", "in": "query", "required": false, "type": "string", "uniqueItems": true, "enum": [ "Membership", "Preference", "RateCode", "RoomType", "MinAdults", "MinChildren", "KeywordType", "Special", "Vip", "Condition" ], "description": "Available only when Keyword Functionality is active." }, { "name": "includeInactive", "in": "query", "required": false, "description": "Indicator that tells whether to include inactive rules in search results.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for the configuration rules that specify the elements to be automatically attached to the reservation.", "schema": { "$ref": "#/definitions/autoAttachElementsConfig" } }, "204": { "description": "AutoAttachElements 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": [ "ReservationConfig" ] }, "put": { "summary": "Update Auto Attach Elements", "description": "Modify the configuration of an Auto Attach Element Rule that exists on a property.

OperationId:putAutoAttachElements

", "operationId": "putAutoAttachElements", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "autoAttachElements", "in": "body", "required": true, "description": "Modify auto attach configuration rule(s).", "schema": { "allOf": [ { "$ref": "#/definitions/autoAttachElements" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create Auto Attach Elements", "description": "Create a new Auto Attach Element Rule. Auto attach elements are rules defined to auto-update various fields (elements) on a new reservation. Rules can be associated with rate codes, memberships, room types, preferences etc. An example could be 'If rate code is PROMO1 then update specials on the reservation to include FB (Fruit Basket).

OperationId:postAutoAttachElements

", "operationId": "postAutoAttachElements", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "autoAttachElements", "in": "body", "required": true, "description": "Add configuration rule(s) that specify the elements to be automatically attached to the reservation.", "schema": { "allOf": [ { "$ref": "#/definitions/autoAttachElements" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/autoAttachElements/copy": { "put": { "summary": "Copy Auto Attach Elements", "description": "You can use this API to copy Auto Attach Elements.

OperationId:copyAutoAttachElements

", "operationId": "copyAutoAttachElements", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Source Hotel code" }, { "name": "autoAttachElementsCopy", "in": "body", "required": true, "description": "List of the auto attach configuration rule(s) to be copied.", "schema": { "allOf": [ { "$ref": "#/definitions/autoAttachElementsCopy" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/colors": { "get": { "summary": "Get Reservation Colors", "description": "Use this API to get Reservation Colors.

OperationId:getReservationColors

", "operationId": "getReservationColors", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "description", "in": "query", "required": false, "description": "Description to filter result.", "type": "string" }, { "name": "includeInactive", "in": "query", "required": false, "description": "Indicates whether to include inactive reservation colors or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetch reservation colors.", "schema": { "$ref": "#/definitions/reservationColorsResponse" } }, "204": { "description": "ReservationColors 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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/colors/{code}": { "put": { "summary": "Change Reservation Colors", "description": "Use this API to put Reservation Colors.

OperationId:putReservationColors

", "operationId": "putReservationColors", "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "reservationColorsToChange", "in": "body", "required": true, "description": "Request object to change reservation colors.", "schema": { "allOf": [ { "$ref": "#/definitions/reservationColorsToChange" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/ecouponCodes/{ecouponCode}": { "delete": { "summary": "Delete an eCoupon Code", "description": "Delete an existing eCoupon Code.

OperationId:deleteECouponCodes

", "operationId": "deleteECouponCodes", "parameters": [ { "name": "ecouponCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/ecoupons": { "put": { "summary": "Change an eCoupon Code", "description": "Update an existing eCoupon Code.

OperationId:putECouponCodes

", "operationId": "putECouponCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "eCouponCodes", "in": "body", "required": true, "description": "Request object for changing the existing eCoupon codes.", "schema": { "allOf": [ { "$ref": "#/definitions/eCouponCodes" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create an eCoupon Code", "description": "You can create an ecoupon for a specified property and it can be a maximum of 8 alphanumeric characters. You can enter a quantity value from 1 to 99.

OperationId:postECouponCodes

", "operationId": "postECouponCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "eCouponCodes", "in": "body", "required": true, "description": "Request object to create new eCoupon codes.", "schema": { "allOf": [ { "$ref": "#/definitions/eCouponCodes" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/ecoupons/copy": { "put": { "summary": "Copy eCoupon Codes", "description": "Copy an existing property eCoupon Codes to create a new one.

OperationId:copyECouponCodes

", "operationId": "copyECouponCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "eCouponCodesCopy", "in": "body", "required": true, "description": "Request object to copy the existing eCoupon codes from source property to the selected target properties.", "schema": { "allOf": [ { "$ref": "#/definitions/eCouponCodesCopy" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/globalAlerts": { "put": { "summary": "Change Global Alerts", "description": "Use this API to change Global Alerts for a property.

OperationId:putGlobalAlerts

", "operationId": "putGlobalAlerts", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "globalAlerts", "in": "body", "required": true, "description": "Request object for modifying an existing Global Alert.", "schema": { "allOf": [ { "$ref": "#/definitions/globalAlerts" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create Global Alerts", "description": "You can create a Global Alerts to generate automatically for all reservations that meet the alert condition.

OperationId:postGlobalAlerts

", "operationId": "postGlobalAlerts", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "globalAlerts", "in": "body", "required": true, "description": "Request object for creating a new Global Alert.", "schema": { "allOf": [ { "$ref": "#/definitions/globalAlerts" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/guaranteeCodeSchedules": { "post": { "summary": "Create schedule for guarantee codes ", "description": "Use this API to create schedule for guarantee codes.

OperationId:postGuaranteeCodeSchedule

", "operationId": "postGuaranteeCodeSchedule", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "guaranteeCodeScheduleCriteria", "in": "body", "required": true, "description": "Creates the Guarantee Code schedule based on the details provided by the request.", "schema": { "allOf": [ { "$ref": "#/definitions/guaranteeCodeScheduleCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "get": { "summary": "Get schedules for guarantee codes ", "description": "Use this API to get schedules for guarantee codes.

OperationId:getGuaranteeCodeSchedules

", "operationId": "getGuaranteeCodeSchedules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "List of Hotels.", "items": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "ratePlanCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "duration", "in": "query", "required": false, "type": "string" }, { "name": "guaranteeCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "creditRatingsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "seasonsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "inactive", "in": "query", "required": false, "description": "Is schedule Inactive?", "type": "boolean" }, { "name": "override", "in": "query", "required": false, "description": "When set to true only schedules marked as Override will be returned.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Return response for fetch guarantee code schedules based on request.", "schema": { "$ref": "#/definitions/guaranteeCodeSchedulesDetails" } }, "204": { "description": "GuaranteeCodeSchedules 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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/guaranteeCodeSchedules/{policyScheduleId}": { "put": { "summary": "Change an schedule for guarantee codes ", "description": "Use this API to update an schedule for guarantee codes.

OperationId:changeGuaranteeCodeSchedule

", "operationId": "changeGuaranteeCodeSchedule", "parameters": [ { "name": "policyScheduleId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of policy schedule." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "guaranteeCodeScheduleToBeChanged", "in": "body", "required": true, "description": "Changes the Guarantee Code schedule based on the details provided by the request.", "schema": { "allOf": [ { "$ref": "#/definitions/guaranteeCodeScheduleToBeChanged" } ] } }, { "$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": "Return object for change Guarantee Code schedule.", "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": [ "HotelConfig" ] }, "delete": { "summary": "Delete schedule for guarantee codes ", "description": "Use this API to delete schedule for guarantee codes.

OperationId:deleteGuaranteeCodeSchedule

", "operationId": "deleteGuaranteeCodeSchedule", "parameters": [ { "name": "policyScheduleId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of policy schedule." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "idContext", "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string" }, { "name": "type", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "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" }, "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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/guaranteeCodeSchedules/{policyScheduleId}/copy": { "put": { "summary": "Copy schedule s for guarantee codes ", "description": "Use this APU to copy schedules for guarantee codes.

OperationId:copyGuaranteeCodeSchedules

", "operationId": "copyGuaranteeCodeSchedules", "parameters": [ { "name": "policyScheduleId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of policy schedule." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "copyGuaranteeCodeSchedules", "in": "body", "required": true, "description": "Request object that provides the criteria to copy Guarantee Code schedules to different hotels.", "schema": { "allOf": [ { "$ref": "#/definitions/copyGuaranteeCodeSchedules" } ] } }, { "$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": "Return response for copy Guarantee Code schedules.", "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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/guestMessages": { "get": { "summary": "Get Guest Messages", "description": "You can use this API to get Guest Messages.

OperationId:getGuestMessages

The maximum allowable limit for this API is 100.

", "operationId": "getGuestMessages", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "List of Hotels.", "items": { "type": "string" }, "required": false }, { "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": "guestMessageCodes", "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 information regarding guest message.", "schema": { "$ref": "#/definitions/retrievedGuestMessages" } }, "204": { "description": "GuestMessages 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": [ "ReservationConfig" ] }, "put": { "summary": "Change a Guest messages", "description": "You can use this API to change a Guest messages.

OperationId:putGuestMessages

", "operationId": "putGuestMessages", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "guestMessages", "in": "body", "required": true, "description": "Request object for modifying an existing guest message.", "schema": { "allOf": [ { "$ref": "#/definitions/guestMessages" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create Guest Messages", "description": "This API is used to create a new guest messages based on the request.

OperationId:postGuestMessages

", "operationId": "postGuestMessages", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "guestMessages", "in": "body", "required": true, "description": "Request object for creating a new guest message.", "schema": { "allOf": [ { "$ref": "#/definitions/guestMessages" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/guestMessages/{messageCode}": { "delete": { "summary": "Delete a Guest messages", "description": "You can use this API to delete a Guest messages.

OperationId:deleteGuestMessages

", "operationId": "deleteGuestMessages", "parameters": [ { "name": "messageCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/locatorCodes": { "get": { "summary": "Get existing property Locator Codes", "description": "You can use this API to get existing property Locator Codes.

OperationId:getLocatorCodes

", "operationId": "getLocatorCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "List of Hotels.", "items": { "type": "string" }, "required": false }, { "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": "locatorCodes", "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": "includeInactive", "in": "query", "required": false, "description": "Indicator that tells whether to include inactive rules in search results.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching locator codes.", "schema": { "$ref": "#/definitions/locatorCodesInfo" } }, "204": { "description": "LocatorCodes 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": [ "ReservationConfig" ] }, "put": { "summary": "Change the existing Locator Code", "description": "You can use this API to change the existing Locator Code.

OperationId:putLocatorCodes

", "operationId": "putLocatorCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "locatorCodes", "in": "body", "required": true, "description": "Request object for modifying an existing locator code.", "schema": { "allOf": [ { "$ref": "#/definitions/locatorCodes" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create a new Locator Code", "description": "You can use this API to create a new Locator Code.

OperationId:postLocatorCodes

", "operationId": "postLocatorCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "locatorCodes", "in": "body", "required": true, "description": "Request object for creating a new locator code.", "schema": { "allOf": [ { "$ref": "#/definitions/locatorCodes" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/locatorCodes/{locatorCode}": { "delete": { "summary": "Delete a Locator Code", "description": "You can use this API to delete a Locator Code.

OperationId:deleteLocatorCodes

", "operationId": "deleteLocatorCodes", "parameters": [ { "name": "locatorCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/marketCodes/{marketcode}": { "post": { "summary": "Create a new Market Code", "description": "Use this API to create a new Market Code.

OperationId:postMarketCode

", "operationId": "postMarketCode", "parameters": [ { "name": "marketcode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "marketCodeCriteria", "in": "body", "required": true, "description": "Request object that holds the details of Market Code to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/marketCodeCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete a Market Code ", "description": "Use this API to delete a Market Code .

OperationId:removeMarketCode

", "operationId": "removeMarketCode", "parameters": [ { "name": "marketcode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Modify a Market Code ", "description": "You can use this API to modify a Market Code .

OperationId:changeMarketCode

", "operationId": "changeMarketCode", "parameters": [ { "name": "marketcode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "forceOverride", "in": "query", "description": "Query param to override the property overridden configuration from EM.", "type": "boolean" }, { "name": "marketCodeToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of Market Code to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/marketCodeToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/marketGroups/{marketGroupCode}": { "post": { "summary": "Create Market Group", "description": "Use this API to create a new Market Group. Only one Market Code can be created at a time.

OperationId:postMarketGroup

", "operationId": "postMarketGroup", "parameters": [ { "name": "marketGroupCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market group." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "marketGroupCriteria", "in": "body", "required": true, "description": "Request object that holds the details of Market Group to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/marketGroupCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Change Market Group", "description": "Use this API to modify a Market Group. Only one Market Group can be modified at a time.

OperationId:changeMarketGroup

", "operationId": "changeMarketGroup", "parameters": [ { "name": "marketGroupCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market group." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "marketGroupToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of Market Group to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/marketGroupToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete a Market Group ", "description": "Use this API to delete a Market Group .

OperationId:removeMarketGroup

", "operationId": "removeMarketGroup", "parameters": [ { "name": "marketGroupCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market group." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/membershipLevels/ratings": { "get": { "summary": "Get Membership Level Ratings", "description": "This API accepts the membership level ratings in the request and returns gets the membership levels.

OperationId:getMembershipLevelRatings

", "operationId": "getMembershipLevelRatings", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "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": "membershipTypeCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCardMembershipTypes", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "membershipLevelCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCardMembershipLevels", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "descriptionWildCard", "in": "query", "required": false, "description": "Criteria to specify which membership levels description would be included in the results.", "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 the membership levels and their rating details.", "schema": { "$ref": "#/definitions/membershipLevelRatingsInfo" } }, "204": { "description": "MembershipLevelRatings 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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/membershipTypes/{membershipType}/membershipLevels/{membershipLevel}/ratings": { "put": { "summary": "Change Membership Level Ratings", "description": "You can use this API to change Membership Level Ratings.

OperationId:putMembershipLevelRatings

", "operationId": "putMembershipLevelRatings", "parameters": [ { "name": "membershipLevel", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "OPERA Membership level" }, { "name": "membershipType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "OPERA Membership type" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "membershipLevelRatings", "in": "body", "required": true, "description": "Request object for modifying membership levels rating details.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipLevelRatings" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/policyschedules": { "get": { "summary": "Get Policy Schedules", "description": "Use this API to get schedules for deposit or cancel policies.

OperationId:getPolicySchedules

", "operationId": "getPolicySchedules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "List of Hotels.", "items": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "policyType", "in": "query", "required": false, "type": "string", "description": "Simple type for Policy type.", "uniqueItems": true, "enum": [ "Deposit", "Cancellation" ] }, { "name": "ratePlanCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "policyCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "duration", "in": "query", "required": false, "type": "string" }, { "name": "guaranteeCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "creditRatingsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "seasonsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "required": false, "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", "type": "string" }, { "name": "idContext", "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string" }, { "name": "type", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "inactive", "in": "query", "required": false, "description": "Is schedule Inactive?", "type": "boolean" }, { "name": "override", "in": "query", "required": false, "description": "When set to true only schedules marked as Override will be returned.", "type": "boolean" }, { "name": "housePolicies", "in": "query", "required": false, "description": "When set to true only schedules which are house policies will be returned.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Return response for fetch policy schedules based on request.", "schema": { "$ref": "#/definitions/policySchedulesDetails" } }, "204": { "description": "PolicySchedules 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": [ "HotelConfig" ] }, "post": { "summary": "Create a Policy Schedule", "description": "Use this API to create schedule for deposit or cancel policy.

OperationId:postNewPolicySchedule

", "operationId": "postNewPolicySchedule", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "policyScheduleCriteria", "in": "body", "required": true, "description": "Creates the Policy schedule based on the details provided by the request.", "schema": { "allOf": [ { "$ref": "#/definitions/policyScheduleCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/policyschedules/{policyscheduleId}": { "post": { "summary": "Create a Policy Schedule", "description": "Use this API to create schedule for deposit or cancel policy.

This API is deprecated. Please use createNewPolicySchedule instead

OperationId:postPolicySchedule

", "operationId": "postPolicySchedule", "deprecated": true, "parameters": [ { "name": "policyscheduleId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of policy schedule." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "policyScheduleCriteria", "in": "body", "required": true, "description": "Creates the Policy schedule based on the details provided by the request.", "schema": { "allOf": [ { "$ref": "#/definitions/policyScheduleCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Change a Policy Schedule", "description": "Use this API to update an schedule for deposit or cancel policy.

OperationId:changePolicySchedule

", "operationId": "changePolicySchedule", "parameters": [ { "name": "policyscheduleId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of policy schedule." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "policyScheduleToBeChanged", "in": "body", "required": true, "description": "Changes the Policy schedule based on the details provided by the request.", "schema": { "allOf": [ { "$ref": "#/definitions/policyScheduleToBeChanged" } ] } }, { "$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": "Return object for change policy schedule.", "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": [ "HotelConfig" ] }, "delete": { "summary": "Delete Policy Schedule", "description": "Use this API to delete schedule for deposit or cancel policy.

OperationId:deletePolicySchedule

", "operationId": "deletePolicySchedule", "parameters": [ { "name": "policyscheduleId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of policy schedule." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "idContext", "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string" }, { "name": "type", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "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" }, "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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/policyschedules/{policyscheduleId}/copy": { "put": { "summary": "Copy a Policy Schedule", "description": "Use this APU to copy schedules for deposit or cancel policy.

OperationId:copyPolicySchedules

", "operationId": "copyPolicySchedules", "parameters": [ { "name": "policyscheduleId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of policy schedule." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "copyPolicySchedules", "in": "body", "required": true, "description": "Request object that provides the criteria to copy policy schedules to different hotels.", "schema": { "allOf": [ { "$ref": "#/definitions/copyPolicySchedules" } ] } }, { "$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": "Return response for copy policy schedules.", "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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/precheckinRules": { "get": { "summary": "Get Pre Check In rules", "description": "Use this API to get Pre Check In rules.

OperationId:getPreCheckInRules

", "operationId": "getPreCheckInRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "date", "in": "query", "required": false, "description": "Date from which rule type is affected", "type": "string", "format": "date" }, { "name": "ruleType", "in": "query", "required": false, "type": "string", "description": "The rule type on which the Internet Pre Check-In Rule is based. If a reservation has any of the following code, Pre CheckIn rule gets active for that reservation", "uniqueItems": true, "enum": [ "Specials", "MarketCodes", "TimeLimit", "RatePlans", "ReservationTypes", "VIPCodes", "Memberships", "OriginCodes" ] }, { "$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 information regarding Pre Check-In Rule", "schema": { "$ref": "#/definitions/preCheckInRulesDetails" } }, "204": { "description": "PreCheckInRules 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": [ "HotelConfig" ] }, "put": { "summary": "Change Pre Check In rules", "description": "Use this API to update Pre Check In rules.

OperationId:changePreCheckInRules

", "operationId": "changePreCheckInRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "preCheckInRulesToBeChanged", "in": "body", "required": true, "description": "Request object for modifying an existing Pre Check-In Rule", "schema": { "allOf": [ { "$ref": "#/definitions/preCheckInRulesToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete Pre Check In rules", "description": "Use this API to delete Pre Check In rules.

OperationId:removePreCheckInRules

", "operationId": "removePreCheckInRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "ruleType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "The rule type on which the Internet Pre Check-In Rule is based. If a reservation has any of the following code, Pre CheckIn rule gets active for that reservation", "uniqueItems": true, "items": { "type": "string", "enum": [ "Specials", "MarketCodes", "TimeLimit", "RatePlans", "ReservationTypes", "VIPCodes", "Memberships", "OriginCodes" ] }, "required": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "duration", "in": "query", "required": false, "type": "string" }, { "name": "newStartDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "newEndDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "newDuration", "in": "query", "required": false, "type": "string" }, { "name": "level", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Description type for Rule Details", "items": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Code type for Rule Details", "items": { "type": "string" }, "required": false }, { "name": "specialsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "marketCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "absoluteFlag", "in": "query", "required": false, "description": "Absolute Flag value for Time Limit Rule.", "type": "boolean" }, { "name": "endTime", "in": "query", "required": false, "description": "The latest possible Internet check-in time for a reservation based on the Time rule type", "type": "string" }, { "name": "startTime", "in": "query", "required": false, "description": "The earliest possible Internet check-in time for a reservation based on the Time rule type", "type": "string" }, { "name": "daysBeforeArrival", "in": "query", "required": false, "description": "The number of days before the arrival date that the reservation can be checked in through the Internet. A zero will mean the day of arrival", "type": "integer" }, { "name": "daysAfterBooking", "in": "query", "required": false, "description": "The number of days after the booking date that the reservation can be checked in over the Internet", "type": "integer" }, { "name": "hoursPriorToCheckIn", "in": "query", "required": false, "description": "Enter the number of hours before the property's official check-in time that the reservation will be eligible for Internet check in", "type": "integer" }, { "name": "hoursPostCheckIn", "in": "query", "required": false, "description": "Enter the number of hours after the property's official check-in time that the reservation will be eligible for Internet check in", "type": "integer" }, { "name": "ratePlansCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "reservationTypesCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "vIPCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "originCodes", "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": [ "HotelConfig" ] }, "post": { "summary": "Create Pre Check In rules", "description": "Use this API to create Pre Check In rules.

OperationId:postPreCheckInRules

", "operationId": "postPreCheckInRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "preCheckInRulesCriteria", "in": "body", "required": true, "description": "Request object for creating a Pre Check-In Rule", "schema": { "allOf": [ { "$ref": "#/definitions/preCheckInRulesCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/ratePlans/ratings": { "get": { "summary": "Get Rate Plan Ratings", "description": "You can use this API to get Rate Plan Ratings.

OperationId:getRatePlanRatings

", "operationId": "getRatePlanRatings", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "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": "ratePlanCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "rateCategoryCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "ratings", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Possible Rate plan rating values.", "uniqueItems": true, "items": { "type": "string", "enum": [ "MostImportant", "Important", "SomewhatImportant", "LessImportant", "LeastImportant", "NoValueSet" ] }, "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 the rate codes and their rating details.", "schema": { "$ref": "#/definitions/ratePlanRatings" } }, "204": { "description": "RatePlanRatings 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": [ "ReservationConfig" ] }, "put": { "summary": "Change Rate Plan Ratings", "description": "You can use this API to change Rate Plan Ratings.

OperationId:putRatePlanRatings

", "operationId": "putRatePlanRatings", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "ratePlanRatingsInfo", "in": "body", "required": true, "description": "Request object for modifying rate plan codes and their rating details.", "schema": { "allOf": [ { "$ref": "#/definitions/ratePlanRatingsInfo" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/reservationProtectionCondition": { "get": { "summary": "Get Reservation Protection Condition", "description": "Retrieve the configured reservation protection condition for the property.

OperationId:getReservationProtectionCondition

", "operationId": "getReservationProtectionCondition", "parameters": [ { "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" } }, "description": "Response object for fetching Reservation Protection Condition.", "schema": { "$ref": "#/definitions/reservationProtectionCondition" } }, "204": { "description": "Reservation Protection Condition 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": [ "ReservationConfig" ] }, "post": { "summary": "Create Reservation Protection Condition", "description": "This API can be used to create the condition in which a reservation would be automatically marked as protected for the property.

OperationId:postReservationProtectionCondition

", "operationId": "postReservationProtectionCondition", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "reservationProtectionCondition", "in": "body", "required": true, "description": "Request to create the conditions in which a reservation would be automatically marked as protected for the property.", "schema": { "allOf": [ { "$ref": "#/definitions/reservationProtectionCondition" } ] } }, { "$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" } }, "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": [ "ReservationConfig" ] }, "put": { "summary": "Change Reservation Protection Condition", "description": "This API can be used to change the condition in which a reservation would be automatically marked as protected for the property.

OperationId:putReservationProtectionCondition

", "operationId": "putReservationProtectionCondition", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "reservationProtectionCondition", "in": "body", "required": true, "description": "Request to change the conditions in which a reservation would be automatically marked as protected for the property.", "schema": { "allOf": [ { "$ref": "#/definitions/reservationProtectionCondition" } ] } }, { "$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 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": [ "ReservationConfig" ] }, "delete": { "summary": "Delete Reservation Protection Condition", "description": "Deletes the reservation protection condition for the particular hotelId.

OperationId:deleteReservationProtectionCondition

", "operationId": "deleteReservationProtectionCondition", "parameters": [ { "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" } }, "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" } }, "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/roomFeatures/ratings": { "get": { "summary": "Get Room Feature Ratings", "description": "You can use this API to get Room Feature Ratings.

OperationId:getRoomFeatureRatings

", "operationId": "getRoomFeatureRatings", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "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": "featureCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCardRoomFeatures", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "descriptionWildCard", "in": "query", "required": false, "description": "Criteria to specify which rooms features description would be included in the results.", "type": "string" }, { "name": "ratings", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Possible Room Feature rating values.", "uniqueItems": true, "items": { "type": "string", "enum": [ "MostImportant", "Important", "SomewhatImportant", "LessImportant", "LeastImportant", "NoValueSet" ] }, "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 the room features and their rating details.", "schema": { "$ref": "#/definitions/roomFeatureRatingsInfo" } }, "204": { "description": "RoomFeatureRatings 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": [ "ReservationConfig" ] }, "put": { "summary": "Change Room Feature Ratings", "description": "You can use this API to change Room Feature Ratings.

OperationId:putRoomFeatureRatings

", "operationId": "putRoomFeatureRatings", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "roomFeatureRatings", "in": "body", "required": true, "description": "Request object for modifying room features rating details.", "schema": { "allOf": [ { "$ref": "#/definitions/roomFeatureRatings" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/roomSpecials/ratings": { "get": { "summary": "Get Room Special Ratings", "description": "You can use this API to get Room Special Ratings.

OperationId:getRoomSpecialRatings

", "operationId": "getRoomSpecialRatings", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "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": "specialCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCardRoomSpecials", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "descriptionWildCard", "in": "query", "required": false, "description": "Criteria to specify which rooms specials description would be included in the results.", "type": "string" }, { "name": "ratings", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Possible Room special rating values.", "uniqueItems": true, "items": { "type": "string", "enum": [ "MostImportant", "Important", "SomewhatImportant", "LessImportant", "LeastImportant", "NoValueSet" ] }, "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 the room specials and their rating details.", "schema": { "$ref": "#/definitions/roomSpecialRatingsInfo" } }, "204": { "description": "RoomSpecialRatings 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": [ "ReservationConfig" ] }, "put": { "summary": "Change Room Special Ratings", "description": "You can use this API to change Room Special Ratings.

OperationId:putRoomSpecialRatings

", "operationId": "putRoomSpecialRatings", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "roomSpecialRatings", "in": "body", "required": true, "description": "Request object for modifying room specials rating details.", "schema": { "allOf": [ { "$ref": "#/definitions/roomSpecialRatings" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/rooms/ratings": { "get": { "summary": "Get Room Ratings", "description": "You can use this API to get Room Ratings.

OperationId:getRoomRatings

", "operationId": "getRoomRatings", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "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": "roomNumberCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomTypeCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomClassCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "ratings", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Possible room rating values.", "uniqueItems": true, "items": { "type": "string", "enum": [ "MostDesirable", "Desirable", "SomewhatDesirable", "LessDesirable", "LeastDesirable", "NoValueDefined" ] }, "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 the rooms and their rating details.", "schema": { "$ref": "#/definitions/roomRatings" } }, "204": { "description": "RoomRatings 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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/rooms/{roomId}/ratings": { "put": { "summary": "Change Room Ratings", "description": "You can use this API to change Room Ratings.

OperationId:putRoomRatings

", "operationId": "putRoomRatings", "parameters": [ { "name": "roomId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "OPERA Room id" }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "roomRatingsInfo", "in": "body", "required": true, "description": "Request object for modifying room rating details.", "schema": { "allOf": [ { "$ref": "#/definitions/roomRatingsInfo" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/serviceRequestCodes": { "get": { "summary": "Get service request codes", "description": "Use this API to get service request codes.

This API is deprecated. Please use getServiceRequestCode instead

OperationId:getServiceRequestCodes

", "operationId": "getServiceRequestCodes", "deprecated": true, "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "serviceRequestCodes", "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": "inactive", "in": "query", "required": false, "description": "This flag consider inactive/active Service Request codes to search for.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching the service request codes for given search criteria hotel, code, active/inactive.", "schema": { "$ref": "#/definitions/serviceRequestCodesDetails" } }, "204": { "description": "ServiceRequestCodes 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": [ "HotelConfig" ] }, "post": { "summary": "Create service request codes", "description": "Use this API to create service request codes.

OperationId:postServiceRequestCodes

", "operationId": "postServiceRequestCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "serviceRequestCodesCriteria", "in": "body", "required": true, "description": "Request object for creating new service request codes.", "schema": { "allOf": [ { "$ref": "#/definitions/serviceRequestCodesCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete configuration service request codes", "description": "Use this API to delete configuration service request codes.

OperationId:removeServiceRequestCodes

", "operationId": "removeServiceRequestCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "serviceRequestCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Service request code.", "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": [ "HotelConfig" ] }, "put": { "summary": "Change configuration service request codes", "description": "Use this API to update configuration service request codes.

OperationId:changeServiceRequestCodes

", "operationId": "changeServiceRequestCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "serviceRequestCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing existing service request codes.", "schema": { "allOf": [ { "$ref": "#/definitions/serviceRequestCodesToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/serviceRequestCodes/{serviceRequestCode}/priorities": { "get": { "summary": "Get Service Request Code Priorities", "description": "Use this API to get Service Request Code Priorities.

This API is deprecated. Please use getServiceRequestCodePriority instead

OperationId:getServiceRequestCodePriorities

", "operationId": "getServiceRequestCodePriorities", "deprecated": true, "parameters": [ { "name": "serviceRequestCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of service request." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "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 Service Request Code Priorities.", "schema": { "$ref": "#/definitions/serviceRequestCodePrioritiesDetails" } }, "204": { "description": "ServiceRequestCodePriorities 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": [ "HotelConfig" ] }, "put": { "summary": "Change Service Request Code Priorities", "description": "Use this API to update Service Request Code Priorities.

OperationId:changeServiceRequestCodePriorities

", "operationId": "changeServiceRequestCodePriorities", "parameters": [ { "name": "serviceRequestCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of service request." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "serviceRequestCodePrioritiesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Service Request Code Priorities.", "schema": { "allOf": [ { "$ref": "#/definitions/serviceRequestCodePrioritiesToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete Service Request Code Priorities", "description": "Use this API to delete Service Request Code Priorities.

OperationId:removeServiceRequestCodePriorities

", "operationId": "removeServiceRequestCodePriorities", "parameters": [ { "name": "serviceRequestCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of service request." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "$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": [ "HotelConfig" ] }, "post": { "summary": "Create Service Request Code Priorities", "description": "Use this API to create Service Request Code Priorities.

OperationId:postServiceRequestCodePriorities

", "operationId": "postServiceRequestCodePriorities", "parameters": [ { "name": "serviceRequestCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of service request." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "serviceRequestCodePrioritiesCriteria", "in": "body", "required": true, "description": "Request object for creating Service Request Code Priorities.", "schema": { "allOf": [ { "$ref": "#/definitions/serviceRequestCodePrioritiesCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/sourceCodes/": { "get": { "summary": "Get Source Codes", "description": "Use this API to search for Source Codes based on criteria.

OperationId:getSourceCodes

", "operationId": "getSourceCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "List of Hotels.", "items": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "sourceCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "sourceGroupsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Include inactive Source Codes or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch Source Codes.", "schema": { "$ref": "#/definitions/sourceCodesDetails" } }, "204": { "description": "SourceCodes 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": [ "HotelConfig" ] }, "post": { "summary": "Create a Source Code", "description": "Use this API to create a new Source Code. Only one Source Code can be Use this API to created at a time.

OperationId:postSourceCode

", "operationId": "postSourceCode", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "sourceCodeCriteria", "in": "body", "required": true, "description": "Request object that holds the details of Source Code to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/sourceCodeCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/sourceCodes/{sourceCode}": { "put": { "summary": "Update a Source Code", "description": "Use this API to modify a Source Code. Only one Source Code can be modified at a time.

OperationId:changeSourceCode

", "operationId": "changeSourceCode", "parameters": [ { "name": "sourceCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of source." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "sourceCodeToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of Source Code to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/sourceCodeToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete a Source Code", "description": "Use this API to remove a Source Code. Only one Source Code can be Use this API to removed at a time.

OperationId:removeSourceCode

", "operationId": "removeSourceCode", "parameters": [ { "name": "sourceCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of source." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/sourceGroups": { "get": { "summary": "Search for Source Groups ", "description": "Search for Source Groups.

OperationId:getSourceGroups

", "operationId": "getSourceGroups", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "List of Hotels.", "items": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "sourceCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "sourceGroupsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Include inactive Source Groups or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch Source Groups.", "schema": { "$ref": "#/definitions/sourceGroupsDetails" } }, "204": { "description": "SourceGroups 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": [ "HotelConfig" ] }, "post": { "summary": "Create a Source Group", "description": "This API is used to create a new Source Group. Only one Source Code can be Use this API to created at a time.

OperationId:postSourceGroup

", "operationId": "postSourceGroup", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "sourceGroupCriteria", "in": "body", "required": true, "description": "Request object that holds the details of Source Group to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/sourceGroupCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/sourceGroups/{sourceGroupCode}": { "put": { "summary": "Change a Source Group", "description": "This API is used to modify a Source Group. Only one Source Group can be modified at a time.

OperationId:changeSourceGroup

", "operationId": "changeSourceGroup", "parameters": [ { "name": "sourceGroupCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of source group." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "sourceGroupToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of Source Group to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/sourceGroupToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete a Source Group", "description": "Use this API to delete a Source Group. Only one Source Group can be Use this API to deleted at a time.

OperationId:removeSourceGroup

", "operationId": "removeSourceGroup", "parameters": [ { "name": "sourceGroupCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of source group." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "$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": [ "HotelConfig" ] } }, "/hotels/{hotelId}/traceTexts/copy": { "put": { "summary": "Copy trace text ", "description": "Copy an existing Trace Text to create a new one.

OperationId:copyTraceTexts

", "operationId": "copyTraceTexts", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Source Hotel code" }, { "name": "traceTextsCopy", "in": "body", "required": true, "description": "Request object for copying trace texts.", "schema": { "allOf": [ { "$ref": "#/definitions/traceTextsCopy" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/turnawayCodes": { "get": { "summary": "Get Turnaway codes", "description": "Turnaway Codes enable you to record the number of potential reservations that were \"turned away\" and could not be confirmed. Use this API to fetch all configured Turnaway codes for a property.

OperationId:getHotelTurnAwayCodes

", "operationId": "getHotelTurnAwayCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "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": "code", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "turnAwayCodes", "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": "includeInactive", "in": "query", "required": false, "description": "Inactive flag - whether or not to display inactive records", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching hotel turnaway codes", "schema": { "$ref": "#/definitions/hotelTurnAwayCodes" } }, "204": { "description": "HotelTurnAwayCodes 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": [ "ReservationConfig" ] }, "put": { "summary": "Change TurnAway Codes", "description": "Update an existing Turnaway code for a property.

OperationId:putHotelTurnAwayCodes

", "operationId": "putHotelTurnAwayCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "hotelTurnAwayCodes", "in": "body", "required": true, "description": "Request object for modifying hotel turnaway codes.", "schema": { "allOf": [ { "$ref": "#/definitions/hotelTurnAwayCodes" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create Turn Away Codes", "description": "Turnaway Codes enable you to record the number of potential reservations that were \"turned away\" and could not be confirmed. Use this API to create a new Turnaway Code for a property.

OperationId:postHotelTurnAwayCodes

", "operationId": "postHotelTurnAwayCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "hotelTurnAwayCodes", "in": "body", "required": true, "description": "Request object for creating new hotel turnaway code.", "schema": { "allOf": [ { "$ref": "#/definitions/hotelTurnAwayCodes" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/turnawayCodes/{code}": { "delete": { "summary": "Delete an existing turnaway code", "description": "Delete an existing Turnaway code for a property.

OperationId:deleteHotelTurnAwayCodes

", "operationId": "deleteHotelTurnAwayCodes", "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/upsellRules": { "get": { "summary": "Get upsell rules", "description": "This API will retrieve all configured Upgrade Rules. These enable you to configure the rules for calculating the reservation upsell amounts.

OperationId:getUpsellRules

", "operationId": "getUpsellRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "stayDate", "in": "query", "required": false, "description": "The stay date to be searched.", "type": "string", "format": "date" }, { "name": "rule", "in": "query", "required": false, "description": "Wildcard search for the upsell rule code or description.", "type": "string" }, { "name": "searchByRoomType", "in": "query", "required": false, "description": "Signifies whether upsell rules are to be searched based on Room Type or Room Class.", "type": "boolean" }, { "name": "fromCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "toCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "rateCode", "in": "query", "required": false, "description": "Rate code to be searched.", "type": "string" }, { "name": "membershipType", "in": "query", "required": false, "description": "Membership type to be searched.", "type": "string" }, { "name": "channel", "in": "query", "required": false, "description": "Channel to be searched.", "type": "string" }, { "name": "ReservationTypeCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "marketCodes", "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 upsell rules.", "schema": { "$ref": "#/definitions/upsellRules" } }, "204": { "description": "UpsellRules 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": [ "ReservationConfig" ] }, "put": { "summary": "Modify Upsell Rule", "description": "Use this API to modify an existing Upgrade rule for a property.

OperationId:putUpsellRules

", "operationId": "putUpsellRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "upsellRules", "in": "body", "required": true, "description": "Request object for changing existing upsell rules.", "schema": { "allOf": [ { "$ref": "#/definitions/upsellRules" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create Upsell Rules", "description": "Use this API to create a new Upgrade rule for a property. You can upgrade a reservation during the check-in process, but it must match the date ranges, the room types, and the formulas defined in the upgrade rules for the property. A message alerts you to available upgrades and prices.

OperationId:postUpsellRules

", "operationId": "postUpsellRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "upsellRules", "in": "body", "required": true, "description": "Request object for creating new upsell rules.", "schema": { "allOf": [ { "$ref": "#/definitions/upsellRules" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/upsellRules/action/validate": { "put": { "summary": "Test upsell rules", "description": "Use this API to test and see if the rule that you have created works. E.g. you can test by giving a rate code and dates, and see that the rule returns the correct upsell details.

OperationId:testUpsellRules

", "operationId": "testUpsellRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "upsellRulesToTest", "in": "body", "required": true, "description": "Request object for testing upsell rules.", "schema": { "allOf": [ { "$ref": "#/definitions/upsellRulesToTest" } ] } }, { "$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 object for testing upsell rules.", "schema": { "$ref": "#/definitions/upsellRulesToTestDetails" } }, "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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/upsellRules/copy": { "put": { "summary": "Copy upsell rules", "description": "Copy an existing upsell rule, to create a new one.

OperationId:copyUpsellRules

", "operationId": "copyUpsellRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Source Hotel code" }, { "name": "upsellRulesCopy", "in": "body", "required": true, "description": "List of the upsell rules to be copied to hotel code(s).", "schema": { "allOf": [ { "$ref": "#/definitions/upsellRulesCopy" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/hotels/{hotelId}/upsellRules/{ruleCode}": { "delete": { "summary": "Delete an Upsell Rule", "description": "Use this API to delete an existing Upgrade rule for a property.

OperationId:deleteUpsellRules

", "operationId": "deleteUpsellRules", "parameters": [ { "name": "ruleCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "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": [ "ReservationConfig" ] } }, "/hotels/{sourceHotelId}/serviceRequestCodes/copy": { "put": { "summary": " copy configuration service request codes", "description": "Copy configuration service request codes.

OperationId:copyServiceRequestCodes

", "operationId": "copyServiceRequestCodes", "parameters": [ { "name": "sourceHotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of source hotel." }, { "name": "copyServiceRequestCodes", "in": "body", "required": true, "description": "List of the template service request code(s) to be copied.", "schema": { "allOf": [ { "$ref": "#/definitions/copyServiceRequestCodes" } ] } }, { "$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": [ "HotelConfig" ] } }, "/marketCodeTemplates": { "get": { "summary": "Search for Market codes Template", "description": "This API is used to search for a Template Market Code. .

OperationId:getTemplateMarketCodes

", "operationId": "getTemplateMarketCodes", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "templateMarketCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "templateMarketGroupsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "fetch inactive Market Codes.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch template Market Codes.", "schema": { "$ref": "#/definitions/templateMarketCodesDetails" } }, "204": { "description": "TemplateMarketCodes 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": [ "HotelConfig" ] }, "post": { "summary": "Create Market Code Template", "description": "This API is used to create a new Template Market Code. Only one template Market Code can be Use this API to created at a time.

OperationId:postTemplateMarketCode

", "operationId": "postTemplateMarketCode", "parameters": [ { "name": "templateMarketCodeCriteria", "in": "body", "required": true, "description": "Request object that holds the details of template Market Code to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/templateMarketCodeCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/marketCodeTemplates/{marketcode}": { "put": { "summary": "Update a Market Code Template", "description": "This API is used to modify a template Market Code. Only one template Market Code can be modified at a time.

OperationId:changeTemplateMarketCode

", "operationId": "changeTemplateMarketCode", "parameters": [ { "name": "marketcode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market." }, { "name": "templateMarketCodeToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of template Market Code to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/templateMarketCodeToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete a Market Code Template", "description": "This API is used to delete a Template Market Code. .

OperationId:removeTemplateMarketCode

", "operationId": "removeTemplateMarketCode", "parameters": [ { "name": "marketcode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market." }, { "name": "templateMarketCode", "in": "query", "required": false, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] } }, "/marketCodes": { "get": { "summary": "Get Market codes", "description": "Use this API to get Market codes.

OperationId:getMarketCodes

", "operationId": "getMarketCodes", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "marketCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "marketGroupsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Search inactive Market Codes.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch Market Codes.", "schema": { "$ref": "#/definitions/marketCodesDetails" } }, "204": { "description": "MarketCodes 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": [ "HotelConfig" ] } }, "/marketGroupTemplate/{marketGroupCode}": { "post": { "summary": "Create Market Group Template", "description": "This API is used to create a new Template Market Group. Only one template Market Group can be Use this API to created at a time.

OperationId:postTemplateMarketGroup

", "operationId": "postTemplateMarketGroup", "parameters": [ { "name": "marketGroupCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market group." }, { "name": "templateMarketGroupCriteria", "in": "body", "required": true, "description": "Request object that holds the details of template Market Group to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/templateMarketGroupCriteria" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete market Group Template", "description": "You can use this API to delete a template Market Group.

OperationId:removeTemplateMarketGroup

", "operationId": "removeTemplateMarketGroup", "parameters": [ { "name": "marketGroupCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market group." }, { "name": "templateMarketGroup", "in": "query", "required": false, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] }, "put": { "summary": "Change Market Group Template", "description": "This API is used to modify a Template Market Group. Only one Template Market Group can be modified at a time.

OperationId:changeTemplateMarketGroup

", "operationId": "changeTemplateMarketGroup", "parameters": [ { "name": "marketGroupCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of market group." }, { "name": "templateMarketGroupToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of template Market Group to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/templateMarketGroupToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] } }, "/marketGroupTemplates": { "get": { "summary": "Get Market Group Templates", "description": "Use this API to get Market Group Templates.

OperationId:getTemplateMarketGroups

The maximum allowable limit for this API is _.

", "operationId": "getTemplateMarketGroups", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "templateMarketCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "templateMarketGroupsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Include inactive template Market Groups or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch template Market Groups.", "schema": { "$ref": "#/definitions/templateMarketGroupsDetails" } }, "204": { "description": "TemplateMarketGroups 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": [ "HotelConfig" ] } }, "/marketGroups": { "get": { "summary": "Get Market Groups ", "description": "This API is used to search for a Market Group. .

OperationId:getMarketGroups

", "operationId": "getMarketGroups", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "marketCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "marketGroupsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Include inactive Market Groups or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch Market Groups.", "schema": { "$ref": "#/definitions/marketGroupsDetails" } }, "204": { "description": "MarketGroups 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": [ "HotelConfig" ] } }, "/moveReasonCodes": { "get": { "summary": "Get Move Reason Codes", "description": "Use this API to get Move Reason Codes.

OperationId:getMoveReasonCodes

", "operationId": "getMoveReasonCodes", "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 Move Reason Codes.", "schema": { "$ref": "#/definitions/moveReasonCodesDetails" } }, "204": { "description": "MoveReasonCodes 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 Move Reason Codes", "description": "Use this API to create Move Reason Codes.

OperationId:postMoveReasonCodes

", "operationId": "postMoveReasonCodes", "parameters": [ { "name": "moveReasonCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Move Reason Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/moveReasonCodesCriteria" } ] } }, { "$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" ] } }, "/moveReasonCodes/{moveReasonCodesId}": { "put": { "summary": "Change Move Reason Codes", "description": "Use this API to update Move Reason Codes.

OperationId:putMoveReasonCodes

", "operationId": "putMoveReasonCodes", "parameters": [ { "name": "moveReasonCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Move Reason Codes." }, { "name": "moveReasonCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Move Reason Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/moveReasonCodesToBeChanged" } ] } }, { "$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 Move Reason Codes", "description": "Use this API to delete Move Reason Codes.

OperationId:deleteMoveReasonCodes

", "operationId": "deleteMoveReasonCodes", "parameters": [ { "name": "moveReasonCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Move Reason Codes." }, { "name": "moveReasonCodes", "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" ] } }, "/originCodes": { "get": { "summary": "Get Origin Codes", "description": "Use this API to get Origin Codes.

OperationId:getOriginCodes

", "operationId": "getOriginCodes", "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 Origin Codes.", "schema": { "$ref": "#/definitions/originCodesDetails" } }, "204": { "description": "OriginCodes 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 Origin Codes", "description": "Use this API to create Origin Codes.

OperationId:postOriginCodes

", "operationId": "postOriginCodes", "parameters": [ { "name": "originCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Origin Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/originCodesCriteria" } ] } }, { "$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" ] } }, "/originCodes/{originCodesId}": { "put": { "summary": "Change Origin Codes", "description": "Use this API to update Origin Codes.

OperationId:putOriginCodes

", "operationId": "putOriginCodes", "parameters": [ { "name": "originCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of origin codes" }, { "name": "originCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Origin Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/originCodesToBeChanged" } ] } }, { "$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 Origin Codes", "description": "Use this API to delete Origin Codes.

OperationId:deleteOriginCodes

", "operationId": "deleteOriginCodes", "parameters": [ { "name": "originCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of origin codes" }, { "name": "originCodes", "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" ] } }, "/purposeOfStays": { "get": { "summary": "Get Purpose Of Stays", "description": "Use this API to get Purpose Of Stays.

OperationId:getPurposeOfStays

", "operationId": "getPurposeOfStays", "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 Purpose Of Stays.", "schema": { "$ref": "#/definitions/purposeOfStaysDetails" } }, "204": { "description": "PurposeOfStays 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 Purpose Of Stays", "description": "Use this API to create Purpose Of Stays.

OperationId:postPurposeOfStays

", "operationId": "postPurposeOfStays", "parameters": [ { "name": "purposeOfStaysCriteria", "in": "body", "required": true, "description": "Request object for creating Purpose Of Stays.", "schema": { "allOf": [ { "$ref": "#/definitions/purposeOfStaysCriteria" } ] } }, { "$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" ] } }, "/purposeOfStays/{purposeOfStaysId}": { "put": { "summary": "Change Purpose Of Stays", "description": "Use this API to update Purpose Of Stays.

OperationId:putPurposeOfStays

", "operationId": "putPurposeOfStays", "parameters": [ { "name": "purposeOfStaysId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Purpose Of Stays." }, { "name": "purposeOfStaysToBeChanged", "in": "body", "required": true, "description": "Request object for changing Purpose Of Stays.", "schema": { "allOf": [ { "$ref": "#/definitions/purposeOfStaysToBeChanged" } ] } }, { "$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 Purpose Of Stays", "description": "Use this API to delete Purpose Of Stays.

OperationId:deletePurposeOfStays

", "operationId": "deletePurposeOfStays", "parameters": [ { "name": "purposeOfStaysId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Purpose Of Stays." }, { "name": "purposeOfStaysCodes", "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" ] } }, "/scripts": { "get": { "summary": "Get Scripts", "description": "Use this API to get Scripts.

OperationId:getScripts

", "operationId": "getScripts", "parameters": [ { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "croCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "required": false, "type": "string", "description": "Type for Web Reg Card.", "uniqueItems": true, "enum": [ "ClosingScript", "WebRegCard" ] }, { "name": "languageCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "membershipTypesCodes", "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 Scripts.", "schema": { "$ref": "#/definitions/scriptsDetails" } }, "204": { "description": "Scripts 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 Scripts", "description": "Use this API to create Scripts.

OperationId:postScripts

", "operationId": "postScripts", "parameters": [ { "name": "scriptsCriteria", "in": "body", "required": true, "description": "Request object for creating Scripts.", "schema": { "allOf": [ { "$ref": "#/definitions/scriptsCriteria" } ] } }, { "$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" ] } }, "/scripts/{scriptCode}": { "put": { "summary": "Change Scripts", "description": "Use this API to update Scripts.

OperationId:changeScripts

", "operationId": "changeScripts", "parameters": [ { "name": "scriptCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Scripts." }, { "name": "scriptsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Scripts.", "schema": { "allOf": [ { "$ref": "#/definitions/scriptsToBeChanged" } ] } }, { "$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": "Change Scripts", "description": "Use this API to update Scripts.

OperationId:removeScripts

", "operationId": "removeScripts", "parameters": [ { "name": "scriptCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Scripts." }, { "name": "idContext", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "type": "array", "collectionFormat": "multi", "description": "A reference to the type of object defined by the UniqueID element.", "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" ] } }, "/serviceRequestCodes": { "get": { "summary": "Get service request codes", "description": "Use this API to get service request codes.

OperationId:getServiceRequestCode

", "operationId": "getServiceRequestCode", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "serviceRequestCodes", "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": "inactive", "in": "query", "required": false, "description": "This flag consider inactive/active Service Request codes to search for.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching the service request codes for given search criteria hotel, code, active/inactive.", "schema": { "$ref": "#/definitions/serviceRequestCodesDetails" } }, "204": { "description": "ServiceRequestCode 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": [ "HotelConfig" ] } }, "/serviceRequestCodes/priorities": { "get": { "summary": "Get Service Request Code Priorities", "description": "Use this API to get Service Request Code Priorities.

OperationId:getServiceRequestCodePriority

", "operationId": "getServiceRequestCodePriority", "parameters": [ { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "serviceRequestCodes", "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" }, { "name": "hotelIds", "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 Service Request Code Priorities.", "schema": { "$ref": "#/definitions/serviceRequestCodePrioritiesDetails" } }, "204": { "description": "ServiceRequestCodePriority 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": [ "HotelConfig" ] } }, "/services/reservations/status": { "get": { "summary": " ping", "description": "Ping Reservation Configuration Service

OperationId:pingReservationConfigService

", "operationId": "pingReservationConfigService", "parameters": [ { "name": "operaPingInput", "in": "query", "required": false, "type": "string", "description": "Opera Ping request input type" }, { "$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": "pingReservationConfigService 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": [ "ReservationConfig" ] } }, "/templates/locatorCodes": { "get": { "summary": "Get template Locator Codes", "description": "Get existing template Locator Codes

OperationId:getLocatorCodesTemplate

", "operationId": "getLocatorCodesTemplate", "parameters": [ { "name": "locatorCodes", "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": "includeInactive", "in": "query", "required": false, "description": "Indicator that tells whether to include inactive rules in search results.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching locator codes at template level.", "schema": { "$ref": "#/definitions/locatorCodesTemplateInfo" } }, "204": { "description": "LocatorCodesTemplate 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": [ "ReservationConfig" ] }, "put": { "summary": "Change a Locator Code", "description": "Change an existing Locator Code

OperationId:putLocatorCodesTemplate

", "operationId": "putLocatorCodesTemplate", "parameters": [ { "name": "locatorCodesTemplate", "in": "body", "required": true, "description": "Request object for modifying an existing locator code template.", "schema": { "allOf": [ { "$ref": "#/definitions/locatorCodesTemplate" } ] } }, { "$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": [ "ReservationConfig" ] }, "delete": { "summary": "Delete a Locator Code", "description": "Delete the selected Locator Code

OperationId:deleteLocatorCodesTemplate

", "operationId": "deleteLocatorCodesTemplate", "parameters": [ { "name": "locatorCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": true }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create a template Locator Code", "description": "Create a new Locator Code at template level.

OperationId:postLocatorCodesTemplate

", "operationId": "postLocatorCodesTemplate", "parameters": [ { "name": "locatorCodesTemplate", "in": "body", "required": true, "description": "Request object for creating locator code template.", "schema": { "allOf": [ { "$ref": "#/definitions/locatorCodesTemplate" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/templates/sourceCodes": { "get": { "summary": "Get template Source Codes", "description": "Use this API to get template Source Codes.

OperationId:getTemplateSourceCodes

", "operationId": "getTemplateSourceCodes", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "templateSourceCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "templateSourceGroupsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Include inactive template Source Codes or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch template Source Codes.", "schema": { "$ref": "#/definitions/templateSourceCodesDetails" } }, "204": { "description": "TemplateSourceCodes 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": [ "HotelConfig" ] }, "post": { "summary": "Create a Template Source Code", "description": "Use this API to create a new Template Source Code. Only one template Source Code can be created at a time.

OperationId:postTemplateSourceCode

", "operationId": "postTemplateSourceCode", "parameters": [ { "name": "templateSourceCodeCriteria", "in": "body", "required": true, "description": "Request object that holds the details of template Source Code to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/templateSourceCodeCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/templates/sourceCodes/{sourceCode}": { "put": { "summary": "Change a Template Source Code", "description": "Use this API to Modify a Template Source Code. Only one Template Source Code can be modified at a time.

OperationId:changeTemplateSourceCode

", "operationId": "changeTemplateSourceCode", "parameters": [ { "name": "sourceCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of source." }, { "name": "templateSourceCodeToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of template Source Code to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/templateSourceCodeToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete a Template Source Code", "description": " Use this API to remove a Template Source Code.

OperationId:removeTemplateSourceCode

", "operationId": "removeTemplateSourceCode", "parameters": [ { "name": "sourceCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of source." }, { "name": "templateSourceCode", "in": "query", "required": false, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] } }, "/templates/sourceGroups": { "get": { "summary": "Get Template Source Groups", "description": "This API allows you to search for Template Source Groups based on the search criteria in the request.

OperationId:getTemplateSourceGroups

", "operationId": "getTemplateSourceGroups", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "pageNumber", "in": "query", "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "name": "templateSourceCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "templateSourceGroupsCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "includeInactive", "in": "query", "required": false, "description": "Include inactive template Source Groups or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetch template Source Groups.", "schema": { "$ref": "#/definitions/templateSourceGroupsDetails" } }, "204": { "description": "TemplateSourceGroups 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": [ "HotelConfig" ] }, "put": { "summary": "Change Template Source Group", "description": "Use this API to Modify a Template Source Group. Only one Template Source Group can be modified at a time.

OperationId:changeTemplateSourceGroup

", "operationId": "changeTemplateSourceGroup", "parameters": [ { "name": "templateSourceGroupToBeChanged", "in": "body", "required": true, "description": "Request object that holds the details of template Source Group to be changed.", "schema": { "allOf": [ { "$ref": "#/definitions/templateSourceGroupToBeChanged" } ] } }, { "$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": [ "HotelConfig" ] }, "delete": { "summary": "Delete a Template Source Group", "description": " Use this API to remove a Template Source Group.

OperationId:removeTemplateSourceGroup

", "operationId": "removeTemplateSourceGroup", "parameters": [ { "name": "templateSourceGroup", "in": "query", "required": false, "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "$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": [ "HotelConfig" ] }, "post": { "summary": "Create a Template Source Group", "description": "Use this API to create a new Template Source Group. Only one template Source Group can be created at a time.

OperationId:postTemplateSourceGroup

", "operationId": "postTemplateSourceGroup", "parameters": [ { "name": "templateSourceGroupCriteria", "in": "body", "required": true, "description": "Request object that holds the details of template Source Group to be created.", "schema": { "allOf": [ { "$ref": "#/definitions/templateSourceGroupCriteria" } ] } }, { "$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": [ "HotelConfig" ] } }, "/traceTexts": { "get": { "summary": "Get trace texts ", "description": "Fetch all configured Trace Texts for a property.

OperationId:getTraceTexts

", "operationId": "getTraceTexts", "parameters": [ { "name": "excludeGlobal", "in": "query", "default": "false", "required": false, "description": "Flag to tell whether to exclude global traces or not.", "type": "boolean" }, { "name": "departmentCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "hotelIds", "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 trace texts.", "schema": { "$ref": "#/definitions/traceTextsToBeFetched" } }, "204": { "description": "TraceTexts 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": [ "ReservationConfig" ] }, "put": { "summary": "Change trace text ", "description": "Update an existing Trace Text for a property.

OperationId:putTraceTexts

", "operationId": "putTraceTexts", "parameters": [ { "name": "traceTextChanges", "in": "body", "required": true, "description": "Request object for changing trace texts.", "schema": { "allOf": [ { "$ref": "#/definitions/traceTextChanges" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create new trace texts", "description": "When you create traces for reservation, blocks, or AR accounts, you must first set up the standard messages that are available. When you create a trace, these texts can be selected and used as-is, or they can be modified as necessary. When you create a trace text, it must be associated with a department, like Reservations.

OperationId:postTraceTexts

", "operationId": "postTraceTexts", "parameters": [ { "name": "traceTextsToBeCreated", "in": "body", "required": true, "description": "Request object for creating new trace texts.", "schema": { "allOf": [ { "$ref": "#/definitions/traceTextsToBeCreated" } ] } }, { "$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": [ "ReservationConfig" ] }, "delete": { "summary": "Delete trace text ", "description": "Delete an existing Trace Text for a property.

OperationId:deleteTraceTexts

", "operationId": "deleteTraceTexts", "parameters": [ { "name": "hotelId", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Property Code where the trace text belongs to.", "items": { "type": "string" }, "required": false }, { "name": "departmentCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Department Code where the trace text belongs to.", "items": { "type": "string" }, "required": false }, { "name": "traceText", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Trace text value.", "items": { "type": "string" }, "required": false }, { "name": "canDelete", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Determines whether this trace text can be deleted.", "items": { "type": "boolean" }, "required": false }, { "name": "displaySequence", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Display Sequence for the trace text.", "items": { "type": "number" }, "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": [ "ReservationConfig" ] } }, "/turnawayCodes": { "get": { "summary": "Get Template TurnAway Codes", "description": "Retrieve all existing Turnaway Code Templates.

OperationId:getTemplateTurnAwayCodes

", "operationId": "getTemplateTurnAwayCodes", "parameters": [ { "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": "includeInactive", "in": "query", "required": false, "description": "Inactive flag - whether or not to display inactive records.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching template turnaway codes.", "schema": { "$ref": "#/definitions/templateTurnAwayCodes" } }, "204": { "description": "TemplateTurnAwayCodes 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": [ "ReservationConfig" ] }, "put": { "summary": "Change a Turnaway code template", "description": "Update an existing Turnaway Code Template.

OperationId:putTemplateTurnAwayCodes

", "operationId": "putTemplateTurnAwayCodes", "parameters": [ { "name": "templateTurnAwayCodes", "in": "body", "required": true, "description": "Request object for modifying template turnaway codes.", "schema": { "allOf": [ { "$ref": "#/definitions/templateTurnAwayCodes" } ] } }, { "$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": [ "ReservationConfig" ] }, "post": { "summary": "Create Template TurnAway Codes", "description": "Create a new Turnaway Code Template.

OperationId:postTemplateTurnAwayCodes

", "operationId": "postTemplateTurnAwayCodes", "parameters": [ { "name": "templateTurnAwayCodes", "in": "body", "required": true, "description": "Request object for creating new template turnaway code.", "schema": { "allOf": [ { "$ref": "#/definitions/templateTurnAwayCodes" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/turnawayCodes/{turnawayCode}": { "delete": { "summary": "Delete a Turnaway code template", "description": "Delete an existing Turnaway Code Template.

OperationId:deleteTemplateTurnAwayCodes

", "operationId": "deleteTemplateTurnAwayCodes", "parameters": [ { "name": "turnawayCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "" }, { "$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": [ "ReservationConfig" ] } }, "/upsert/hotels/{hotelId}/autoAttachElements": { "put": { "summary": "Create/Update Auto Attach Elements", "description": "Create/update the configuration of an Auto Attach Element Rule that exists on a property.

OperationId:putUpsertAutoAttachElements

", "operationId": "putUpsertAutoAttachElements", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "autoAttachElements", "in": "body", "required": true, "description": "Modify auto attach configuration rule(s).", "schema": { "allOf": [ { "$ref": "#/definitions/autoAttachElements" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/upsert/hotels/{hotelId}/ecoupons": { "put": { "summary": "Create/Change an eCoupon Code", "description": "Create/Update an existing eCoupon Code.

OperationId:putUpsertECouponCodes

", "operationId": "putUpsertECouponCodes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "eCouponCodes", "in": "body", "required": true, "description": "Request object for changing the existing eCoupon codes.", "schema": { "allOf": [ { "$ref": "#/definitions/eCouponCodes" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/upsert/hotels/{hotelId}/globalAlerts": { "put": { "summary": "Create/Change Global Alerts", "description": "Use this API to create/change Global Alerts for a property.

OperationId:putUpsertGlobalAlerts

", "operationId": "putUpsertGlobalAlerts", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "globalAlerts", "in": "body", "required": true, "description": "Request object for modifying an existing Global Alert.", "schema": { "allOf": [ { "$ref": "#/definitions/globalAlerts" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/upsert/hotels/{hotelId}/guaranteeCodeSchedules": { "put": { "summary": "Create/Change an schedule for guarantee codes ", "description": "Use this API to create/update an schedule for guarantee codes.

OperationId:changeUpsertGuaranteeCodeSchedule

", "operationId": "changeUpsertGuaranteeCodeSchedule", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "guaranteeCodeScheduleToBeChanged", "in": "body", "required": true, "description": "Changes the Guarantee Code schedule based on the details provided by the request.", "schema": { "allOf": [ { "$ref": "#/definitions/guaranteeCodeScheduleToBeChanged" } ] } }, { "$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": "Return object for change Guarantee Code schedule.", "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": [ "HotelConfig" ] } }, "/upsert/hotels/{hotelId}/policyschedules": { "put": { "summary": "CCreate/hange a Policy Schedule", "description": "Use this API to create/update an schedule for deposit or cancel policy.

OperationId:changeUpsertPolicySchedule

", "operationId": "changeUpsertPolicySchedule", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "policyScheduleToBeChanged", "in": "body", "required": true, "description": "Changes the Policy schedule based on the details provided by the request.", "schema": { "allOf": [ { "$ref": "#/definitions/policyScheduleToBeChanged" } ] } }, { "$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": "Return object for change policy schedule.", "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": [ "HotelConfig" ] } }, "/upsert/hotels/{hotelId}/upsellRules": { "put": { "summary": "Create/Modify Upsell Rule", "description": "Use this API to create/modify an existing Upgrade rule for a property.

OperationId:putUpsertUpsellRules

", "operationId": "putUpsertUpsellRules", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique OPERA Hotel code" }, { "name": "upsellRules", "in": "body", "required": true, "description": "Request object for changing existing upsell rules.", "schema": { "allOf": [ { "$ref": "#/definitions/upsellRules" } ] } }, { "$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": [ "ReservationConfig" ] } }, "/waitlistCodes": { "get": { "summary": "Get Waitlist Codes", "description": "Use this API to get Waitlist Codes.

OperationId:getWaitlistCodes

", "operationId": "getWaitlistCodes", "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 Waitlist Codes.", "schema": { "$ref": "#/definitions/waitlistCodesDetails" } }, "204": { "description": "WaitlistCodes 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 Waitlist Codes", "description": "Use this API to create Waitlist Codes.

OperationId:postWaitlistCodes

", "operationId": "postWaitlistCodes", "parameters": [ { "name": "waitlistCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Waitlist Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/waitlistCodesCriteria" } ] } }, { "$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" ] } }, "/waitlistCodes/{waitlistCodesId}": { "put": { "summary": "Change Waitlist Codes", "description": "Use this API to update Waitlist Codes.

OperationId:putWaitlistCodes

", "operationId": "putWaitlistCodes", "parameters": [ { "name": "waitlistCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of waitlist codes" }, { "name": "waitlistCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Waitlist Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/waitlistCodesToBeChanged" } ] } }, { "$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 Waitlist Codes", "description": "Use this API to delete Waitlist Codes.

OperationId:deleteWaitlistCodes

", "operationId": "deleteWaitlistCodes", "parameters": [ { "name": "waitlistCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of waitlist codes" }, { "name": "waitlistCodes", "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" ] } }, "/waitlistPriorities": { "get": { "summary": "Get Waitlist Priorities", "description": "Use this API to get Waitlist Priorities.

OperationId:getWaitlistPriorities

", "operationId": "getWaitlistPriorities", "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 Waitlist Priorities.", "schema": { "$ref": "#/definitions/waitlistPrioritiesDetails" } }, "204": { "description": "WaitlistPriorities 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 Waitlist Priorities", "description": "Use this API to create Waitlist Priorities.

OperationId:postWaitlistPriorities

", "operationId": "postWaitlistPriorities", "parameters": [ { "name": "waitlistPrioritiesCriteria", "in": "body", "required": true, "description": "Request object for creating Waitlist Priorities.", "schema": { "allOf": [ { "$ref": "#/definitions/waitlistPrioritiesCriteria" } ] } }, { "$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" ] } }, "/waitlistPriorities/{waitlistPrioritiesId}": { "put": { "summary": "Change Waitlist Priorities", "description": "Use this API to update Waitlist Priorities.

OperationId:putWaitlistPriorities

", "operationId": "putWaitlistPriorities", "parameters": [ { "name": "waitlistPrioritiesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of waitlist priorities" }, { "name": "waitlistPrioritiesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Waitlist Priorities.", "schema": { "allOf": [ { "$ref": "#/definitions/waitlistPrioritiesToBeChanged" } ] } }, { "$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 Waitlist Priorities", "description": "Use this API to delete Waitlist Priorities.

OperationId:deleteWaitlistPriorities

", "operationId": "deleteWaitlistPriorities", "parameters": [ { "name": "waitlistPrioritiesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of waitlist priorities" }, { "name": "waitlistPrioritiesCodes", "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" ] } } }, "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": { "alertCodeTemplates": { "type": "object", "description": "Response object for information regarding alert templates.", "properties": { "alertCodeTemplates": { "description": "Collection of alert code templates and their information.", "$ref": "#/definitions/alertTemplatesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "alertTemplatesType": { "type": "array", "description": "Collection of alert code templates.", "maxItems": 4000, "items": { "$ref": "#/definitions/alertTemplateType" } }, "alertTemplateType": { "type": "object", "description": "Common code type for code, description", "properties": { "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description for the code type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Sequence for alert template.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" }, "isAdvancedAlert": { "description": "Indicates whether the Alert is an Advanced Alert with script.", "type": "boolean" }, "script": { "description": "Script associated with Alert.", "$ref": "#/definitions/scriptType" } } }, "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" ] }, "alertTemplates": { "type": "object", "description": "Request object for modifying the existing alert code templates.", "properties": { "alertTemplates": { "description": "Alert code template group details to be changed.", "$ref": "#/definitions/alertTemplatesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "status": { "type": "object", "description": "Response Body.", "properties": { "warnings": { "$ref": "#/definitions/warningsType" }, "links": { "$ref": "#/definitions/links" } } }, "autoAttachElements": { "type": "object", "description": "Add configuration rule(s) that specify the elements to be automatically attached to the reservation.", "properties": { "autoAttachRules": { "description": "List of configuration rule(s) to be added to the configuration of resort.", "$ref": "#/definitions/autoAttachElementsConfigType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoAttachElementsConfigType": { "type": "array", "description": "Auto attachment rule details.", "maxItems": 4000, "items": { "$ref": "#/definitions/autoAttachRuleType" } }, "autoAttachRuleType": { "type": "object", "description": "Auto attachment rule details.", "properties": { "attachElements": { "description": "The elements attached with the rule.", "$ref": "#/definitions/attachElementsType" }, "basedOn": { "description": "The condition or requirement that the rule type is based on.", "$ref": "#/definitions/resvAutoAttchBasedOn" }, "code": { "description": "The name of the rule.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "The property in which the rule code belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates whether the rule is active or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "attachElementsType": { "type": "object", "description": "Elements to be attached to the rule.", "properties": { "preference": { "description": "Auto attach preference.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/attachPreferenceType" } }, "trace": { "description": "Auto attach trace.", "$ref": "#/definitions/attachTraceType" }, "code": { "description": "List of attached elements codes.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "type": { "description": "Auto attach rule type.", "$ref": "#/definitions/resvAutoAttchTypeCode" }, "description": { "description": "Auto attach rule type description.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "attachPreferenceType": { "type": "object", "description": "Auto attach preference element.", "properties": { "type": { "description": "Preference group.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Preference code..", "type": "string", "minLength": 0, "maxLength": 20 } } }, "attachTraceType": { "type": "object", "description": "Auto attach trace element.", "properties": { "traceText": { "description": "The trace text that will be sent to the selected department(s) when Trace is selected as the Rule Type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "departments": { "description": "List of departments codes.", "$ref": "#/definitions/codeListType" } } }, "codeListType": { "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "resvAutoAttchTypeCode": { "type": "string", "enum": [ "Item", "Product", "ResvPreference", "Trace", "RoomFeatures", "Preference", "Promotions", "AdvancedDiscount" ], "description": "Available only when Reservation Discounts and Advanced Discounts are active" }, "resvAutoAttchBasedOn": { "type": "object", "description": "The Based On information for the rule.", "properties": { "preference": { "description": "Based on Preference information.", "$ref": "#/definitions/attachPreferenceType" }, "special": { "description": "Based on Special information.", "$ref": "#/definitions/attachPreferenceType" }, "membership": { "description": "Membership information.", "$ref": "#/definitions/basedOnMembershipType" }, "condition": { "description": "Indicates if this rule uses advanced filter conditions.", "$ref": "#/definitions/basedOnCondition" }, "ratePlanCode": { "description": "Rate Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomType": { "description": "Room type Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "count": { "description": "A positive numeric number, When the number of adults/children or a reservation equals or exceeds this value, then the items that were selected in the Associated Preferences will automatically be attached to the reservation.", "type": "integer" }, "keywordType": { "description": "The Keyword attached in the profile,when a reservation is made by a profile that has the selected Keyword attached, then the items that were selected in the Associated Preferences will automatically be attached to the reservation.", "type": "string", "minLength": 0, "maxLength": 20 }, "vipCode": { "description": "The associated VIP Status.", "type": "string", "minLength": 0, "maxLength": 20 }, "type": { "description": "Code.", "$ref": "#/definitions/resvAutoAttchBasedOnCode" }, "description": { "description": "description.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "basedOnMembershipType": { "type": "object", "description": "Auto attach based on membership.", "properties": { "membershipType": { "description": "The membership type that will be required for the element type (one that is based on Membership condition) to auto attach to the reservation.", "type": "string", "minLength": 0, "maxLength": 20 }, "level": { "description": "The membership level of the selected membership type.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "basedOnCondition": { "type": "object", "description": "Auto attach based advanced query filter.", "properties": { "queryId": { "description": "The query ID that is used to filter condition.", "type": "number" }, "conditions": { "description": "Conditions for attached rule.", "$ref": "#/definitions/conditionGroupType" } } }, "conditionGroupType": { "type": "object", "properties": { "condition": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/conditionType" } }, "conditionGroup": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/conditionGroupType" } }, "logicalOperator": { "$ref": "#/definitions/logicalOperatorType" } } }, "conditionType": { "type": "object", "properties": { "leftExpression": { "$ref": "#/definitions/expressionFieldType" }, "operator": { "$ref": "#/definitions/expressionOperatorType" }, "rightExpression": { "$ref": "#/definitions/expressionParameterType" }, "logicalOperator": { "$ref": "#/definitions/logicalOperatorType" } } }, "expressionFieldType": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 0, "maxLength": 40 }, "fieldDescription": { "type": "string", "minLength": 0, "maxLength": 2000 }, "tableName": { "type": "string", "minLength": 0, "maxLength": 40 }, "virtual": { "type": "boolean" }, "dataType": { "type": "string", "minLength": 0, "maxLength": 40 }, "lovSelected": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "expressionOperatorType": { "type": "object", "properties": { "operatorName": { "type": "string", "minLength": 0, "maxLength": 40 }, "operatorDescription": { "type": "string", "minLength": 0, "maxLength": 400 }, "parameterSize": { "type": "number" } } }, "expressionParameterType": { "type": "object", "properties": { "parameter": { "type": "array", "maxItems": 3, "items": { "type": "string", "minLength": 0, "maxLength": 40 } }, "functionIdOne": { "type": "number" }, "functionIdTwo": { "type": "number" } } }, "logicalOperatorType": { "type": "string", "enum": [ "And", "Or" ] }, "resvAutoAttchBasedOnCode": { "type": "string", "enum": [ "Membership", "Preference", "RateCode", "RoomType", "MinAdults", "MinChildren", "KeywordType", "Special", "Vip", "Condition" ], "description": "Available only when Keyword Functionality is active." }, "blockConversionsDetails": { "type": "object", "description": "Response object for fetching Block Conversions.", "properties": { "blockConversions": { "description": "Collection of Block Conversions.", "$ref": "#/definitions/blockConversionsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockConversionsType": { "type": "array", "description": "List of Block Conversions.", "maxItems": 4000, "items": { "$ref": "#/definitions/blockConversionType" } }, "blockConversionType": { "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" } } }, "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." } }, "blockConversionsCriteria": { "type": "object", "description": "Request object for creating Block Conversions.", "properties": { "blockConversions": { "description": "Block Conversions to be created.", "$ref": "#/definitions/blockConversionsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockConversionsToBeChanged": { "type": "object", "description": "Request object for changing Block Conversions.", "properties": { "blockConversions": { "description": "Block Conversions to be changed.", "$ref": "#/definitions/blockConversionsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRankingsDetails": { "type": "object", "description": "Response object for fetching Block Rankings.", "properties": { "blockRankings": { "description": "Collection of Block Rankings.", "$ref": "#/definitions/blockRankingsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRankingsType": { "type": "array", "description": "List of Block Rankings.", "maxItems": 4000, "items": { "$ref": "#/definitions/blockRankingType" } }, "blockRankingType": { "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" } } }, "blockRankingsCriteria": { "type": "object", "description": "Request object for creating Block Rankings.", "properties": { "blockRankings": { "description": "Block Rankings to be created.", "$ref": "#/definitions/blockRankingsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "blockRankingsToBeChanged": { "type": "object", "description": "Request object for changing Block Rankings.", "properties": { "blockRankings": { "description": "Block Rankings to be changed.", "$ref": "#/definitions/blockRankingsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "bookingTypesDetails": { "type": "object", "description": "Response object for fetching Booking Types.", "properties": { "bookingTypes": { "description": "Collection of Booking Types.", "$ref": "#/definitions/bookingTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "bookingTypesType": { "type": "array", "description": "List of Booking Types.", "maxItems": 4000, "items": { "$ref": "#/definitions/bookingTypeType" } }, "bookingTypeType": { "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" } } }, "bookingTypesCriteria": { "type": "object", "description": "Request object for creating Booking Types.", "properties": { "bookingTypes": { "description": "Booking Typesto be created.", "$ref": "#/definitions/bookingTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "bookingTypesToBeChanged": { "type": "object", "description": "Request object for changing Booking Types.", "properties": { "bookingTypes": { "description": "Booking Typesto be changed.", "$ref": "#/definitions/bookingTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cancellationCodesDetails": { "type": "object", "description": "Response object for fetching Cancellation Codes.", "properties": { "cancellationCodes": { "description": "Collection of Cancellation Codes.", "$ref": "#/definitions/cancellationCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cancellationCodesType": { "type": "array", "description": "List of Cancellation Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/cancellationCodeType" } }, "cancellationCodeType": { "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" } } }, "cancellationCodesCriteria": { "type": "object", "description": "Request object for creating Cancellation Codes.", "properties": { "cancellationCodes": { "description": "Cancellation Codes to be created.", "$ref": "#/definitions/cancellationCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cancellationCodesToBeChanged": { "type": "object", "description": "Request object for changing Cancellation Codes.", "properties": { "cancellationCodes": { "description": "Cancellation Codes to be changed.", "$ref": "#/definitions/cancellationCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cancellationPolicyDetails": { "type": "object", "description": "Response for fetch Cancellation Policies.", "properties": { "cancelPenalties": { "description": "Collection of Cancellation Policies grouped by hotel.", "type": "object", "properties": { "cancelPenalties": { "description": "Collection of Cancellation Policies grouped by hotel.", "type": "array", "items": { "$ref": "#/definitions/hotelConfigCancelPenaltiesType" } }, "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" } } }, "hotelConfigCancelPenaltiesType": { "type": "object", "description": "The CancelPenalty Configuration class defines configuration of a cancellation policy of the hotel facility.", "properties": { "cancelPenaltyConfig": { "description": "Collection of template Cancel Penalty configurations.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/configCancelPenaltyType" } }, "hotelId": { "description": "Hotel code of the collection of template Cancel Penalty configurations.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "configCancelPenaltyType": { "type": "object", "description": "The CancelPenalty class defines the cancellation policy of the hotel facility.", "properties": { "deadline": { "description": "Cancellation deadline, absolute or relative.", "$ref": "#/definitions/policyDeadlineType" }, "amountPercent": { "description": "Cancellation fee expressed as a fixed amount, or percentage of/or room nights.", "$ref": "#/definitions/policyAmountPercentType" }, "penaltyDescription": { "description": "Text description of the Penalty in a given language.", "type": "string", "minLength": 0, "maxLength": 100 }, "offsetUnit": { "$ref": "#/definitions/offsetUnitType" }, "formattedRule": { "description": "Formatted Text Rule of the Cancellation Penalty.", "type": "string", "minLength": 0, "maxLength": 2000 }, "policyCode": { "description": "Policy Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "manual": { "description": "Flag to indicate if the cancellation policy is manual.", "type": "boolean" }, "nonRefundable": { "description": "Indicates if the amount is refundable if booking is canceled.", "type": "boolean" }, "sequence": { "description": "The sequence number that determines the position of this rule in the Deposit or Cancellation rules LOV.", "type": "integer" }, "managedBy": { "$ref": "#/definitions/managedByOptions" }, "inactive": { "description": "Inactive rules are no longer available for attachment to rate codes, reservation types or reservations; however, they are still recorded in the database for historical purposes.", "type": "boolean" } } }, "policyDeadlineType": { "type": "object", "description": "Cancellation deadline, absolute or relative.", "properties": { "absoluteDeadline": { "description": "Defines the absolute deadline. Either this or the offset attributes may be used. Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "offsetFromArrival": { "description": "The number of days before arrival that allows cancellation without penalties.", "type": "integer" }, "offsetDropTime": { "description": "Time on offset day the cancellation penalties applies. Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "offsetFromBookingDate": { "description": "The number of days after booking deposit must be paid.", "type": "integer" } } }, "policyAmountPercentType": { "type": "object", "description": "Defines the percentage basis for calculating the fee amount or the amount.", "properties": { "basisType": { "description": "Provides the basis for how the amount of the guarantee is calculated.", "$ref": "#/definitions/policyBasisTypeType" }, "nights": { "description": "The number of nights of the hotel stay that are used to calculate the fee amount.", "type": "integer" }, "percent": { "description": "The percentage used to calculate the amount.", "type": "number", "minimum": 0, "maximum": 100 }, "amount": { "description": "A monetary amount.", "type": "number" }, "currencyCode": { "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", "type": "string", "minLength": 3, "maxLength": 3 } } }, "policyBasisTypeType": { "type": "string", "description": "Full Amount.", "enum": [ "FlatAmount", "Percentage", "Nights", "NightPercentage", "FullAmount" ] }, "offsetUnitType": { "type": "string", "description": "Indicates deadline offset unit type.", "enum": [ "Year", "Month", "Day", "Hour" ] }, "cancellationPolicyCriteria": { "type": "object", "description": "Request object that holds the details of Cancellation Policy to be created.", "properties": { "cancelPenalty": { "description": "Details of Cancellation Policy to be created.", "$ref": "#/definitions/hotelConfigCancelPenaltiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cancellationPolicyToBeChanged": { "type": "object", "description": "Request object that holds the details of Cancellation Policy to be changed.", "properties": { "cancelPenalty": { "description": "Details of Cancellation Policy to be changed.", "$ref": "#/definitions/hotelConfigCancelPenaltiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateCancellationPolicyCriteria": { "type": "object", "description": "Request object that holds the details of template Cancellation Policy to be created.", "properties": { "templateCancelPenalty": { "description": "Details of template Cancellation Policy to be created.", "$ref": "#/definitions/configCancelPenaltyType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateCancellationPolicyToBeChanged": { "type": "object", "description": "Request object that holds the details of template Cancellation Policy to be changed.", "properties": { "templateCancelPenalty": { "description": "Details of template Cancellation Policy to be changed.", "$ref": "#/definitions/configCancelPenaltyType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateCancellationPolicyDetails": { "type": "object", "description": "Response for fetch template Cancellation Policies.", "properties": { "templateCancelPenaltyConfigs": { "description": "Collection of template Cancel Penalty rules.", "type": "array", "items": { "$ref": "#/definitions/configCancelPenaltyType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "depositPolicyDetails": { "type": "object", "description": "Response for fetch Deposit Policies in hotel level.", "properties": { "depositPolicies": { "description": "Collection of Deposit Policies grouped by hotel.", "type": "object", "properties": { "depositPolicies": { "description": "Collection of Deposit Policies grouped by hotel.", "type": "array", "items": { "$ref": "#/definitions/hotelConfigDepositPoliciesType" } }, "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" } } }, "hotelConfigDepositPoliciesType": { "type": "object", "description": "Collection of Deposit Policy Configurations of a hotel.", "properties": { "depositPolicy": { "description": "Collection of Deposit Policy configurations of a hotel.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/configDepositPolicyType" } }, "hotelId": { "description": "Hotel code of the collection of Deposit Policy configurations.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "configDepositPolicyType": { "type": "object", "description": "Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.", "properties": { "amountPercent": { "description": "Payment expressed as a fixed amount, or a percentage of/or room nights.", "$ref": "#/definitions/policyAmountPercentType" }, "deadline": { "description": "Payment deadline, absolute or relative.", "$ref": "#/definitions/policyDeadlineType" }, "description": { "description": "Text description of the Payment in a given language.", "type": "string", "minLength": 0, "maxLength": 100 }, "depositReceiptNo": { "description": "Receipt number associated with the deposit policy", "type": "integer" }, "transactionDate": { "description": "Transaction Date associated with the deposit policy", "type": "string", "format": "date", "maxLength": 8 }, "depositReqReversed": { "description": "Flag to indicate if deposit policy is reversed", "type": "boolean" }, "formattedRule": { "description": "Formatted Text Rule of the deposit policy.", "type": "string", "minLength": 0, "maxLength": 2000 }, "typeOfCharges": { "description": "Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both", "$ref": "#/definitions/depositCancelRevenueType" }, "policyCode": { "description": "Deposit Policy Code", "type": "string", "minLength": 0, "maxLength": 20 }, "manual": { "description": "Flag to indicate if the cancellation policy is manual.", "type": "boolean" }, "sequence": { "description": "The sequence number that determines the position of this rule in the Deposit or Cancellation rules LOV.", "type": "integer" }, "inactive": { "description": "Inactive rules are no longer available for attachment to rate codes, reservation types or reservations; however, they are still recorded in the database for historical purposes.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "depositCancelRevenueType": { "type": "string", "description": "The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.", "enum": [ "Rooms", "Catering", "All" ] }, "depositPolicyCriteria": { "type": "object", "description": "Request object that holds the details of hotel level Deposit Policy to be created.", "properties": { "depositPolicy": { "description": "Details of hotel level Deposit Policy to be created.", "$ref": "#/definitions/hotelConfigDepositPoliciesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "depositPolicyToBeChanged": { "type": "object", "description": "Request object that holds the details of hotel level Deposit Policy to be changed.", "properties": { "depositPolicy": { "description": "Details of hotel level Deposit Policy to be changed.", "$ref": "#/definitions/hotelConfigDepositPoliciesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateDepositPolicyCriteria": { "type": "object", "description": "Request object that holds the details of template Deposit Policy to be created.", "properties": { "templateDepositPolicy": { "description": "Details of template Deposit Policy to be created.", "$ref": "#/definitions/configDepositPolicyType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateDepositPolicyToBeChanged": { "type": "object", "description": "Request object that holds the details of template Deposit Policy to be changed.", "properties": { "templateDepositPolicy": { "description": "Details of template Deposit Policy to be changed.", "$ref": "#/definitions/configDepositPolicyType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateDepositPolicyDetails": { "type": "object", "description": "Response for fetch template Deposit Policies.", "properties": { "templateDepositPolicies": { "description": "Collection of template Deposit policies.", "type": "array", "items": { "$ref": "#/definitions/configDepositPolicyType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "discountReasonsDetails": { "type": "object", "description": "Response object for fetching Discount Reasons.", "properties": { "discountReasons": { "description": "Collection of Discount Reasons.", "$ref": "#/definitions/discountReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "discountReasonsType": { "type": "array", "description": "List of Discount Reasons.", "maxItems": 4000, "items": { "$ref": "#/definitions/discountReasonType" } }, "discountReasonType": { "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" }, "advancedDiscountRules": { "description": "Collection of advanced discount rules.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/advancedDiscountRuleType" } }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "advancedDiscountRuleType": { "type": "object", "description": "Information representation of Advacned Discount Rule.", "properties": { "minOccupancyPercentage": { "description": "Minimum Property Occupancy Percentage.", "type": "number", "minimum": 0, "maximum": 100 }, "maxOccupancyPercentage": { "description": "Maximum Property Occupancy Percentage.", "type": "number", "minimum": 0, "maximum": 100 }, "discountPercentage": { "description": "Discount Percentage.", "type": "number", "minimum": 0, "maximum": 100 }, "calculationRule": { "description": "Calculation Rule Type.", "$ref": "#/definitions/advancedDiscountCalculationType" } } }, "advancedDiscountCalculationType": { "type": "string", "description": "Simple type for allowed advanced discount calculation type.", "enum": [ "PercentageOfADR" ] }, "discountReasonsCriteria": { "type": "object", "description": "Request object for creating Discount Reasons.", "properties": { "discountReasons": { "description": "Discount Reasons to be created.", "$ref": "#/definitions/discountReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "discountReasonsToBeChanged": { "type": "object", "description": "Request object for changing Discount Reasons.", "properties": { "discountReasons": { "description": "Discount Reasons to be changed.", "$ref": "#/definitions/discountReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "eCouponCodes": { "type": "object", "description": "Response object to fetch eCoupon codes.", "properties": { "eCouponCodes": { "$ref": "#/definitions/eCouponCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "eCouponCodesType": { "type": "array", "description": "List of eCoupon Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/eCouponCodeType" } }, "eCouponCodeType": { "type": "object", "description": "eCoupon code detailed information.", "properties": { "hotel": { "description": "Property for which the eCoupon code belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "eCoupon code to be configured.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the eCoupon code to be configured.", "type": "string", "minLength": 0, "maxLength": 2000 }, "postingRoom": { "description": "Pseudo Room where the postings should be diverted.", "type": "string", "minLength": 0, "maxLength": 20 }, "defaultQty": { "description": "Defines the default quantity of the eCoupon Code.", "type": "integer" }, "ratePlans": { "description": "Ratecodes.", "$ref": "#/definitions/codeListType" }, "welcomeOffer": { "description": "Determines whether the eCoupon Code is eligible for Welcome Offer or not.", "type": "boolean" }, "displaySequence": { "description": "Sequence for eCoupon code.", "type": "number" }, "inactive": { "description": "Indicates whether the eCoupon code is active or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "entryPointsDetails": { "type": "object", "description": "Response object for fetching Entry Points.", "properties": { "entryPoints": { "description": "Collection of Entry Points.", "$ref": "#/definitions/entryPointsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "entryPointsType": { "type": "array", "description": "List of Entry Points.", "maxItems": 4000, "items": { "$ref": "#/definitions/entryPointType" } }, "entryPointType": { "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" } } }, "entryPointsCriteria": { "type": "object", "description": "Request object for creating Entry Points.", "properties": { "entryPoints": { "description": "Entry Pointsto be created.", "$ref": "#/definitions/entryPointsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "entryPointsToBeChanged": { "type": "object", "description": "Request object for changing Entry Points.", "properties": { "entryPoints": { "description": "Entry Pointsto be changed.", "$ref": "#/definitions/entryPointsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "globalActionCodesDetails": { "type": "object", "description": "Response object for fetching Global Action Codes.", "properties": { "globalActionCodes": { "description": "Collection of Global Action Codes.", "$ref": "#/definitions/globalActionCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "globalActionCodesType": { "type": "array", "description": "List of Global Action Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/globalActionCodeType" } }, "globalActionCodeType": { "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": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "globalActionCodesCriteria": { "type": "object", "description": "Request object for creating Global Action Codes.", "properties": { "globalActionCodes": { "description": "Global Action Codes to be created.", "$ref": "#/definitions/globalActionCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "globalActionCodesToBeChanged": { "type": "object", "description": "Request object for changing Global Action Codes.", "properties": { "globalActionCodes": { "description": "Global Action Codes to be changed.", "$ref": "#/definitions/globalActionCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "globalAlerts": { "type": "object", "description": "Request object for creating a new Global Alert.", "properties": { "globalAlerts": { "description": "Global Alert details to be created.", "$ref": "#/definitions/globalAlertsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "globalAlertsType": { "type": "array", "description": "Collection of property level global alert details with attached global alert types.", "maxItems": 4000, "items": { "$ref": "#/definitions/globalAlertType" } }, "globalAlertType": { "type": "object", "description": "A property level global alert attached with global alert types.", "properties": { "alertId": { "type": "number" }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "alertCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "type": "string", "minLength": 0, "maxLength": 2000 }, "area": { "type": "string", "minLength": 0, "maxLength": 20 }, "queryId": { "type": "number" }, "notifications": { "$ref": "#/definitions/notificationType" }, "conditions": { "$ref": "#/definitions/conditionGroupType" }, "welcomeOffer": { "description": "Determines the Global Alert is a Welcome Offer Alert or not.", "type": "boolean" }, "stopCheckInCheckOut": { "description": "Indicates the Reservation Stop Check In/Check Out Global Alert.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "notificationType": { "type": "object", "description": "Global Alert Notification type for Screen, Print, email and text", "properties": { "screen": { "type": "boolean" }, "print": { "type": "boolean" }, "printerName": { "type": "string", "minLength": 0, "maxLength": 20 }, "reportName": { "type": "string", "minLength": 0, "maxLength": 80 }, "email": { "type": "boolean" }, "emailAddress": { "type": "string", "minLength": 0, "maxLength": 100 }, "department": { "type": "string", "minLength": 0, "maxLength": 20 }, "textMessage": { "type": "boolean" }, "phoneNumber": { "$ref": "#/definitions/phoneNumberType" } } }, "phoneNumberType": { "type": "string", "description": "Phone number", "minLength": 0, "maxLength": 40 }, "globalAlertsInfo": { "type": "object", "description": "Response object for fetching Global Alerts.", "properties": { "globalAlerts": { "description": "Collection of Global Alerts information details", "$ref": "#/definitions/globalAlertsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "globalAlertsCopy": { "type": "object", "description": "Request object for copying Global Alerts.", "properties": { "copyInstructions": { "description": "Copy Global Alert type to copy from one Hotel to another Hotel.", "$ref": "#/definitions/copyGlobalAlertType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "copyGlobalAlertType": { "type": "object", "description": "Copy Global Alerts criteria from one property to another property", "properties": { "resvAlertIds": { "description": "Each Reservation Alert details copy to target properties", "$ref": "#/definitions/uniqueIDListType" }, "targetHotelCodes": { "description": "Copy and store reservation alert details on the destination properties", "$ref": "#/definitions/codeListType" } } }, "uniqueIDListType": { "type": "array", "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { "$ref": "#/definitions/uniqueID_Type" } }, "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 } } }, "templateGuaranteeCodesDetails": { "type": "object", "description": "Response for fetch template Guarantee Codes.", "properties": { "guaranteeCodes": { "description": "Collection of Guarantee Codes.", "$ref": "#/definitions/templateGuaranteeCodesType" }, "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" } } }, "templateGuaranteeCodesType": { "type": "array", "description": "Guarantee Code details.", "maxItems": 4000, "items": { "$ref": "#/definitions/guaranteeConfigType" } }, "guaranteeConfigType": { "type": "object", "description": "Specifies Guarantee Code attributes.", "properties": { "description": { "description": "Description of the Guarantee Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "requirements": { "description": "Specifies various requirements for the guarantee code.", "$ref": "#/definitions/guaranteeRequirementsType" }, "distributionAttributes": { "description": "Specifies various distribution attributes for the guarantee code.", "$ref": "#/definitions/distributionAttributesType" }, "shortDescription": { "description": "Brief description of the Guarantee Code.", "$ref": "#/definitions/translationTextType80" }, "paymentTypes": { "description": "Specifies various payment types for the guarantee code.", "$ref": "#/definitions/paymentTypesType" }, "guaranteeCode": { "description": "Code assigned to the Guarantee.", "type": "string", "minLength": 0, "maxLength": 20 }, "onHold": { "description": "If true indicates this Guarantee Code is used only to hold the inventory during reservation process.", "type": "boolean" }, "reserveInventory": { "description": "If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.", "type": "boolean" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" }, "lateArrival": { "description": "Represents the late arrival time.", "type": "string" }, "massCancellation": { "description": "Defines the Auto mass cancellation criteria (i.e. number of days pending before auto cancellation).", "type": "object", "properties": { "autoCancel": { "description": "If true indicates, the reservations having this Guarantee Code will be auto canceled for which the credit card info is missing for number of days specified in pending days.", "type": "boolean" }, "pendingDays": { "description": "Number of days, with in which the credit card info should be received for the reservation, using this guarnatee code, to avoid auto cancellation.", "type": "integer" } } }, "inactive": { "description": "Indicates the reservation type is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "guaranteeRequirementsType": { "type": "object", "description": "Specifies various requirement for the guarantee code.", "properties": { "requirementCode": { "description": "Requirement Code.", "type": "string" }, "cancellation": { "description": "When true indicates cancellation on the reservation is required for this guarantee code.", "type": "boolean" }, "phoneNumber": { "description": "When true indicates phone number on the reservation is required for this guarantee code.", "type": "boolean" }, "address": { "description": "When true indicates address on the reservation is required for this guarantee code.", "type": "boolean" }, "creditCard": { "description": "When true indicates Credit Card on the reservation is required for this guarantee code.", "type": "boolean" }, "arrivalTime": { "description": "When true indicates arrival Time on the reservation is required for this guarantee code.", "type": "boolean" }, "deposit": { "description": "When true indicates deposit is required for this guarantee code.", "type": "boolean" }, "email": { "description": "When true indicates an email on the reservation is required for this guarantee code.", "type": "boolean" }, "travelAgent": { "description": "When true indicates attaching a travel agent profile on the reservation is required for this guarantee code.", "type": "boolean" }, "company": { "description": "When true indicates attaching a company profile on the reservation is required for this guarantee code.", "type": "boolean" } } }, "translationTextType80": { "type": "object", "description": "Contains Multiple translated texts and language codes.", "properties": { "defaultText": { "description": "Default text with Character length from 0 to 80.", "type": "string", "minLength": 0, "maxLength": 80 }, "translatedTexts": { "description": "List of translated text and language codes.", "$ref": "#/definitions/translationsTextType" } } }, "paymentTypesType": { "type": "array", "description": "Payment card code like AX,VI etc.", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "templateGuaranteeCodeCriteria": { "type": "object", "description": "Request object that holds the details of template Guarantee Code to be created.", "properties": { "templateGuaranteeCode": { "description": "Details of template Guarantee Code to be created.", "$ref": "#/definitions/guaranteeConfigType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateGuaranteeCodeToBeChanged": { "type": "object", "description": "Request object that holds the details of template Guarantee Code to be changed.", "properties": { "templateGuaranteeCode": { "description": "Details of template Guarantee Code to be changed.", "$ref": "#/definitions/guaranteeConfigType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guaranteeCodesDetails": { "type": "object", "description": "Response for fetch Guarantee Codes.", "properties": { "guaranteeCodes": { "description": "Collection of Guarantee Codes.", "type": "array", "items": { "$ref": "#/definitions/guaranteeCodesType" } }, "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" } } }, "guaranteeCodesType": { "type": "object", "description": "The Collection of Guarantee Codes Type.", "properties": { "guaranteeCode": { "description": "Guarantee Code details.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/guaranteeConfigType" } }, "hotelId": { "description": "Hotel code for fetched template Guarantee Codes.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "guaranteeCodeCriteria": { "type": "object", "description": "Request object that holds the details of Guarantee Code to be created.", "properties": { "guaranteeCode": { "description": "Details of Guarantee Code to be created.", "$ref": "#/definitions/guaranteeConfigType" }, "hotelId": { "description": "Hotel code for Guarantee Code.", "$ref": "#/definitions/codeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "codeType": { "type": "string", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", "minLength": 0, "maxLength": 20 }, "guaranteeCodeToBeChanged": { "type": "object", "description": "Request object that holds the details of Guarantee Code to be changed.", "properties": { "guaranteeCode": { "description": "Details of Guarantee Code to be changed.", "$ref": "#/definitions/guaranteeConfigType" }, "hotelId": { "description": "Hotel code for Guarantee Code.", "$ref": "#/definitions/codeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestMessageTemplates": { "type": "object", "description": "Response object for information regarding guest message templates.", "properties": { "guestMessageTemplates": { "$ref": "#/definitions/guestMessageTemplatesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestMessageTemplatesType": { "type": "array", "description": "Collection of guest messages templates.", "maxItems": 4000, "items": { "$ref": "#/definitions/guestMessageTemplateType" } }, "guestMessageTemplateType": { "type": "object", "description": "A template for guest message.", "properties": { "code": { "description": "Code for the guest message type", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description for guest message type.", "$ref": "#/definitions/translationTextType2000" }, "displaySequence": { "description": "Sequence for guest message template.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "alertCodes": { "type": "object", "description": "Response object for information regarding alert templates.", "properties": { "alerts": { "description": "Collection of alert code templates and their information.", "$ref": "#/definitions/alertCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "alertCodesType": { "type": "array", "description": "Collection of hotel level alert codes with attached alert types.", "maxItems": 4000, "items": { "$ref": "#/definitions/alertCodeType" } }, "alertCodeType": { "type": "object", "description": "Common code type for code, description", "properties": { "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description for the code type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Sequence for alert.", "type": "number" }, "hotelId": { "description": "Hotel Code for alert.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" }, "isAdvancedAlert": { "description": "Indicates whether the Alert is an Advanced Alert with script.", "type": "boolean" }, "script": { "description": "Script associated with Alert.", "$ref": "#/definitions/scriptType" } } }, "autoAttachElementsConfig": { "type": "object", "description": "Response object for the configuration rules that specify the elements to be automatically attached to the reservation.", "properties": { "autoAttachRules": { "description": "List of auto attachment configuration rules.", "$ref": "#/definitions/autoAttachElementsConfigType" }, "masterInfoList": { "description": "Refer to Generic common types document.", "type": "array", "items": { "$ref": "#/definitions/masterInfoType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "masterInfoType": { "type": "object", "properties": { "codeInfo": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/codeInfoType" } }, "codeType": { "$ref": "#/definitions/masterType" } } }, "codeInfoType": { "type": "object", "description": "", "properties": { "description": { "type": "string", "minLength": 0, "maxLength": 80 }, "addtionalCodeInfo": { "$ref": "#/definitions/addtionalCodeInfoType" }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "addtionalCodeInfoType": { "type": "array", "description": "Holds name of additional code information", "maxItems": 4000, "items": { "type": "object", "properties": { "name": { "description": "Holds name of additional code information", "$ref": "#/definitions/masterInfoCodeDetailType" }, "value": { "description": "Holds value of additional code information", "type": "string", "minLength": 0, "maxLength": 2000 } } } }, "masterInfoCodeDetailType": { "type": "string", "enum": [ "LongDescription", "ShortDescription" ] }, "masterType": { "type": "string", "enum": [ "Country", "State", "AddressType", "PhoneType", "RateCategory", "CalculationRule", "PostingRythym", "BillingInstruction", "TransactionCode", "DisplaySet", "MailingActions", "DistanceType", "District", "Territory", "FiscalRegion", "InventoryItem", "Package", "RoomFeaturePreference", "SpecialPreference", "Promotion", "Department", "ReservationPreference", "FacilityTask", "RoomType", "RateCode", "OutOfOrderReason", "Block" ] }, "autoAttachElementsCopy": { "type": "object", "properties": { "autoAttachRule": { "type": "array", "description": "List of the auto attach configuration rule(s) to be copied.", "items": { "$ref": "#/definitions/copyConfigurationCodeType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "copyConfigurationCodeType": { "type": "object", "description": "Information needed to copy configuration code from one property to the other.", "properties": { "targetHotelCode": { "description": "Property to which configuration code type to be copied to.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "sourceHotelCode": { "description": "Code that is to be copied.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Source hotel code from which code is to be copied from.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "reservationColorsResponse": { "type": "object", "description": "Response object for fetch reservation colors.", "properties": { "reservationColors": { "description": "Reservation colors.", "$ref": "#/definitions/reservationColorsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "reservationColorsType": { "type": "array", "description": "Collection of reservation colors.", "maxItems": 4000, "items": { "$ref": "#/definitions/reservationColorType" } }, "reservationColorType": { "type": "object", "description": "Property level reservation color information.", "properties": { "hotelId": { "description": "Property which the reservation color belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "colorCode": { "description": "Code to identify reservation color.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of reservation color.", "$ref": "#/definitions/translationTextType2000" }, "displaySequence": { "description": "Display sequence for reservation color.", "type": "number" }, "inactive": { "description": "Indicates if reservation color is inactive.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "reservationColorsToChange": { "type": "object", "description": "Request object to change reservation colors.", "properties": { "reservationColors": { "description": "Criteria to change reservation colors.", "$ref": "#/definitions/reservationColorsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "eCouponCodesCopy": { "type": "object", "description": "Request object to copy the existing eCoupon codes from source property to the selected target properties.", "properties": { "eCouponCopy": { "description": "Request object to copy the eCoupon codes from source property to the selected target properties.", "$ref": "#/definitions/eCouponCopyType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "eCouponCopyType": { "type": "object", "description": "Copy eCoupons from one Property to one or multiple properties.", "properties": { "hotelId": { "description": "Source property from which copy operation will happen.", "type": "string", "minLength": 0, "maxLength": 20 }, "eCouponCodes": { "description": "List of eCoupon codes to copy from souce to list of target properties.", "$ref": "#/definitions/codeListType" }, "targetHotelCodes": { "description": "List of target properties to which the selected eCoupons will be copied.", "$ref": "#/definitions/codeListType" } } }, "guaranteeCodeScheduleCriteria": { "type": "object", "description": "Creates the Guarantee Code schedule based on the details provided by the request.", "properties": { "guaranteeCodeSchedule": { "description": "Details of the Guarantee Code schedule to be created.", "$ref": "#/definitions/createGuaranteeCodeScheduleType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "createGuaranteeCodeScheduleType": { "type": "object", "description": "The Guarantee Code Schedule Type.", "properties": { "scheduleDetail": { "description": "Guarantee Code Schedule details.", "$ref": "#/definitions/createGuaranteeCodeScheduleDetailType" }, "hotelId": { "description": "Hotel code for the Guarantee Code Schedule.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "createGuaranteeCodeScheduleDetailType": { "type": "object", "description": "The Guarantee Code Schedule detail Type.", "properties": { "timeSpan": { "description": "Time span the Guarantee Code schedule is applicable.", "$ref": "#/definitions/timeSpanType" }, "guaranteeCode": { "description": "Guarantee code and description for this schedule.", "$ref": "#/definitions/codeDescriptionType" }, "applicableCodes": { "description": "Guarantee Code is applicable to hotel, rate plan, Guarantee Code, Credit Rating etc. for this schedule.", "$ref": "#/definitions/createPolicyApplicableCodesType" }, "sequence": { "description": "Sequence for the schedule.", "type": "number" }, "override": { "description": "override the schedule?", "type": "boolean" }, "inactive": { "description": "schedule Inactive?", "type": "boolean" } } }, "timeSpanType": { "type": "object", "description": "Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.", "properties": { "startDate": { "type": "string", "format": "date", "maxLength": 8 }, "endDate": { "type": "string", "format": "date", "maxLength": 8 }, "duration": { "type": "string" } } }, "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 } } }, "createPolicyApplicableCodesType": { "type": "object", "description": "The object contains the applicatble code for creation of new policy schedule.", "properties": { "hotelId": { "description": "create schedule for this Hotel code.", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanCodes": { "description": "create schedule for this Rate plan code.", "$ref": "#/definitions/codeListType" }, "guaranteeCodes": { "description": "create schedule for these Guarantee codes.", "$ref": "#/definitions/codeListType" }, "blockId": { "description": "Block Id for creation.", "$ref": "#/definitions/uniqueID_Type" }, "blockCode": { "description": "create schedule for this Block code.", "type": "string", "minLength": 0, "maxLength": 20 }, "creditRatings": { "description": "create schedule for this Credit Rating.", "$ref": "#/definitions/codeListType" }, "seasonCode": { "description": "create schedule for this Season Code.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "guaranteeCodeSchedulesDetails": { "type": "object", "description": "Return response for fetch guarantee code schedules based on request.", "properties": { "guaranteeCodeSchedules": { "description": "Collection of guarantee code schedules.", "$ref": "#/definitions/guaranteeCodeSchedulesType" }, "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" } } }, "guaranteeCodeSchedulesType": { "type": "array", "description": "Unique Identifer for the Guarantee Code schedule.", "maxItems": 4000, "items": { "$ref": "#/definitions/guaranteeCodeScheduleType" } }, "guaranteeCodeScheduleType": { "type": "object", "description": "The Guarantee Code Schedule Type.", "properties": { "scheduleId": { "description": "Unique Identifer for the Guarantee Code schedule.", "$ref": "#/definitions/uniqueID_Type" }, "scheduleDetail": { "description": "Guarantee Code Schedule details.", "$ref": "#/definitions/guaranteeCodeScheduleDetailType" }, "hotelId": { "description": "Hotel code for the Guarantee Code Schedule.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "guaranteeCodeScheduleDetailType": { "type": "object", "description": "The Guarantee Code Schedule detail Type.", "properties": { "timeSpan": { "description": "Time span the Guarantee Code schedule is applicable.", "$ref": "#/definitions/timeSpanType" }, "guaranteeCode": { "description": "Guarantee code and description for this schedule.", "$ref": "#/definitions/codeDescriptionType" }, "applicableCodes": { "description": "Guarantee Code is applicable to hotel, rate plan, Guarantee Code, Credit Rating etc. for this schedule.", "$ref": "#/definitions/policyApplicableCodesType" }, "sequence": { "description": "Sequence for the schedule.", "type": "number" }, "override": { "description": "override the schedule?", "type": "boolean" }, "inactive": { "description": "schedule Inactive?", "type": "boolean" } } }, "policyApplicableCodesType": { "type": "object", "description": "The object contains usage of the Policy Schedule detail Type.", "properties": { "hotelId": { "description": "Schedule is used by this Hotel code.", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanCodes": { "description": "Schedule is used by this Rate plan code.", "$ref": "#/definitions/codeListType" }, "guaranteeCodes": { "description": "Schedule is used by this Guarantee code.", "$ref": "#/definitions/codeListType" }, "blockIds": { "description": "Block Id to search.", "$ref": "#/definitions/uniqueIDListType" }, "blockCode": { "description": "Schedule is used by this Block code.", "type": "string", "minLength": 0, "maxLength": 20 }, "creditRatings": { "description": "Schedule is used by this Credit Rating.", "$ref": "#/definitions/codeListType" }, "seasonCode": { "description": "Schedule is used by this Season Code.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "guaranteeCodeScheduleToBeChanged": { "type": "object", "description": "Changes the Guarantee Code schedule based on the details provided by the request.", "properties": { "guaranteeCodeSchedule": { "description": "details of the the Guarantee Code schedule to be changed.", "$ref": "#/definitions/guaranteeCodeScheduleType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "copyGuaranteeCodeSchedules": { "type": "object", "description": "Request object that provides the criteria to copy Guarantee Code schedules to different hotels.", "properties": { "criteria": { "description": "Copy object type to copy the Guarantee Code schedules.", "$ref": "#/definitions/copySchedulesCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "copySchedulesCriteriaType": { "type": "object", "description": "The Criteria for Schedules to be copied.", "properties": { "copySchedules": { "description": "The copy Schedule criteria type.", "$ref": "#/definitions/copySchedulesType" } } }, "copySchedulesType": { "type": "object", "description": "The collection of Schedules to be copied.", "properties": { "schedule": { "description": "The collection of schedule copy criteria.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/copyScheduleType" } }, "hotelId": { "description": "Hotel Code for the Copy Policy operation.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "copyScheduleType": { "type": "object", "description": "The Schedule copy criteria type.", "properties": { "scheduleId": { "description": "Unique Identifer for the schedule.", "$ref": "#/definitions/uniqueID_Type" }, "targetHotelCodes": { "description": "List of Hotel Codes where this schedule will be copied.", "$ref": "#/definitions/codeListType" } } }, "retrievedGuestMessages": { "type": "object", "description": "Response object for information regarding guest message.", "properties": { "guestMessages": { "$ref": "#/definitions/guestMessageCodesType" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestMessageCodesType": { "type": "array", "description": "Collection of guest messages with attached guest message types.", "maxItems": 4000, "items": { "$ref": "#/definitions/guestMessageCodeType" } }, "guestMessageCodeType": { "type": "object", "description": "A template for guest message.", "properties": { "code": { "description": "Code for the guest message type", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description for guest message type.", "$ref": "#/definitions/translationTextType2000" }, "displaySequence": { "description": "Sequence for guest message template.", "type": "number" }, "hotelId": { "description": "Sequence for guest message.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "guestMessages": { "type": "object", "description": "Request object for creating a new guest message.", "properties": { "guestMessages": { "$ref": "#/definitions/guestMessageCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "locatorCodesInfo": { "type": "object", "description": "Response object for fetching locator codes.", "properties": { "locatorCodes": { "$ref": "#/definitions/locatorCodesType" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "locatorCodesType": { "type": "array", "description": "Collection of locator codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/locatorCodeType" } }, "locatorCodeType": { "type": "object", "description": "Common code type for code, description", "properties": { "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description for the code type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Sequence for locator code", "type": "number" }, "inactive": { "description": "Indicates whether the locator code is active or not", "type": "boolean" }, "hotelId": { "description": "Property for which the locator code belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "locatorCodes": { "type": "object", "description": "Request object for modifying an existing locator code.", "properties": { "locatorCodes": { "$ref": "#/definitions/locatorCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "marketCodeCriteria": { "type": "object", "description": "Request object that holds the details of Market Code to be created.", "properties": { "marketCode": { "description": "Details of Market Code to be created.", "$ref": "#/definitions/marketCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "marketCodeType": { "type": "object", "description": "Common code type for code, description, seq and inactive", "properties": { "description": { "description": "Description for the code type.", "$ref": "#/definitions/translationTextType50" }, "sequence": { "description": "Display sequence for the code type.", "type": "integer" }, "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" }, "hotelId": { "description": "Hotel code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "groupCode": { "description": "Group code to which this code type belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "displayColor": { "description": "Display color for the marketing type.", "$ref": "#/definitions/marketCodeColorsType" }, "transactionCode": { "description": "Transaction code to map Market Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "printGroup": { "description": "Print Group to map Market Code.", "$ref": "#/definitions/marketCodePrintGroupType" }, "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "translationTextType50": { "type": "object", "description": "Contains Multiple translated texts and language codes.", "properties": { "defaultText": { "description": "Default text with Character length from 0 to 50.", "type": "string", "minLength": 0, "maxLength": 50 }, "translatedTexts": { "description": "List of translated text and language codes.", "$ref": "#/definitions/translationsTextType" } } }, "marketCodeColorsType": { "type": "string", "description": "Simple type for Market Code colors.", "enum": [ "None", "Blue", "Red", "Cyan", "Green", "Black", "White", "Gray", "Yellow", "Deepteal", "Sunsetorange", "Aquasky", "Mochabrown", "Mossgreen", "Rosewood", "Claybrown", "Softlavender", "Olivegold", "Plumpurple", "Mistblue", "Forestgreen", "Dustyviolet", "Oceanblue", "Copper" ] }, "marketCodePrintGroupType": { "type": "string", "description": "Group Print Group Type for country code Sweden.", "enum": [ "Business", "Conference", "Leisure", "BusinessSe", "ConferenceSe", "LeisureSe", "GroupSe" ] }, "marketCodeToBeChanged": { "type": "object", "description": "Request object that holds the details of Market Code to be changed.", "properties": { "marketCode": { "description": "Details of Market Code to be changed.", "$ref": "#/definitions/marketCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "marketGroupCriteria": { "type": "object", "description": "Request object that holds the details of Market Group to be created.", "properties": { "marketGroup": { "description": "Details of Market Group to be created.", "$ref": "#/definitions/marketGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "marketGroupType": { "type": "object", "description": "Common code type for code, description, seq and inactive", "properties": { "description": { "description": "Description for the code type.", "$ref": "#/definitions/translationTextType50" }, "sequence": { "description": "Display sequence for the code type.", "type": "integer" }, "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" }, "hotelId": { "description": "Hotel code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "marketCodes": { "description": "Collection of Market Codes.", "$ref": "#/definitions/marketCodesType" }, "ranking": { "description": "Rank of the Market Group used for Room Assignment Optimization", "$ref": "#/definitions/mGRank" }, "upgradable": { "description": "Defines if the Market Group is eligible for auto upgrade for Room Assignment Optimization", "type": "boolean" }, "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "marketCodesType": { "type": "array", "description": "Collection of Market Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/marketCodeType" } }, "mGRank": { "type": "integer", "minimum": 1, "maximum": 999 }, "marketGroupToBeChanged": { "type": "object", "description": "Request object that holds the details of Market Group to be changed.", "properties": { "marketGroup": { "description": "Details of Market Group to be changed.", "$ref": "#/definitions/marketGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipLevelRatingsInfo": { "type": "object", "description": "Response object for fetching the membership levels and their rating details.", "properties": { "membershipLevelRatingsInfo": { "description": "List of membership levels and their rating details.", "$ref": "#/definitions/membershipLevelRatingsInfoType" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipLevelRatingsInfoType": { "type": "array", "description": "Collection of membership levels and their ratings.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipLevelRatingInfoType" } }, "membershipLevelRatingInfoType": { "type": "object", "description": "Rating details for membership levels.", "properties": { "hotelId": { "description": "Property code of the membership level.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipType": { "description": "Membership type of the membership level.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipLevel": { "description": "Membership Level along with its description whose rating is fetched.", "$ref": "#/definitions/codeDescriptionType" }, "rating": { "description": "Ratings associated with the membership level.", "$ref": "#/definitions/membershipLevelRatingType" } } }, "membershipLevelRatingType": { "type": "integer", "description": "The desired rating for membership level, up to 4 numeric values." }, "membershipLevelRatings": { "type": "object", "description": "Request object for modifying membership levels rating details.", "properties": { "membershipLevelRatingsInfo": { "$ref": "#/definitions/membershipLevelRatingsInfoType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "policySchedulesDetails": { "type": "object", "description": "Return response for fetch policy schedules based on request.", "properties": { "policySchedules": { "description": "Collection of policy schedules.", "$ref": "#/definitions/policySchedulesType" }, "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" } } }, "policySchedulesType": { "type": "array", "description": "Unique Identifer for the policy schedule.", "maxItems": 4000, "items": { "$ref": "#/definitions/policyScheduleType" } }, "policyScheduleType": { "type": "object", "description": "The Policy Schedule Type.", "properties": { "scheduleId": { "description": "Unique Identifer for the policy schedule.", "$ref": "#/definitions/uniqueID_Type" }, "scheduleDetail": { "description": "Policy Schedule details.", "$ref": "#/definitions/policyScheduleDetailType" }, "hotelId": { "description": "Hotel code for the Policy Schedules.", "type": "string", "minLength": 0, "maxLength": 20 }, "policyType": { "description": "Policy Type for the Policy Schedules.", "$ref": "#/definitions/policyTypeType" }, "tieredDepositRules": { "type": "array", "description": "Collection of tiered deposit rule policies that are configured and attached to a tiered policy schedule. To be used when OPERA Control parameter 'Tiered Deposit Schedules' is active.", "maxItems": 4000, "items": { "$ref": "#/definitions/tieredDepositRule" } }, "tieredCancelPenalties": { "type": "array", "description": "Collection of tiered cancellation penalties that are configured and attached to a tiered policy schedule. To be used when OPERA Control parameter 'Tiered Cancellation Schedules' is active.", "maxItems": 4000, "items": { "$ref": "#/definitions/tieredCancelPenalty" } }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "policyScheduleDetailType": { "type": "object", "description": "The Policy Schedule detail Type.", "properties": { "timeSpan": { "description": "Time span the policy schedule is applicable.", "$ref": "#/definitions/timeSpanType" }, "policy": { "description": "Policy code and description for this schedule.", "$ref": "#/definitions/codeDescriptionType" }, "applicableCodes": { "description": "Policy is applicable to hotel, rate plan, Guarantee Code, Block, Credit Rating etc. for this schedule.", "$ref": "#/definitions/policyApplicableCodesType" }, "sequence": { "description": "Sequence for the schedule.", "type": "number" }, "override": { "description": "override the schedule?", "type": "boolean" }, "inactive": { "description": "schedule Inactive?", "type": "boolean" }, "ignoreGracePeriod": { "description": "Applicable to Cancel Penalties only. When true, the configured Grace Period and Grace Period Advanced Booking Window will not be considered when determining the applicable cancel penalty date.", "type": "boolean" } } }, "policyTypeType": { "type": "string", "description": "Simple type for Policy type.", "enum": [ "Deposit", "Cancellation" ] }, "policyScheduleCriteria": { "type": "object", "description": "Creates the Policy schedule based on the details provided by the request.", "properties": { "policySchedule": { "description": "Details of the the policy schedule to be created.", "$ref": "#/definitions/policyScheduleType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "policyScheduleToBeChanged": { "type": "object", "description": "Changes the Policy schedule based on the details provided by the request.", "properties": { "policySchedule": { "description": "details of the the policy schedule to be changed.", "$ref": "#/definitions/policyScheduleType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "copyPolicySchedules": { "type": "object", "description": "Request object that provides the criteria to copy policy schedules to different hotels.", "properties": { "criteria": { "description": "Copy object type to copy the policy schedules.", "$ref": "#/definitions/copySchedulesCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "preCheckInRulesDetails": { "type": "object", "description": "Response object for information regarding Pre Check-In Rule", "properties": { "preCheckInRules": { "description": "Collection of Pre Check-In Rule and their information", "$ref": "#/definitions/preCheckInRulesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "preCheckInRulesType": { "type": "array", "description": "Collection of Pre Check-In Rules List", "maxItems": 4000, "items": { "$ref": "#/definitions/preCheckInRuleType" } }, "preCheckInRuleType": { "type": "object", "description": "A Internet Pre Check-In Rule", "properties": { "timeSpan": { "description": "The period for the Pre Check-In Rule", "$ref": "#/definitions/timeSpanType" }, "newTimeSpan": { "description": "The new period for the Pre Check-In Rule. Only used to Change the time span.", "$ref": "#/definitions/timeSpanType" }, "memberships": { "description": "The rule type on which the Internet Pre Check-In Rule is based", "$ref": "#/definitions/membershipTypeLevelListType" }, "specials": { "description": "Only available when Time is selected as the Rule Type", "$ref": "#/definitions/codeListType" }, "marketCodes": { "description": "Only available when Time is selected as the Rule Type", "$ref": "#/definitions/codeListType" }, "timeLimit": { "description": "The rule type on which the Internet Pre Check-In Rule is based", "$ref": "#/definitions/preCheckInTimeRuleTypes" }, "ratePlans": { "description": "The rule type on which the Internet Pre Check-In Rule is based", "$ref": "#/definitions/codeListType" }, "reservationTypes": { "description": "The rule type on which the Internet Pre Check-In Rule is based", "$ref": "#/definitions/codeListType" }, "vIPCodes": { "description": "The rule type on which the Internet Pre Check-In Rule is based", "$ref": "#/definitions/codeListType" }, "originCodes": { "description": "The rule type on which the Internet Pre Check-In Rule is based", "$ref": "#/definitions/codeListType" }, "hotelId": { "description": "Hotel code of Pre Check-In Rule to be searched", "type": "string", "minLength": 0, "maxLength": 20 }, "ruleType": { "description": "Internet Pre Check-In Rule for the property, are based on the rule types.", "$ref": "#/definitions/preCheckInRuleTypeType" } } }, "membershipTypeLevelListType": { "type": "array", "description": "Code type for Rule Details", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipTypeLevelType" } }, "membershipTypeLevelType": { "type": "object", "properties": { "type": { "description": "Code type for Rule Details", "type": "string", "minLength": 0, "maxLength": 20 }, "level": { "description": "Description type for Rule Details", "type": "string", "minLength": 0, "maxLength": 20 } } }, "preCheckInTimeRuleTypes": { "type": "object", "properties": { "endTime": { "description": "The latest possible Internet check-in time for a reservation based on the Time rule type", "type": "string" }, "startTime": { "description": "The earliest possible Internet check-in time for a reservation based on the Time rule type", "type": "string" }, "daysBeforeArrival": { "description": "The number of days before the arrival date that the reservation can be checked in through the Internet. A zero will mean the day of arrival", "type": "integer" }, "daysAfterBooking": { "description": "The number of days after the booking date that the reservation can be checked in over the Internet", "type": "integer" }, "hoursPriorToCheckIn": { "description": "Enter the number of hours before the property's official check-in time that the reservation will be eligible for Internet check in", "type": "integer" }, "hoursPostCheckIn": { "description": "Enter the number of hours after the property's official check-in time that the reservation will be eligible for Internet check in", "type": "integer" }, "absoluteFlag": { "description": "Absolute Flag value for Time Limit Rule.", "type": "boolean" } } }, "preCheckInRuleTypeType": { "type": "string", "description": "The rule type on which the Internet Pre Check-In Rule is based. If a reservation has any of the following code, Pre CheckIn rule gets active for that reservation", "enum": [ "Specials", "MarketCodes", "TimeLimit", "RatePlans", "ReservationTypes", "VIPCodes", "Memberships", "OriginCodes" ] }, "preCheckInRulesToBeChanged": { "type": "object", "description": "Request object for modifying an existing Pre Check-In Rule", "properties": { "preCheckInRules": { "description": "Pre Check-In Rule to be changed", "$ref": "#/definitions/preCheckInRulesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "preCheckInRulesCriteria": { "type": "object", "description": "Request object for creating a Pre Check-In Rule", "properties": { "preCheckInRules": { "description": "Pre Check-In Rule to be created", "$ref": "#/definitions/preCheckInRulesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ratePlanRatings": { "type": "object", "description": "Response object for fetching the rate codes and their rating details.", "properties": { "ratePlanRatingsInfo": { "description": "List of rate plan codes and their rating details.", "$ref": "#/definitions/ratePlanRatingsInfoType" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ratePlanRatingsInfoType": { "type": "array", "description": "Collection of rate plan Codes and their ratings.", "maxItems": 4000, "items": { "$ref": "#/definitions/ratePlanRatingInfoType" } }, "ratePlanRatingInfoType": { "type": "object", "description": "Rating details for a rate plan.", "properties": { "hotelId": { "description": "Property code of the rate plan codes.", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlan": { "description": "Rate Plan Code and its description", "$ref": "#/definitions/codeDescriptionType" }, "rateCategory": { "description": "Rate category of the rate code.", "$ref": "#/definitions/codeDescriptionType" }, "rating": { "description": "Ratings associated with the rate code.", "$ref": "#/definitions/ratePlanRatingType" } } }, "ratePlanRatingType": { "type": "string", "description": "Possible Rate plan rating values.", "enum": [ "MostImportant", "Important", "SomewhatImportant", "LessImportant", "LeastImportant", "NoValueSet" ] }, "ratePlanRatingsInfo": { "type": "object", "description": "Request object for modifying rate plan codes and their rating details.", "properties": { "ratePlanRatingsInfo": { "$ref": "#/definitions/ratePlanRatingsInfoType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomFeatureRatingsInfo": { "type": "object", "description": "Response object for fetching the room features and their rating details.", "properties": { "roomFeatureRatingsInfo": { "description": "List of rooms and their rating details.", "$ref": "#/definitions/roomFeatureRatingsInfoType" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomFeatureRatingsInfoType": { "type": "array", "description": "Collection of rooms features and their ratings.", "maxItems": 4000, "items": { "$ref": "#/definitions/roomFeatureRatingInfoType" } }, "roomFeatureRatingInfoType": { "type": "object", "description": "Rating details for room features.", "properties": { "hotelId": { "description": "Property code of the room feature.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomFeature": { "description": "Room feature along with its description whose rating is fetched.", "$ref": "#/definitions/codeDescriptionType" }, "rating": { "description": "Ratings associated with the room feature.", "$ref": "#/definitions/roomFeatureRatingType" } } }, "roomFeatureRatingType": { "type": "string", "description": "Possible Room Feature rating values.", "enum": [ "MostImportant", "Important", "SomewhatImportant", "LessImportant", "LeastImportant", "NoValueSet" ] }, "roomFeatureRatings": { "type": "object", "description": "Request object for modifying room features rating details.", "properties": { "roomFeatureRatingsInfo": { "$ref": "#/definitions/roomFeatureRatingsInfoType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomSpecialRatingsInfo": { "type": "object", "description": "Response object for fetching the room specials and their rating details.", "properties": { "roomSpecialRatingsInfo": { "description": "List of room specials and their rating details.", "$ref": "#/definitions/roomSpecialRatingsInfoType" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomSpecialRatingsInfoType": { "type": "array", "description": "Collection of rooms specials and their ratings.", "maxItems": 4000, "items": { "$ref": "#/definitions/roomSpecialRatingInfoType" } }, "roomSpecialRatingInfoType": { "type": "object", "description": "Rating details for room Specials.", "properties": { "hotelId": { "description": "Property code of the room Special.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomSpecial": { "description": "Room Special along with its description whose rating is fetched.", "$ref": "#/definitions/codeDescriptionType" }, "rating": { "description": "Ratings associated with the room special.", "$ref": "#/definitions/roomSpecialRatingType" } } }, "roomSpecialRatingType": { "type": "string", "description": "Possible Room special rating values.", "enum": [ "MostImportant", "Important", "SomewhatImportant", "LessImportant", "LeastImportant", "NoValueSet" ] }, "roomSpecialRatings": { "type": "object", "description": "Request object for modifying room specials rating details.", "properties": { "roomSpecialRatingsInfo": { "$ref": "#/definitions/roomSpecialRatingsInfoType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomRatings": { "type": "object", "description": "Response object for fetching the rooms and their rating details.", "properties": { "roomRatingsInfo": { "description": "List of rooms and their rating details.", "$ref": "#/definitions/roomRatingsInfoType" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "roomRatingsInfoType": { "type": "array", "description": "Collection of rooms and their ratings.", "maxItems": 4000, "items": { "$ref": "#/definitions/roomRatingInfoType" } }, "roomRatingInfoType": { "type": "object", "description": "Rating details for a room.", "properties": { "hotelId": { "description": "Property code of the rooms.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomId": { "description": "Room number whose ratings are fetched.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomClass": { "description": "Room Class of the room.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomType": { "description": "Room Type and its description of the room.", "$ref": "#/definitions/codeDescriptionType" }, "rating": { "description": "Ratings associated with the room.", "$ref": "#/definitions/roomRatingType" } } }, "roomRatingType": { "type": "string", "description": "Possible room rating values.", "enum": [ "MostDesirable", "Desirable", "SomewhatDesirable", "LessDesirable", "LeastDesirable", "NoValueDefined" ] }, "roomRatingsInfo": { "type": "object", "description": "Request object for modifying room rating details.", "properties": { "roomRatingsInfo": { "$ref": "#/definitions/roomRatingsInfoType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "serviceRequestCodesDetails": { "type": "object", "description": "Response object for fetching the service request codes for given search criteria hotel, code, active/inactive.", "properties": { "serviceRequestCodes": { "description": "Collection of service request codes.", "$ref": "#/definitions/serviceRequestCodesType" }, "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" } } }, "serviceRequestCodesType": { "type": "array", "description": "Details for service request code type.", "maxItems": 4000, "items": { "$ref": "#/definitions/serviceRequestCodeType" } }, "serviceRequestCodeType": { "type": "object", "description": "Service request code details.", "properties": { "hotelId": { "description": "Hotel code for the service request", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Code for the service request", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description for the service request", "type": "string", "minLength": 0, "maxLength": 100 }, "deptCode": { "description": "Department code for the service request", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Tells service request is active or not", "type": "boolean" }, "editable": { "description": "Service request is editable or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "serviceRequestCodesCriteria": { "type": "object", "description": "Request object for creating new service request codes.", "properties": { "serviceRequestCodes": { "description": "Collection of service request codes to be created.", "$ref": "#/definitions/serviceRequestCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "serviceRequestCodesToBeChanged": { "type": "object", "description": "Request object for changing existing service request codes.", "properties": { "serviceRequestCodes": { "description": "Collection of service request codes to be changed.", "$ref": "#/definitions/serviceRequestCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "serviceRequestCodePrioritiesDetails": { "type": "object", "description": "Response object for fetching Service Request Code Priorities.", "properties": { "serviceRequestCodePriorities": { "description": "Collection of Service Request Code Priorities.", "$ref": "#/definitions/serviceRequestCodePrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "serviceRequestCodePrioritiesType": { "type": "array", "description": "List of Service Request Code Priorities.", "maxItems": 4000, "items": { "$ref": "#/definitions/serviceRequestCodePriorityType" } }, "serviceRequestCodePriorityType": { "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" }, "hotelId": { "description": "Hotel of the record.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "serviceRequestCodePrioritiesToBeChanged": { "type": "object", "description": "Request object for changing Service Request Code Priorities.", "properties": { "serviceRequestCodePriorities": { "description": "Service Request Code Priorities to be changed.", "$ref": "#/definitions/serviceRequestCodePrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "serviceRequestCodePrioritiesCriteria": { "type": "object", "description": "Request object for creating Service Request Code Priorities.", "properties": { "serviceRequestCodePriorities": { "description": "Service Request Code Priorities to be created.", "$ref": "#/definitions/serviceRequestCodePrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "sourceCodesDetails": { "type": "object", "description": "Response for fetch Source Codes.", "properties": { "sourceCodes": { "description": "Collection of Source Codes.", "$ref": "#/definitions/sourceCodesType" }, "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" } } }, "sourceCodesType": { "type": "array", "description": "Collection of Source Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/sourceCodeType" } }, "sourceCodeType": { "type": "object", "description": "Common code type for code, description, seq and inactive", "properties": { "description": { "description": "Description for the code type.", "$ref": "#/definitions/translationTextType50" }, "sequence": { "description": "Display sequence for the code type.", "type": "integer" }, "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" }, "hotelId": { "description": "Hotel code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "groupCode": { "description": "Group code to which this code type belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "sourceCodeCriteria": { "type": "object", "description": "Request object that holds the details of Source Code to be created.", "properties": { "sourceCode": { "description": "Details of Source Code to be created.", "$ref": "#/definitions/sourceCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "sourceCodeToBeChanged": { "type": "object", "description": "Request object that holds the details of Source Code to be changed.", "properties": { "sourceCode": { "description": "Details of Source Code to be changed.", "$ref": "#/definitions/sourceCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "sourceGroupsDetails": { "type": "object", "description": "Response for fetch Source Groups.", "properties": { "sourceGroups": { "description": "Collection of Source Groups.", "type": "array", "items": { "$ref": "#/definitions/sourceGroupType" } }, "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" } } }, "sourceGroupType": { "type": "object", "description": "Common code type for code, description, seq and inactive", "properties": { "description": { "description": "Description for the code type.", "$ref": "#/definitions/translationTextType50" }, "sequence": { "description": "Display sequence for the code type.", "type": "integer" }, "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" }, "hotelId": { "description": "Hotel code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "sourceCodes": { "description": "Collection of Source Codes.", "$ref": "#/definitions/sourceCodesType" }, "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "sourceGroupCriteria": { "type": "object", "description": "Request object that holds the details of Source Group to be created.", "properties": { "sourceGroup": { "description": "Details of Source Group to be created.", "$ref": "#/definitions/sourceGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "sourceGroupToBeChanged": { "type": "object", "description": "Request object that holds the details of Source Group to be changed.", "properties": { "sourceGroup": { "description": "Details of Source Group to be changed.", "$ref": "#/definitions/sourceGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "traceTextsCopy": { "type": "object", "description": "Request object for copying trace texts.", "properties": { "criteria": { "description": "Criteria for copying trace texts.", "$ref": "#/definitions/copyTraceTextsCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "copyTraceTextsCriteriaType": { "type": "object", "description": "Copy Trace texts criteria type to copy multiple trace texts from one Hotel to another Hotel.", "properties": { "targetHotels": { "description": "List of hotel codes for which the trace texts needs to be copied.", "$ref": "#/definitions/hotelCodeListType" }, "traceTexts": { "description": "List of Trace Texts that will be copied.", "$ref": "#/definitions/traceTextsType" } } }, "hotelCodeListType": { "type": "array", "description": "Hotel code.", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "traceTextsType": { "type": "array", "description": "Collection of trace texts.", "maxItems": 4000, "items": { "$ref": "#/definitions/traceTextType" } }, "traceTextType": { "type": "object", "description": "Type provides trace text information.", "properties": { "hotelId": { "description": "Property Code where the trace text belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "departmentCode": { "description": "Department Code where the trace text belongs to.", "type": "string", "minLength": 0, "maxLength": 10 }, "traceText": { "description": "Trace text value.", "type": "string", "minLength": 0, "maxLength": 2000 }, "canDelete": { "description": "Determines whether this trace text can be deleted.", "type": "boolean" }, "displaySequence": { "description": "Display Sequence for the trace text.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "hotelTurnAwayCodes": { "type": "object", "description": "Response object for fetching hotel turnaway codes", "properties": { "turnAwayCodes": { "description": "Collection of turnaway codes.", "$ref": "#/definitions/hotelTurnAwayCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "hotelTurnAwayCodesType": { "type": "array", "description": "Turnaway code details for hotels.", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelTurnAwayCodeType" } }, "hotelTurnAwayCodeType": { "type": "object", "description": "Base details common between hotel and template TurnAway codes.", "properties": { "code": { "description": "TurnAway code", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the TurnAway code.", "$ref": "#/definitions/translationTextType50" }, "displaySequence": { "description": "Sequence of TurnAway code.", "type": "number" }, "turnAwayType": { "description": "TurnAway type. e.g. Denial,Regret.", "$ref": "#/definitions/turnAwayTypeType" }, "inactive": { "description": "Inactive flag for a TurnAway code.", "type": "boolean" }, "canDelete": { "description": "Determines whether this TurnAway code can be deleted.", "type": "boolean" }, "hotelId": { "description": "Hotel code that the turnaway code belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "turnAwayTypeType": { "type": "string", "description": "Simple Type for TurnAwayType Types.", "enum": [ "Denial", "Regret" ] }, "upsellRules": { "type": "object", "description": "Response object for fetching upsell rules.", "properties": { "upsellRules": { "description": "Collection of upsell rules fetched.", "$ref": "#/definitions/configUpsellRulesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "configUpsellRulesType": { "type": "array", "description": "This type holds a collection of upsell rules.", "maxItems": 4000, "items": { "$ref": "#/definitions/configUpsellRuleType" } }, "configUpsellRuleType": { "type": "object", "description": "This gives detailed information about an upsell rule.", "properties": { "description": { "description": "Description gives the description for the upsell rule.", "type": "string", "minLength": 0, "maxLength": 40 }, "upsellByRoomType": { "description": "Signifies whether upsell rule involves upselling from room type to room type or from room class to room class.", "type": "boolean" }, "fromRoomTypeOrFromRoomClass": { "description": "The \"from\" room type or room class for the upsell rule. This is the original room type/room class category.", "type": "string", "minLength": 0, "maxLength": 20 }, "toRoomTypeOrToRoomClass": { "description": "The \"to\" room type or room class for the upsell rule. This is the room type that the original room type/room class will be upsold to.", "type": "string", "minLength": 0, "maxLength": 20 }, "startDate": { "description": "This represents the begin date of the date range for which the upsell rule is valid.", "type": "string", "format": "date", "maxLength": 8 }, "endDate": { "description": "This represents the end date of the date range for which the upsell rule is valid.", "type": "string", "format": "date", "maxLength": 8 }, "rateCodes": { "description": "This specifies the rate code for which the upsell rule is being created.", "$ref": "#/definitions/codeListType" }, "rateCategories": { "description": "This specifies the rate category for which the upsell rule is being created.", "$ref": "#/definitions/codeListType" }, "membershipTypes": { "description": "This specifies the membership types/levels for which the upsell rule is applicable.", "$ref": "#/definitions/codeListType" }, "channels": { "description": "This specifies the channels (e.g. Web channel or some other type of distribution channel) for which the upsell rule is applicable.", "$ref": "#/definitions/codeListType" }, "reservationTypes": { "description": "This specifies the reservation types for which the upsell rule is applicable.", "$ref": "#/definitions/codeListType" }, "marketCodes": { "description": "This specifies the market codes for which the upsell rule is applicable.", "$ref": "#/definitions/codeListType" }, "upsellByOccupancyLevels": { "description": "Signifies whether upsell rule is by occupancy levels or by amount.", "type": "boolean" }, "formula": { "description": "Signifies the formula to apply to the rule. The formula selected is used to calculate the upsell amount that is offered.", "$ref": "#/definitions/formulaType" }, "upsellAmount": { "description": "Signifies the formula to apply to the rule. The formula selected is used to calculate the upsell amount that is offered.", "type": "number" }, "currencyCode": { "description": "The currency code used in the upsell rule.", "type": "string", "minLength": 0, "maxLength": 20 }, "roundingRule": { "description": "Signifies the rounding operation for the rule depending on how the calculated rates have to be rounded.", "$ref": "#/definitions/roundingRuleType" }, "occupancyLevelsType": { "description": "Specifies the upsell amounts by occupancy levels. This is used when upsell rule is set by occupancy levels. If a new formula is selected, all occupancy level amounts that are defined will be cleared.", "$ref": "#/definitions/configOccupancyLevelsType" }, "daysInAdvance": { "description": "Specifies the number of days in advance of the reservation arrival date that a reservation can be upsold using this rule. So if this field is set to 10, then the reservation must be booked at least 10 days before the arrival date, in order to be eligible for the upsell.", "type": "integer" }, "useDefaultTrxCode": { "description": "Signifies whether the default trx code defined for the property has to be used when posting upsell charges.", "type": "boolean" }, "transactionCode": { "description": "Specifies the transaction code used to post upsell charges.", "$ref": "#/definitions/trxInfoType" }, "hotelId": { "description": "Specifies the hotel code for which the upsell rule is defined.", "type": "string", "minLength": 0, "maxLength": 20 }, "upsellRuleCode": { "description": "Specifies the user defined code that identifies a upsell rule.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "formulaType": { "type": "string", "description": "Simple type for storing formula type.", "enum": [ "FlatAmountAddedToOriginalRate", "PercentOfDifferenceAddedToOriginalRate", "PercentOfOriginalRateAddedToOriginalRate" ] }, "roundingRuleType": { "type": "string", "description": "Simple type for storing rounding rule type.", "enum": [ "Up", "Down", "None", "UpKeepDecimal", "DownKeepDecimal" ] }, "configOccupancyLevelsType": { "type": "array", "description": "This type holds a collection of upsell amounts by occupancy levels.", "maxItems": 4000, "items": { "$ref": "#/definitions/configOccupancyLevelType" } }, "configOccupancyLevelType": { "type": "object", "description": "This type holds the upsell amount by occupancy levels. This is used when upsell rule is being set bu occupancy levels", "properties": { "level": { "description": "Used to specify the occupancy level id.", "type": "integer" }, "levelDescription": { "description": "Used to specify the occupancy level description.", "type": "string", "minLength": 0, "maxLength": 20 }, "levelUpsellAmount": { "description": "Used to specify the occupancy level upsell amount.", "type": "number" } } }, "trxInfoType": { "type": "object", "description": "Transaction codes info.", "properties": { "description": { "description": "Transaction codes info.", "type": "string", "minLength": 0, "maxLength": 2000 }, "transactionGroup": { "description": "Category of the transaction code.", "type": "string", "minLength": 0, "maxLength": 20 }, "transactionSubGroup": { "description": "Sub category of the transaction code.", "type": "string", "minLength": 0, "maxLength": 20 }, "universalProductCode": { "description": "Unique Universal product code of the transaction code.", "type": "string", "minLength": 0, "maxLength": 20 }, "routingInstructionsId": { "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", "type": "number" }, "articles": { "description": "The List of Articles defined for this transaction code, when using the Articles functionality.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/articleInfoType" } }, "trxServiceType": { "description": "Contains service type for transaction code.", "type": "string", "minLength": 0, "maxLength": 20 }, "transactionCode": { "description": "Unique identifier for the Transaction code.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "Hotel context of the Transaction code.", "type": "string", "minLength": 0, "maxLength": 20 }, "printTrxReceipt": { "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.", "type": "boolean" } } }, "articleInfoType": { "type": "object", "description": "Information regarding an article.", "properties": { "description": { "description": "Description of the article.", "type": "string", "minLength": 0, "maxLength": 2000 }, "transactionCode": { "description": "Transaction code to which the article belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "price": { "description": "Default price of the article.", "$ref": "#/definitions/currencyAmountType" }, "postIt": { "description": "Post it information of the article.", "$ref": "#/definitions/articlePostItType" }, "universalProductCode": { "description": "Unique Universal product code of the article.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "Hotel code to which the article belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "articleCode": { "description": "Unique code of the article.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates whether the article is inactive or not.", "type": "boolean" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" } } }, "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 } } }, "articlePostItType": { "type": "object", "description": "Post it information of an article.", "properties": { "availableForPostIt": { "description": "Indicates whether the article is available for post it.", "type": "boolean" }, "color": { "description": "Color indicator which is only configurable if article is available for post it.", "$ref": "#/definitions/colorType" } } }, "colorType": { "type": "string", "description": "Color configuration type. This color configuration provides a visual category of entities.", "enum": [ "Red", "DarkRed", "Green", "DarkGreen", "LightGreen", "Orange", "White", "Yellow", "DarkYellow", "Purple", "Brown", "Gray", "Aqua", "Chocolate", "Blue", "LightBlue", "DarkBlue", "Cyan", "DarkCyan", "Magenta", "DarkMagenta", "Black", "Deepteal", "Sunsetorange", "Aquasky", "Mochabrown", "Mossgreen", "Rosewood", "Claybrown", "Softlavender", "Olivegold", "Plumpurple", "Mistblue", "Forestgreen", "Dustyviolet", "Oceanblue", "Copper" ] }, "upsellRulesToTest": { "type": "object", "description": "Request object for testing upsell rules.", "properties": { "criteria": { "description": "Search criteria for testing upsell rules.", "$ref": "#/definitions/configTestUpsellRuleSearchType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "configTestUpsellRuleSearchType": { "type": "object", "description": "Search criteria for testing upsell rules.", "properties": { "hotelId": { "description": "Specifies the hotel code for which the upsell rules have to be tested.", "type": "string", "minLength": 0, "maxLength": 20 }, "arrivalDate": { "description": "Arrival date set in the test reservation.", "type": "string", "format": "date", "maxLength": 8 }, "nights": { "description": "Number of nights set in the test reservation.", "type": "integer" }, "adults": { "description": "Signifies the number of adults set in the test reservation.", "type": "integer" }, "children": { "description": "Signifies the number of children set in the test reservation.", "type": "integer" }, "numberOfRooms": { "description": "The number of rooms set in the test reservation.", "type": "integer" }, "roomType": { "description": "Signifies the room type for which the upsell rule test has to be run.", "type": "string", "minLength": 0, "maxLength": 20 }, "rateCode": { "description": "Signifies the rate code for which the upsell rule test has to be run.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipType": { "description": "Signifies the membership type for which the upsell rule test has to be run.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipLevel": { "description": "Signifies the membership level for which the upsell rule test has to be run.", "type": "string", "minLength": 0, "maxLength": 20 }, "reservationType": { "description": "Signifies the reservation type for which the upsell rule test has to be run.", "type": "string", "minLength": 0, "maxLength": 20 }, "marketCode": { "description": "Signifies the market code for which the upsell rule test has to be run.", "type": "string", "minLength": 0, "maxLength": 20 }, "channel": { "description": "Signifies the channel for which the upsell rule test has to be run.", "type": "string", "minLength": 0, "maxLength": 20 }, "occupancyLevelId": { "description": "Signifies the occupancy level id for which the upsell rule test has to be run. This field is only available when the test upgrade rule is set for 'Upgrade By Occupancy Levels'.", "type": "integer" } } }, "upsellRulesToTestDetails": { "type": "object", "description": "Response object for testing upsell rules.", "properties": { "upsellRules": { "description": "Collection of upsell rules which satisfy the test search criteria.", "$ref": "#/definitions/configTestUpsellRulesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "configTestUpsellRulesType": { "type": "array", "description": "This type holds a collection of upsell rules which are returned on testing a reservation.", "maxItems": 4000, "items": { "$ref": "#/definitions/configTestUpsellRuleType" } }, "configTestUpsellRuleType": { "type": "object", "description": "This gives detailed information about an upsell rule which is returned upon testing an upsell rule against a reservation.", "properties": { "toRoomType": { "description": "The room type for the upsell offer.", "type": "string", "minLength": 0, "maxLength": 20 }, "totalStayAmount": { "description": "The regular rate amount for the upsell offer. This amount is taken from the Rate Code configuration.", "type": "number" }, "totalUpsellMoneyAmount": { "description": "The adjusted rate amount for the room type, based on the upsell offer.", "type": "number" }, "upsellRuleCode": { "description": "Specifies the upsell rule code used for the calculation.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "upsellRulesCopy": { "type": "object", "properties": { "UpsellRules": { "type": "array", "description": "List of the upsell rules to be copied to hotel code(s).", "items": { "$ref": "#/definitions/copyConfigurationCodeType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "copyServiceRequestCodes": { "type": "object", "properties": { "serviceRequestCodes": { "type": "array", "description": "List of the template service request code(s) to be copied.", "items": { "$ref": "#/definitions/copyConfigurationCodeType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateMarketCodesDetails": { "type": "object", "description": "Response for fetch template Market Codes.", "properties": { "templateMarketCodes": { "description": "Collection of template market codes.", "type": "array", "items": { "$ref": "#/definitions/templateMarketCodeType" } }, "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" } } }, "templateMarketCodeType": { "type": "object", "description": "Common code type for code, description, seq and inactive", "properties": { "description": { "description": "Description for the code type.", "$ref": "#/definitions/translationTextType50" }, "sequence": { "description": "Display sequence for the code type.", "type": "integer" }, "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" }, "chainCode": { "description": "Chain code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "groupCode": { "description": "Group code to which this code type belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "displayColor": { "description": "Display Color for the template market code type.", "$ref": "#/definitions/marketCodeColorsType" }, "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "templateMarketCodeCriteria": { "type": "object", "description": "Request object that holds the details of template Market Code to be created.", "properties": { "templateMarketCode": { "description": "Details of template Market Code to be created.", "$ref": "#/definitions/templateMarketCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateMarketCodeToBeChanged": { "type": "object", "description": "Request object that holds the details of template Market Code to be changed.", "properties": { "templateMarketCode": { "description": "Details of template Market Code to be changed.", "$ref": "#/definitions/templateMarketCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "marketCodesDetails": { "type": "object", "description": "Response for fetch Market Codes.", "properties": { "marketCodes": { "description": "Collection of Market Codes.", "$ref": "#/definitions/marketCodesType" }, "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" } } }, "templateMarketGroupCriteria": { "type": "object", "description": "Request object that holds the details of template Market Group to be created.", "properties": { "templateMarketGroup": { "description": "Details of template Market Group to be created.", "$ref": "#/definitions/templateMarketGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateMarketGroupType": { "type": "object", "description": "Common code type for code, description, seq and inactive", "properties": { "description": { "description": "Description for the code type.", "$ref": "#/definitions/translationTextType50" }, "sequence": { "description": "Display sequence for the code type.", "type": "integer" }, "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" }, "chainCode": { "description": "Chain code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "templateMarketCode": { "description": "Collection of Template Market Codes.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/templateMarketCodeType" } }, "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "templateMarketGroupToBeChanged": { "type": "object", "description": "Request object that holds the details of template Market Group to be changed.", "properties": { "templateMarketGroup": { "description": "Details of template Market Group to be changed.", "$ref": "#/definitions/templateMarketGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateMarketGroupsDetails": { "type": "object", "description": "Response for fetch template Market Groups.", "properties": { "templateMarketGroups": { "description": "Collection of template Market Groups.", "type": "array", "items": { "$ref": "#/definitions/templateMarketGroupType" } }, "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" } } }, "marketGroupsDetails": { "type": "object", "description": "Response for fetch Market Groups.", "properties": { "marketGroups": { "description": "Collection of Market Groups.", "type": "array", "items": { "$ref": "#/definitions/marketGroupType" } }, "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" } } }, "moveReasonCodesDetails": { "type": "object", "description": "Response object for fetching Move Reason Codes.", "properties": { "moveReasonCodes": { "description": "Collection of Move Reason Codes.", "$ref": "#/definitions/moveReasonCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "moveReasonCodesType": { "type": "array", "description": "List of Move Reason Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/moveReasonCodeType" } }, "moveReasonCodeType": { "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" } } }, "moveReasonCodesCriteria": { "type": "object", "description": "Request object for creating Move Reason Codes.", "properties": { "moveReasonCodes": { "description": "Move Reason Codesto be created.", "$ref": "#/definitions/moveReasonCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "moveReasonCodesToBeChanged": { "type": "object", "description": "Request object for changing Move Reason Codes.", "properties": { "moveReasonCodes": { "description": "Move Reason Codesto be changed.", "$ref": "#/definitions/moveReasonCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "originCodesDetails": { "type": "object", "description": "Response object for fetching Origin Codes.", "properties": { "originCodes": { "description": "Collection of Origin Codes.", "$ref": "#/definitions/originCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "originCodesType": { "type": "array", "description": "List of Origin Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/originCodeType" } }, "originCodeType": { "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" } } }, "originCodesCriteria": { "type": "object", "description": "Request object for creating Origin Codes.", "properties": { "originCodes": { "description": "Origin Codes to be created.", "$ref": "#/definitions/originCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "originCodesToBeChanged": { "type": "object", "description": "Request object for changing Origin Codes.", "properties": { "originCodes": { "description": "Origin Codes to be changed.", "$ref": "#/definitions/originCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "purposeOfStaysDetails": { "type": "object", "description": "Response object for fetching Purpose Of Stays.", "properties": { "purposeOfStays": { "description": "Collection of Purpose Of Stays.", "$ref": "#/definitions/purposeOfStaysType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "purposeOfStaysType": { "type": "array", "description": "List of Purpose Of Stays.", "maxItems": 4000, "items": { "$ref": "#/definitions/purposeOfStayType" } }, "purposeOfStayType": { "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" } } }, "purposeOfStaysCriteria": { "type": "object", "description": "Request object for creating Purpose Of Stays.", "properties": { "purposeOfStays": { "description": "Purpose Of Stays to be created.", "$ref": "#/definitions/purposeOfStaysType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "purposeOfStaysToBeChanged": { "type": "object", "description": "Request object for changing Purpose Of Stays.", "properties": { "purposeOfStays": { "description": "Purpose Of Stays to be changed.", "$ref": "#/definitions/purposeOfStaysType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "scriptsDetails": { "type": "object", "description": "Response object for fetching Scripts.", "properties": { "scripts": { "description": "Collection of Scripts.", "$ref": "#/definitions/scriptsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "scriptsType": { "type": "array", "description": "A Script associated to either Chain, CRO or Property and to a Language and/or Membership Type.", "maxItems": 4000, "items": { "$ref": "#/definitions/scriptType" } }, "scriptType": { "type": "object", "description": "A Script associated to either Chain, CRO or Property and to a Language and/or Membership Type.", "properties": { "scriptId": { "description": "Unique identifier of a Script.", "$ref": "#/definitions/uniqueID_Type" }, "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "membershipType": { "description": "Membership Type the script belonged to.", "type": "string", "minLength": 0, "maxLength": 20 }, "script": { "description": "Script.", "type": "string", "format": "byte" }, "mergeCodes": { "description": "Merge Codes in the script.", "$ref": "#/definitions/mergeCodesType" }, "type": { "description": "Type of script.", "$ref": "#/definitions/scriptTypeType" }, "locations": { "description": "Collection of locations where Script is to be used.", "$ref": "#/definitions/scriptLocationsType" } } }, "mergeCodesType": { "type": "array", "description": "A Merge Code.", "maxItems": 4000, "items": { "$ref": "#/definitions/mergeCodeType" } }, "mergeCodeType": { "type": "object", "description": "A Merge Code.", "properties": { "tag": { "description": "Merge Code.", "type": "string", "minLength": 0, "maxLength": 100 }, "value": { "description": "Default value of Merge Code.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "scriptTypeType": { "type": "string", "description": "Type for Web Reg Card.", "enum": [ "ClosingScript", "WebRegCard" ] }, "scriptLocationsType": { "type": "object", "description": "Collection of locations where a Script is to be used.", "properties": { "hotels": { "description": "Location where a Script is to be used.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/scriptLocationType" } }, "cROs": { "description": "Location where a Script is to be used.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/scriptLocationType" } }, "chains": { "description": "Location where a Script is to be used..", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/scriptLocationType" } } } }, "scriptLocationType": { "type": "object", "description": "Unique identifier of a Script.", "properties": { "hotelId": { "description": "Hotel code the script belonged to.", "type": "string", "minLength": 0, "maxLength": 20 }, "croCode": { "description": "CRO the script belonged to.", "type": "string", "minLength": 0, "maxLength": 20 }, "chainCode": { "description": "Chain the script belonged to.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "scriptsCriteria": { "type": "object", "description": "Request object for creating Scripts.", "properties": { "scripts": { "description": "Scripts to be created.", "$ref": "#/definitions/scriptsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "scriptsToBeChanged": { "type": "object", "description": "Request object for changing Scripts.", "properties": { "scripts": { "description": "Scripts to be changed.", "$ref": "#/definitions/scriptsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "locatorCodesTemplateInfo": { "type": "object", "description": "Response object for fetching locator codes at template level.", "properties": { "locatorCodes": { "$ref": "#/definitions/locatorCodesTemplateType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "locatorCodesTemplateType": { "type": "array", "description": "Collection of locator codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/locatorCodeTemplateType" } }, "locatorCodeTemplateType": { "type": "object", "description": "Common code type for code, description", "properties": { "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description for the code type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Sequence for locator code", "type": "number" }, "inactive": { "description": "Indicates whether the locator code is active or not", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "locatorCodesTemplate": { "type": "object", "description": "Request object for modifying an existing locator code template.", "properties": { "locatorCodes": { "$ref": "#/definitions/locatorCodesTemplateType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateSourceCodesDetails": { "type": "object", "description": "Response for fetch template Source Codes.", "properties": { "templateSourceCodes": { "description": "Collection of template Source Codes.", "type": "array", "items": { "$ref": "#/definitions/templateSourceCodeType" } }, "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" } } }, "templateSourceCodeType": { "type": "object", "description": "Common code type for code, description, seq and inactive", "properties": { "description": { "description": "Description for the code type.", "$ref": "#/definitions/translationTextType50" }, "sequence": { "description": "Display sequence for the code type.", "type": "integer" }, "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" }, "chainCode": { "description": "Chain code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "groupCode": { "description": "Group code to which this code type belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "templateSourceCodeCriteria": { "type": "object", "description": "Request object that holds the details of template Source Code to be created.", "properties": { "templateSourceCode": { "description": "Details of template Source Code to be created.", "$ref": "#/definitions/templateSourceCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateSourceCodeToBeChanged": { "type": "object", "description": "Request object that holds the details of template Source Code to be changed.", "properties": { "templateSourceCode": { "description": "Details of template Source Code to be changed.", "$ref": "#/definitions/templateSourceCodeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateSourceGroupsDetails": { "type": "object", "description": "Response for fetch template Source Groups.", "properties": { "templateSourceGroups": { "description": "Collection of template Source Groups.", "type": "array", "items": { "$ref": "#/definitions/templateSourceGroupType" } }, "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" } } }, "templateSourceGroupType": { "type": "object", "description": "Common code type for code, description, seq and inactive", "properties": { "description": { "description": "Description for the code type.", "$ref": "#/definitions/translationTextType50" }, "sequence": { "description": "Display sequence for the code type.", "type": "integer" }, "code": { "description": "Code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" }, "chainCode": { "description": "Chain code for the code type.", "type": "string", "minLength": 0, "maxLength": 20 }, "templateSourceCode": { "description": "Collection of Template Source Codes.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/templateSourceCodeType" } }, "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "templateSourceGroupToBeChanged": { "type": "object", "description": "Request object that holds the details of template Source Group to be changed.", "properties": { "templateSourceGroup": { "description": "Details of template Source Group to be changed.", "$ref": "#/definitions/templateSourceGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateSourceGroupCriteria": { "type": "object", "description": "Request object that holds the details of template Source Group to be created.", "properties": { "templateSourceGroup": { "description": "Details of template Source Group to be created.", "$ref": "#/definitions/templateSourceGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "traceTextsToBeFetched": { "type": "object", "description": "Response object for fetching trace texts.", "properties": { "traceTexts": { "description": "Type contains trace texts.", "$ref": "#/definitions/traceTextsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "traceTextChanges": { "type": "object", "description": "Request object for changing trace texts.", "properties": { "traceTexts": { "description": "Trace texts to be changed.", "$ref": "#/definitions/traceTextChangesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "traceTextChangesType": { "type": "array", "description": "Collection of trace texts that will be modified.", "maxItems": 4000, "items": { "$ref": "#/definitions/traceTextChangeType" } }, "traceTextChangeType": { "type": "object", "description": "Type provides trace text that will be modified.", "properties": { "originalTraceText": { "description": "Original settings of the trace text that will be changed.", "$ref": "#/definitions/traceTextType" }, "newTraceText": { "description": "New settings of the trace text.", "$ref": "#/definitions/traceTextType" } } }, "traceTextsToBeCreated": { "type": "object", "description": "Request object for creating new trace texts.", "properties": { "traceTexts": { "description": "Trace texts to be created.", "$ref": "#/definitions/traceTextsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateTurnAwayCodes": { "type": "object", "description": "Response object for fetching template turnaway codes.", "properties": { "turnAwayCodes": { "description": "Collection of template turnaway codes and their information.", "$ref": "#/definitions/templateTurnAwayCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateTurnAwayCodesType": { "type": "array", "description": "Collection of template turnaway codes", "maxItems": 4000, "items": { "$ref": "#/definitions/templateTurnAwayCodeType" } }, "templateTurnAwayCodeType": { "type": "object", "description": "Base details common between hotel and template TurnAway codes.", "properties": { "code": { "description": "TurnAway code", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the TurnAway code.", "$ref": "#/definitions/translationTextType50" }, "displaySequence": { "description": "Sequence of TurnAway code.", "type": "number" }, "turnAwayType": { "description": "TurnAway type. e.g. Denial,Regret.", "$ref": "#/definitions/turnAwayTypeType" }, "inactive": { "description": "Inactive flag for a TurnAway code.", "type": "boolean" }, "canDelete": { "description": "Determines whether this TurnAway code can be deleted.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "waitlistCodesDetails": { "type": "object", "description": "Response object for fetching Waitlist Codes.", "properties": { "waitlistCodes": { "description": "Collection of Waitlist Codes.", "$ref": "#/definitions/waitlistCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "waitlistCodesType": { "type": "array", "description": "List of Waitlist Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/waitlistCodeType" } }, "waitlistCodeType": { "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" } } }, "waitlistCodesCriteria": { "type": "object", "description": "Request object for creating Waitlist Codes.", "properties": { "waitlistCodes": { "description": "Waitlist Codes to be created.", "$ref": "#/definitions/waitlistCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "waitlistCodesToBeChanged": { "type": "object", "description": "Request object for changing Waitlist Codes.", "properties": { "waitlistCodes": { "description": "Waitlist Codesto be changed.", "$ref": "#/definitions/waitlistCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "waitlistPrioritiesDetails": { "type": "object", "description": "Response object for fetching Waitlist Priorities.", "properties": { "waitlistPriorities": { "description": "Collection of Waitlist Priorities.", "$ref": "#/definitions/waitlistPrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "waitlistPrioritiesType": { "type": "array", "description": "List of Waitlist Priorities.", "maxItems": 4000, "items": { "$ref": "#/definitions/waitlistPriorityType" } }, "waitlistPriorityType": { "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" } } }, "waitlistPrioritiesCriteria": { "type": "object", "description": "Request object for creating Waitlist Priorities.", "properties": { "waitlistPriorities": { "description": "Waitlist Priorities to be created.", "$ref": "#/definitions/waitlistPrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "waitlistPrioritiesToBeChanged": { "type": "object", "description": "Request object for changing Waitlist Priorities.", "properties": { "waitlistPriorities": { "description": "Waitlist Priorities to be changed.", "$ref": "#/definitions/waitlistPrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "managedByOptions": { "description": "Describes of the Configuration is Managed by Enterprise or Property.", "type": "string", "enum": [ "EnterpriseManaged", "PropertyManaged", "EnterpriseEnforced", "PropertyOverridden" ] }, "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" } } }, "distributionAttributesType": { "type": "object", "properties": { "availableChannels": { "description": "Distribution channels in which the guarantee code may be used. If no channels are selected, the guarantee code is available for all distribution channels.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 2000 } }, "distributionGuaranteeType": { "description": "Distribution Guarantee Types to which the guarantee code may be mapped", "type": "string" }, "releaseTime": { "description": "Time (HH24:MM format) in which the reservation is to be released, available when distributionGuaranteeType is set to '38' (None) ", "type": "string" } } }, "tieredDepositRule": { "type": "object", "description": "Type for a tiered deposit rule policy that is configured and attached to a tiered deposit rule schedule.", "properties": { "depositRuleCodeDescription": { "description": "", "$ref": "#/definitions/codeDescriptionType" }, "depositRuleId": { "description": "Internal deposit rule identifier that is used to attach the tiered deposit rule to a tiered deposit rule schedule.", "type": "number" }, "amountPercent": { "description": "Payment expressed as a fixed amount, or a percentage of/or room nights.", "$ref": "#/definitions/policyAmountPercentType" }, "deadline": { "description": "Payment deadline, absolute or relative.", "$ref": "#/definitions/policyDeadlineType" } } }, "tieredCancelPenalty": { "type": "object", "description": "Type for a tiered cancellation penalty that is configured and attached to a tiered cancel penalty schedule.", "properties": { "cancelPenaltyCodeDescription": { "description": "", "$ref": "#/definitions/codeDescriptionType" }, "cancelPenaltyId": { "description": "Internal cancel penalty identifier that is used to attach the tiered cancel penalty to a tiered cancel penalty schedule.", "type": "number" }, "amountPercent": { "description": "Cancellation fee expressed as a fixed amount, or percentage of/or room nights.", "$ref": "#/definitions/policyAmountPercentType" }, "deadline": { "description": "Cancellation deadline, absolute or relative.", "$ref": "#/definitions/policyDeadlineType" } } }, "reservationProtectionConditionType": { "type": "object", "description": "Details of reservation protection condition", "properties": { "hotelId": { "type": "string", "description": "Unique OPERA Hotel code identifier", "minLength": 0, "maxLength": 20 }, "conditions": { "description": "Reservation protection condition which may consist of multiple layers of conditions and groups of conditions", "$ref": "#/definitions/conditionGroupType" } } }, "reservationProtectionCondition": { "type": "object", "description": "Reservation protection condition in which a reservation would be automatically marked as protected for the property.", "properties": { "reservationProtectionCondition": { "description": "Reservation protection condition in which a reservation would be automatically marked as protected for the property.", "maxItems": 4000, "$ref": "#/definitions/reservationProtectionConditionType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } } }, "tags": [ { "name": "ReservationConfig", "description": "The Reservation Configuration module offers capability of creating, managing, and retrieving of Reservation configuration." }, { "name": "ChainConfig", "description": "These APIs will allow you to configure reservation related configuration related to Administration." }, { "name": "HotelConfig", "description": "These APIs will allow you to configure reservation related configuration related to Administration." } ], "externalDocs": { "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } }