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, 2023 Oracle and/or its affiliates.
", "title": "OPERA Cloud CRM Configuration API", - "version": "23.2", + "description": "APIs for Customer Relationship Management (profile) configuration, such as creating preferences, or address types. It also includes Membership Configuration, where you can retrieve membership levels that are configured for a property, or create new membership enrollment codes.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, 2023 Oracle and/or its affiliates.
", + "version": "23.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality-integrations_ww@oracle.com" @@ -19,171 +13,140 @@ "url": "https://opensource.org/licenses/upl" } }, + "schemes": [ + "https" + ], "basePath": "/crm/config/v1", + "produces": [ + "application/json" + ], "paths": { "/accountOwners": { "get": { - "description": "Use this API to get Account Owners.OperationId:getAccountOwners
", - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "ChainConfig" - ], "summary": "Get Account Owners", + "description": "Use this API to get Account Owners.OperationId:getAccountOwners
", "operationId": "getAccountOwners", "parameters": [ { - "type": "string", - "description": "Chain level code to which owners have access.This is a mandatory element.", "name": "chainCode", "in": "query", - "required": true + "required": true, + "description": "Chain level code to which owners have access.This is a mandatory element.", + "type": "string" }, { - "type": "boolean", - "description": "Indicates if there is an exact match for the given owner code or not.", "name": "findExactOwnerCodeMatch", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates if there is an exact match for the given owner code or not.", + "type": "boolean" }, { - "type": "integer", - "description": "Maximum number of records to be fetched.", "name": "maxFetchRecords", - "in": "query" + "in": "query", + "required": false, + "description": "Maximum number of records to be fetched.", + "type": "integer" }, { - "type": "string", - "description": "Hotel code to which owners have access.", "name": "hotelId", - "in": "query" + "in": "query", + "required": false, + "description": "Hotel code to which owners have access.", + "type": "string" }, { - "type": "string", - "description": "Wildcard search on owner codes.", "name": "ownerCode", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on owner codes.", + "type": "string" }, { - "type": "string", - "description": "Family name, last name or Company Name.", "name": "name", - "in": "query" + "in": "query", + "required": false, + "description": "Family name, last name or Company Name.", + "type": "string" }, { - "type": "string", - "description": "Given name, first name or names.", "name": "givenName", - "in": "query" + "in": "query", + "required": false, + "description": "Given name, first name or names.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetch account owners.", - "schema": { - "$ref": "#/definitions/accountOwnersDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetch account owners.", + "schema": { + "$ref": "#/definitions/accountOwnersDetails" } }, "204": { "description": "AccountOwners not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/accountPriorities": { - "get": { - "description": "Use this API to get Account Priorities.OperationId:getAccountPriorities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -192,142 +155,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/accountPriorities": { + "get": { "summary": "Get Account Priorities", + "description": "Use this API to get Account Priorities.OperationId:getAccountPriorities
", "operationId": "getAccountPriorities", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Account Priorities.", - "schema": { - "$ref": "#/definitions/accountPrioritiesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Account Priorities.", + "schema": { + "$ref": "#/definitions/accountPrioritiesDetails" } }, "204": { "description": "AccountPriorities not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Account Priorities.OperationId:postAccountPriorities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -336,15 +276,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Account Priorities", + "description": "Use this API to create Account Priorities.OperationId:postAccountPriorities
", "operationId": "postAccountPriorities", "parameters": [ { - "description": "Request object for creating Account Priorities.", "name": "accountPrioritiesCriteria", "in": "body", "required": true, + "description": "Request object for creating Account Priorities.", "schema": { "allOf": [ { @@ -354,111 +297,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/accountPriorities/{accountPriorityId}": { - "put": { - "description": "Use this API to update Account Priorities.OperationId:putAccountPriorities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -467,24 +376,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/accountPriorities/{accountPriorityId}": { + "put": { "summary": "Change Account Priorities", + "description": "Use this API to update Account Priorities.OperationId:putAccountPriorities
", "operationId": "putAccountPriorities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Account Priorities.", "name": "accountPriorityId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Account Priorities." }, { - "description": "Request object for changing Account Priorities.", "name": "accountPrioritiesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Account Priorities.", "schema": { "allOf": [ { @@ -494,109 +408,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to remove Account Priorities.OperationId:deleteAccountPriorities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -605,125 +487,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Remove Account Priorities", + "description": "Use this API to remove Account Priorities.OperationId:deleteAccountPriorities
", "operationId": "deleteAccountPriorities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Account Priorities.", "name": "accountPriorityId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Account Priorities." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/accountTypes": { - "get": { - "description": "Use this API to get Account Types.OperationId:getAccountTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -732,142 +583,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/accountTypes": { + "get": { "summary": "Get Account Types", + "description": "Use this API to get Account Types.OperationId:getAccountTypes
", "operationId": "getAccountTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Account Types.", - "schema": { - "$ref": "#/definitions/accountTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Account Types.", + "schema": { + "$ref": "#/definitions/accountTypesDetails" } }, "204": { "description": "AccountTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Account Types.OperationId:postAccountTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -876,15 +704,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Account Types", + "description": "Use this API to create Account Types.OperationId:postAccountTypes
", "operationId": "postAccountTypes", "parameters": [ { - "description": "Request object for creating Account Types.", "name": "accountTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Account Types.", "schema": { "allOf": [ { @@ -894,111 +725,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/accountTypes/{accountTypesId}": { - "put": { - "description": "Use this API to update Account Types.OperationId:putAccountTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1007,24 +804,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/accountTypes/{accountTypesId}": { + "put": { "summary": "Change Account Types", + "description": "Use this API to update Account Types.OperationId:putAccountTypes
", "operationId": "putAccountTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Account Types.", "name": "accountTypesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Account Types." }, { - "description": "Request object for changing Account Types.", "name": "accountTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Account Types.", "schema": { "allOf": [ { @@ -1034,109 +836,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to remove Account Types.OperationId:deleteAccountTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1145,125 +915,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Remove Account Types", + "description": "Use this API to remove Account Types.OperationId:deleteAccountTypes
", "operationId": "deleteAccountTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Account Types.", "name": "accountTypesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Account Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/addressFormats": { - "get": { - "description": "You can use this API to get address formats.OperationId:getAddressFormats
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1271,131 +1010,106 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], + "ChainConfig" + ] + } + }, + "/addressFormats": { + "get": { "summary": "Get address formats", + "description": "You can use this API to get address formats.OperationId:getAddressFormats
", "operationId": "getAddressFormats", "parameters": [ { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Address Formats.", - "schema": { - "$ref": "#/definitions/addressFormats" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Address Formats.", + "schema": { + "$ref": "#/definitions/addressFormats" } }, "204": { "description": "AddressFormats not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change address formats.OperationId:putAddressFormats
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1404,15 +1118,18 @@ ], "tags": [ "ProfileConfiguration" - ], + ] + }, + "put": { "summary": "Change address formats", + "description": "You can use this API to change address formats.OperationId:putAddressFormats
", "operationId": "putAddressFormats", "parameters": [ { - "description": "Request object for change address formats.", "name": "addressFormats", "in": "body", "required": true, + "description": "Request object for change address formats.", "schema": { "allOf": [ { @@ -1422,109 +1139,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create address formats.OperationId:postAddressFormats
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1533,127 +1218,96 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Create address formats", - "operationId": "postAddressFormats", + ] + }, + "delete": { + "summary": "Delete address formats", + "description": "You can use this API to delete address formats.OperationId:deleteAddressFormats
", + "operationId": "deleteAddressFormats", "parameters": [ { - "description": "Request object for creating address formats.", - "name": "addressFormats", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/addressFormats" - } - ] - } + "name": "formatCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": true }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete address formats.OperationId:deleteAddressFormats
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1662,127 +1316,98 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Delete address formats", - "operationId": "deleteAddressFormats", + ] + }, + "post": { + "summary": "Create address formats", + "description": "You can use this API to create address formats.OperationId:postAddressFormats
", + "operationId": "postAddressFormats", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "formatCodes", - "in": "query", - "required": true + "name": "addressFormats", + "in": "body", + "required": true, + "description": "Request object for creating address formats.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/addressFormats" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/addressTypes": { - "get": { - "description": "Use this API to get Address types.OperationId:getAddressTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1790,143 +1415,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "ProfileConfiguration" + ] + } + }, + "/addressTypes": { + "get": { "summary": "Get Address types", + "description": "Use this API to get Address types.OperationId:getAddressTypes
", "operationId": "getAddressTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Address Types.", - "schema": { - "$ref": "#/definitions/addressTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Address Types.", + "schema": { + "$ref": "#/definitions/addressTypesDetails" } }, "204": { "description": "AddressTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create a new Address type.OperationId:postAddressTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1935,15 +1537,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create a new Address type", + "description": "Use this API to create a new Address type.OperationId:postAddressTypes
", "operationId": "postAddressTypes", "parameters": [ { - "description": "Request object for creating a new Address Type.", "name": "addressTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating a new Address Type.", "schema": { "allOf": [ { @@ -1953,111 +1558,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/addressTypes/{addressTypeId}": { - "put": { - "description": "Use this API to update an existing Address type.OperationId:putAddressTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2066,24 +1637,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/addressTypes/{addressTypeId}": { + "put": { "summary": "Change an existing Address type", + "description": "Use this API to update an existing Address type.OperationId:putAddressTypes
", "operationId": "putAddressTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of address type", "name": "addressTypeId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of address type" }, { - "description": "Request object for changing an existing Address Type.", "name": "addressTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing an existing Address Type.", "schema": { "allOf": [ { @@ -2093,109 +1669,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete an existing Address type.OperationId:deleteAddressTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2204,125 +1748,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete an existing Address type", + "description": "Use this API to delete an existing Address type.OperationId:deleteAddressTypes
", "operationId": "deleteAddressTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of address type", "name": "addressTypeId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of address type" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/alternateLanguages": { - "get": { - "description": "Use this API to get Alternate Language Guest Titles.OperationId:getAlternateLanguageGuestTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2331,139 +1844,115 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/alternateLanguages": { + "get": { "summary": "Get Alternate Language Guest Titles", + "description": "Use this API to get Alternate Language Guest Titles.OperationId:getAlternateLanguageGuestTitles
", "operationId": "getAlternateLanguageGuestTitles", "parameters": [ { + "name": "codes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "codes", - "in": "query" + "required": false }, { + "name": "titleCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "titleCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Description of the Guest Title.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the Guest Title.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Alternate Language Guest Titles.", - "schema": { - "$ref": "#/definitions/alternateLanguageGuestTitlesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Alternate Language Guest Titles.", + "schema": { + "$ref": "#/definitions/alternateLanguageGuestTitlesDetails" } }, "204": { "description": "AlternateLanguageGuestTitles not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Alternate Language Guest Titles.OperationId:postAlternateLanguageGuestTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2472,15 +1961,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Alternate Language Guest Titles", + "description": "Use this API to create Alternate Language Guest Titles.OperationId:postAlternateLanguageGuestTitles
", "operationId": "postAlternateLanguageGuestTitles", "parameters": [ { - "description": "Request object for creating Alternate Language Guest Titles.", "name": "alternateLanguageGuestTitlesCriteria", "in": "body", "required": true, + "description": "Request object for creating Alternate Language Guest Titles.", "schema": { "allOf": [ { @@ -2490,111 +1982,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/alternateLanguages/{guestTitlesCode}": { - "put": { - "description": "Use this API to modify Alternate Language Guest Titles.OperationId:changeAlternateLanguageGuestTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2603,24 +2061,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/alternateLanguages/{guestTitlesCode}": { + "put": { "summary": "Change Alternate Language Guest Titles", + "description": "Use this API to modify Alternate Language Guest Titles.OperationId:changeAlternateLanguageGuestTitles
", "operationId": "changeAlternateLanguageGuestTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Guest Titles.", "name": "guestTitlesCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Guest Titles." }, { - "description": "Request object for changing Alternate Language Guest Titles.", "name": "alternateLanguageGuestTitlesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Alternate Language Guest Titles.", "schema": { "allOf": [ { @@ -2630,109 +2093,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Alternate Language Guest Titles.OperationId:removeAlternateLanguageGuestTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2741,195 +2172,171 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Alternate Language Guest Titles", + "description": "Use this API to delete Alternate Language Guest Titles.OperationId:removeAlternateLanguageGuestTitles
", "operationId": "removeAlternateLanguageGuestTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Guest Titles.", "name": "guestTitlesCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Guest Titles." }, { + "name": "languageCode", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Language code of the Guest Title.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Language code of the Guest Title.", - "name": "languageCode", - "in": "query" + "required": false }, { + "name": "titleTypes", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Title Type for advanced title configuration.", "items": { "type": "integer" }, - "collectionFormat": "multi", - "description": "Title Type for advanced title configuration.", - "name": "titleTypes", - "in": "query" + "required": false }, { + "name": "titleDescription", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Description of the Guest Title.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Description of the Guest Title.", - "name": "titleDescription", - "in": "query" + "required": false }, { + "name": "greeting", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Business Title for advanced title configuration.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Business Title for advanced title configuration.", - "name": "greeting", - "in": "query" + "required": false }, { + "name": "displayOrder", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Guest Title record sequence number.", "items": { "type": "number" }, - "collectionFormat": "multi", - "description": "Guest Title record sequence number.", - "name": "displayOrder", - "in": "query" + "required": false }, { + "name": "newTitleType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Description of the Guest Title.", "items": { "type": "integer" }, - "collectionFormat": "multi", - "description": "Description of the Guest Title.", - "name": "newTitleType", - "in": "query" + "required": false }, { + "name": "newLanguageCode", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Description of the Guest Title.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Description of the Guest Title.", - "name": "newLanguageCode", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/availablePreferences": { - "get": { - "description": "Use this API to Fetch Available Preferences for a Property. The request can be filtered to search only for preferences marked for reservation.OperationId:getAvailablePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2937,134 +2344,107 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/availablePreferences": { + "get": { "summary": "Get available Preferences", + "description": "Use this API to Fetch Available Preferences for a Property. The request can be filtered to search only for preferences marked for reservation.OperationId:getAvailablePreferences
", "operationId": "getAvailablePreferences", "parameters": [ { - "type": "string", "name": "hotelId", "in": "query", - "required": true + "required": true, + "type": "string" }, { - "type": "boolean", - "default": "true", - "description": "Flag for available reservation preferences, by default its true", "name": "isOnlyForReservation", - "in": "query" + "in": "query", + "default": "true", + "required": false, + "type": "boolean", + "description": "Flag for available reservation preferences, by default its true" }, { - "type": "string", "name": "preferenceType", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "A collection of preferences", - "schema": { - "$ref": "#/definitions/availablePreferencesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "A collection of preferences", + "schema": { + "$ref": "#/definitions/availablePreferencesDetails" } }, "204": { "description": "AvailablePreferences not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/businessSegments": { - "get": { - "description": "Use this API to get Business Segments.OperationId:getBusinessSegments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3072,143 +2452,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/businessSegments": { + "get": { "summary": "Get Business Segments", + "description": "Use this API to get Business Segments.OperationId:getBusinessSegments
", "operationId": "getBusinessSegments", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Business Segments.", - "schema": { - "$ref": "#/definitions/businessSegmentsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Business Segments.", + "schema": { + "$ref": "#/definitions/businessSegmentsDetails" } }, "204": { "description": "BusinessSegments not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Business Segments.OperationId:postBusinessSegments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3217,15 +2574,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Business Segments", + "description": "Use this API to create Business Segments.OperationId:postBusinessSegments
", "operationId": "postBusinessSegments", "parameters": [ { - "description": "Request object for creating Business Segments.", "name": "businessSegmentsCriteria", "in": "body", "required": true, + "description": "Request object for creating Business Segments.", "schema": { "allOf": [ { @@ -3235,111 +2595,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/businessSegments/{businessSegmentCode}": { - "put": { - "description": "Use this API to update Business Segments.OperationId:changeBusinessSegments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3348,24 +2674,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/businessSegments/{businessSegmentCode}": { + "put": { "summary": "Change Business Segments", + "description": "Use this API to update Business Segments.OperationId:changeBusinessSegments
", "operationId": "changeBusinessSegments", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Business Segments.", "name": "businessSegmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Business Segments." }, { - "description": "Request object for changing Business Segments.", "name": "businessSegmentsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Business Segments.", "schema": { "allOf": [ { @@ -3375,109 +2706,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Business Segments.OperationId:removeBusinessSegments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3486,125 +2785,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Business Segments", + "description": "Use this API to delete Business Segments.OperationId:removeBusinessSegments
", "operationId": "removeBusinessSegments", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Business Segments.", "name": "businessSegmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Business Segments." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/cityPostalCodes": { - "get": { - "description": "Use this API to get City Postal Codes. Associate countries (and states or provinces if configured for the country) with cities and with postal codes can be utilized to validate addresses.OperationId:getCityPostalCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3613,212 +2881,198 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/cityPostalCodes": { + "get": { "summary": "Get city postal codes", + "description": "Use this API to get City Postal Codes. Associate countries (and states or provinces if configured for the country) with cities and with postal codes can be utilized to validate addresses.OperationId:getCityPostalCodes
", "operationId": "getCityPostalCodes", "parameters": [ { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "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.", - "name": "offset", - "in": "query" + "type": "integer" }, { - "type": "string", - "description": "The start range of the postal codes valid for the particular country/state/territory/city/postal code combination.", "name": "postalCodeFrom", - "in": "query" + "in": "query", + "required": false, + "description": "The start range of the postal codes valid for the particular country/state/territory/city/postal code combination.", + "type": "string" }, { - "type": "string", - "description": "The end range of the postal codes valid for the particular country/state/territory/city/postal code combination.", "name": "postalCodeTo", - "in": "query" + "in": "query", + "required": false, + "description": "The end range of the postal codes valid for the particular country/state/territory/city/postal code combination.", + "type": "string" }, { - "type": "string", - "description": "The name of the city to search for city and postal codes.", "name": "cityWildCard", - "in": "query" + "in": "query", + "required": false, + "description": "The name of the city to search for city and postal codes.", + "type": "string" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { + "name": "stateCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "stateCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "stateWildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { + "name": "territoryCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "territoryCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "territoryWildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { + "name": "districtCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "districtCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "districtWildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching city and postal codes.", - "schema": { - "$ref": "#/definitions/cityPostalCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching city and postal codes.", + "schema": { + "$ref": "#/definitions/cityPostalCodesDetails" } }, "204": { "description": "CityPostalCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create City Postal Codes.OperationId:postCityPostalCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3827,15 +3081,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create CityPostalCodes", + "description": "Use this API to create City Postal Codes.OperationId:postCityPostalCodes
", "operationId": "postCityPostalCodes", "parameters": [ { - "description": "Request object for creating new city and postal codes.", "name": "cityPostalCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating new city and postal codes.", "schema": { "allOf": [ { @@ -3845,111 +3102,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/cityPostalCodes/{postalCode}": { - "put": { - "description": "Use this API to update City Postal Codes.OperationId:changeCityPostalCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3958,24 +3181,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/cityPostalCodes/{postalCode}": { + "put": { "summary": "Change City Postal Codes", + "description": "Use this API to update City Postal Codes.OperationId:changeCityPostalCodes
", "operationId": "changeCityPostalCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Postals.", "name": "postalCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Postals." }, { - "description": "Request object for updating city and postal codes.", "name": "cityPostalCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for updating city and postal codes.", "schema": { "allOf": [ { @@ -3985,109 +3213,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete City Postal Codes.OperationId:removeCityPostalCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4096,125 +3292,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete City Postal Codes", + "description": "Use this API to delete City Postal Codes.OperationId:removeCityPostalCodes
", "operationId": "removeCityPostalCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Postals.", "name": "postalCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Postals." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/communicationTypes": { - "get": { - "description": "Use this API to get communication types.OperationId:getCommunicationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4222,148 +3387,124 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/communicationTypes": { + "get": { "summary": "Get communication types", + "description": "Use this API to get communication types.OperationId:getCommunicationTypes
", "operationId": "getCommunicationTypes", "parameters": [ { + "name": "codes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "codes", - "in": "query" + "required": false }, { - "uniqueItems": true, - "type": "array", + "name": "roles", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Phone Number Communication Role.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Email", "Fax", "EmailForRequest", "Webpage", "Phone" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Phone Number Communication Role.", - "name": "roles", - "in": "query" + "required": false }, { - "type": "string", - "description": "Description of the Communication Types to be searched.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the Communication Types to be searched.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Communication Types.", - "schema": { - "$ref": "#/definitions/communicationTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Communication Types.", + "schema": { + "$ref": "#/definitions/communicationTypesDetails" } }, "204": { "description": "CommunicationTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create a communication type.OperationId:postCommunicationType
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4372,15 +3513,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create a communication type", + "description": "Use this API to create a communication type.OperationId:postCommunicationType
", "operationId": "postCommunicationType", "parameters": [ { - "description": "Request object for creating a new Communication Type.", "name": "communicationTypeCriteria", "in": "body", "required": true, + "description": "Request object for creating a new Communication Type.", "schema": { "allOf": [ { @@ -4390,111 +3534,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/communicationTypes/{communicationTypeCode}": { - "put": { - "description": "Use this API to update a communication type.OperationId:changeCommunicationType
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4503,136 +3613,96 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Change a communication type", - "operationId": "changeCommunicationType", + ] + } + }, + "/communicationTypes/{communicationTypeCode}": { + "delete": { + "summary": "Delete a communication type", + "description": "Use this API to delete a communication type.OperationId:removeCommunicationType
", + "operationId": "removeCommunicationType", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of communication Types.", "name": "communicationTypeCode", "in": "path", - "required": true - }, - { - "description": "Request object for changing an existing Communication Type.", - "name": "communicationTypeToBeChanged", - "in": "body", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/communicationTypeToBeChanged" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of communication Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete a communication type.OperationId:removeCommunicationType
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4641,125 +3711,107 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Delete a communication type", - "operationId": "removeCommunicationType", + ] + }, + "put": { + "summary": "Change a communication type", + "description": "Use this API to update a communication type.OperationId:changeCommunicationType
", + "operationId": "changeCommunicationType", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of communication Types.", "name": "communicationTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of communication Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "communicationTypeToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing an existing Communication Type.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/communicationTypeToBeChanged" + } + ] + } }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/companyTypes": { - "get": { - "description": "Use this API to get Company Types.OperationId:getCompanyTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4767,143 +3819,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/companyTypes": { + "get": { "summary": "Get Company Types", + "description": "Use this API to get Company Types.OperationId:getCompanyTypes
", "operationId": "getCompanyTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Company Types.", - "schema": { - "$ref": "#/definitions/companyTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Company Types.", + "schema": { + "$ref": "#/definitions/companyTypesDetails" } }, "204": { "description": "CompanyTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Company Types.OperationId:postCompanyTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4912,15 +3941,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Company Types", + "description": "Use this API to create Company Types.OperationId:postCompanyTypes
", "operationId": "postCompanyTypes", "parameters": [ { - "description": "Request object for creating Company Types.", "name": "companyTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Company Types.", "schema": { "allOf": [ { @@ -4930,111 +3962,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/companyTypes/{companyTypesCode}": { - "put": { - "description": "Use this API to update Company Types.OperationId:putCompanyTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5043,24 +4041,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/companyTypes/{companyTypesCode}": { + "put": { "summary": "Change Company Types", + "description": "Use this API to update Company Types.OperationId:putCompanyTypes
", "operationId": "putCompanyTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Company Types.", "name": "companyTypesCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Company Types." }, { - "description": "Request object for changing Company Types.", "name": "companyTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Company Types.", "schema": { "allOf": [ { @@ -5070,109 +4073,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Company Types.OperationId:deleteCompanyTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5181,125 +4152,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Company Types", + "description": "Use this API to delete Company Types.OperationId:deleteCompanyTypes
", "operationId": "deleteCompanyTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Company Types.", "name": "companyTypesCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Company Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/competitionCodes": { - "get": { - "description": "Use this API to get Competition Codes. Competition codes enable you to identify other hospitality businesses that are competing with you for an account's business opportunities.OperationId:getCompetitionCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5308,144 +4248,120 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/competitionCodes": { + "get": { "summary": "Get competition codes", + "description": "Use this API to get Competition Codes. Competition codes enable you to identify other hospitality businesses that are competing with you for an account's business opportunities.OperationId:getCompetitionCodes
", "operationId": "getCompetitionCodes", "parameters": [ { - "type": "boolean", - "default": "false", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", "in": "query", - "required": true + "default": "false", + "required": true, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Competition Codes.", - "schema": { - "$ref": "#/definitions/competitionCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Competition Codes.", + "schema": { + "$ref": "#/definitions/competitionCodesDetails" } }, "204": { "description": "CompetitionCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Competition Codes. Competition codes enable you to identify other hospitality businesses that are competing with you for an account's business opportunities.OperationId:postCompetitionCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5454,15 +4370,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create competition codes", + "description": "Use this API to create Competition Codes. Competition codes enable you to identify other hospitality businesses that are competing with you for an account's business opportunities.OperationId:postCompetitionCodes
", "operationId": "postCompetitionCodes", "parameters": [ { - "description": "Request object for creating Competition Codes.", "name": "competitionCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating Competition Codes.", "schema": { "allOf": [ { @@ -5472,111 +4391,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/competitionCodes/{competitionCodesId}": { - "put": { - "description": "Use this API to update Competition Codes.OperationId:putCompetitionCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5585,24 +4470,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/competitionCodes/{competitionCodesId}": { + "put": { "summary": "Change Competition Codes", + "description": "Use this API to update Competition Codes.OperationId:putCompetitionCodes
", "operationId": "putCompetitionCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Competition Codes.", "name": "competitionCodesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Competition Codes." }, { - "description": "Request object for changing Competition Codes.", "name": "competitionCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Competition Codes.", "schema": { "allOf": [ { @@ -5612,109 +4502,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to remove Competition Codes.OperationId:deleteCompetitionCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5723,125 +4581,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Remove Competition Codes", + "description": "Use this API to remove Competition Codes.OperationId:deleteCompetitionCodes
", "operationId": "deleteCompetitionCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Competition Codes.", "name": "competitionCodesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Competition Codes." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/creditRatings": { - "get": { - "description": "You can use this API to get credit ratings.OperationId:getCreditRatings
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5849,143 +4676,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], + "ChainConfig" + ] + } + }, + "/creditRatings": { + "get": { "summary": "Get credit ratings", + "description": "You can use this API to get credit ratings.OperationId:getCreditRatings
", "operationId": "getCreditRatings", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching credit ratings.", - "schema": { - "$ref": "#/definitions/creditRatings" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching credit ratings.", + "schema": { + "$ref": "#/definitions/creditRatings" } }, "204": { "description": "CreditRatings not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change credit ratings.OperationId:putCreditRatings
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5994,15 +4798,18 @@ ], "tags": [ "ProfileConfiguration" - ], + ] + }, + "put": { "summary": "Change credit ratings", + "description": "You can use this API to change credit ratings.OperationId:putCreditRatings
", "operationId": "putCreditRatings", "parameters": [ { - "description": "Request object for changing credit ratings.", "name": "creditRatings", "in": "body", "required": true, + "description": "Request object for changing credit ratings.", "schema": { "allOf": [ { @@ -6012,109 +4819,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create credit ratings.OperationId:postCreditRatings
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6123,127 +4898,96 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Create credit ratings", - "operationId": "postCreditRatings", + ] + }, + "delete": { + "summary": "Delete credit ratings", + "description": "You can use this API to delete credit ratings.OperationId:deleteCreditRatings
", + "operationId": "deleteCreditRatings", "parameters": [ { - "description": "Request object for creating credit ratings.", "name": "creditRatings", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/creditRatings" - } - ] - } + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": true }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete credit ratings.OperationId:deleteCreditRatings
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6252,127 +4996,98 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Delete credit ratings", - "operationId": "deleteCreditRatings", + ] + }, + "post": { + "summary": "Create credit ratings", + "description": "You can use this API to create credit ratings.OperationId:postCreditRatings
", + "operationId": "postCreditRatings", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", "name": "creditRatings", - "in": "query", - "required": true + "in": "body", + "required": true, + "description": "Request object for creating credit ratings.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/creditRatings" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/distanceTypes": { - "get": { - "description": "Use this API to get Distance Types.OperationId:getDistanceTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6380,143 +5095,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "ProfileConfiguration" + ] + } + }, + "/distanceTypes": { + "get": { "summary": "Get Distance Types", + "description": "Use this API to get Distance Types.OperationId:getDistanceTypes
", "operationId": "getDistanceTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Distance Types.", - "schema": { - "$ref": "#/definitions/distanceTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Distance Types.", + "schema": { + "$ref": "#/definitions/distanceTypesDetails" } }, "204": { "description": "DistanceTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Distance Types.OperationId:postDistanceTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6525,15 +5217,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Distance Types", + "description": "Use this API to create Distance Types.OperationId:postDistanceTypes
", "operationId": "postDistanceTypes", "parameters": [ { - "description": "Request object for creating Distance Types.", "name": "distanceTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Distance Types.", "schema": { "allOf": [ { @@ -6543,111 +5238,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/distanceTypes/{distanceTypesId}": { - "put": { - "description": "Use this API to update Distance Types.OperationId:putDistanceTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6656,24 +5317,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/distanceTypes/{distanceTypesId}": { + "put": { "summary": "Change Distance Types", + "description": "Use this API to update Distance Types.OperationId:putDistanceTypes
", "operationId": "putDistanceTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Distance Types.", "name": "distanceTypesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Distance Types." }, { - "description": "Request object for changing Distance Types.", "name": "distanceTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Distance Types.", "schema": { "allOf": [ { @@ -6683,109 +5349,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Distance Types.OperationId:deleteDistanceTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6794,125 +5428,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Distance Types", + "description": "Use this API to delete Distance Types.OperationId:deleteDistanceTypes
", "operationId": "deleteDistanceTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Distance Types.", "name": "distanceTypesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Distance Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/districts": { - "get": { - "description": "Use this API to get Districts.OperationId:getDistricts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6921,142 +5524,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/districts": { + "get": { "summary": "Get Districts", + "description": "Use this API to get Districts.OperationId:getDistricts
", "operationId": "getDistricts", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Districts.", - "schema": { - "$ref": "#/definitions/districtsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Districts.", + "schema": { + "$ref": "#/definitions/districtsDetails" } }, "204": { "description": "Districts not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Districts.OperationId:postDistricts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7065,15 +5645,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Districts", + "description": "Use this API to create Districts.OperationId:postDistricts
", "operationId": "postDistricts", "parameters": [ { - "description": "Request object for creating Districts.", "name": "districtsCriteria", "in": "body", "required": true, + "description": "Request object for creating Districts.", "schema": { "allOf": [ { @@ -7083,111 +5666,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/districts/{districtsId}": { - "put": { - "description": "Use this API to update Districts.OperationId:putDistricts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7196,24 +5745,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/districts/{districtsId}": { + "put": { "summary": "Change Districts", + "description": "Use this API to update Districts.OperationId:putDistricts
", "operationId": "putDistricts", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Remove Districts.", "name": "districtsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Remove Districts." }, { - "description": "Request object for changing Districts.", "name": "districtsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Districts.", "schema": { "allOf": [ { @@ -7223,109 +5777,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Districts.OperationId:deleteDistricts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7334,125 +5856,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Districts", + "description": "Use this API to delete Districts.OperationId:deleteDistricts
", "operationId": "deleteDistricts", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Remove Districts.", "name": "districtsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Remove Districts." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/exclusivePreferences": { - "get": { - "description": "You can use this API to get template Exclusive Preferences.OperationId:getTemplateExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7460,144 +5951,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], + "ChainConfig" + ] + } + }, + "/exclusivePreferences": { + "get": { "summary": "Get template Exclusive Preferences", + "description": "You can use this API to get template Exclusive Preferences.OperationId:getTemplateExclusivePreferences
", "operationId": "getTemplateExclusivePreferences", "parameters": [ { + "name": "exclusivePreferenceCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "exclusivePreferenceCodes", - "in": "query" + "required": false }, { + "name": "preferenceGroupsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "preferenceGroupsCodes", - "in": "query" + "required": false }, { + "name": "preferenceCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "preferenceCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching exclusive preferences at the template level.", - "schema": { - "$ref": "#/definitions/templateExclusivePreferences" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching exclusive preferences at the template level.", + "schema": { + "$ref": "#/definitions/templateExclusivePreferences" } }, "204": { "description": "TemplateExclusivePreferences not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change template Exclusive Preferences.OperationId:putTemplateExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7606,15 +6073,18 @@ ], "tags": [ "ProfileConfiguration" - ], + ] + }, + "put": { "summary": "Change template Exclusive Preferences", + "description": "You can use this API to change template Exclusive Preferences.OperationId:putTemplateExclusivePreferences
", "operationId": "putTemplateExclusivePreferences", "parameters": [ { - "description": "Request object for changing Exclusive preferences at the template level.", "name": "templateExclusivePreferences", "in": "body", "required": true, + "description": "Request object for changing Exclusive preferences at the template level.", "schema": { "allOf": [ { @@ -7624,109 +6094,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create template Exclusive Preferences.OperationId:postTemplateExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7735,127 +6173,99 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Create template Exclusive Preferences", - "operationId": "postTemplateExclusivePreferences", + ] + }, + "delete": { + "summary": "Delete template Exclusive Preferences", + "description": "You can use this API to delete template Exclusive Preferences.OperationId:deleteTemplateExclusivePreferences
", + "operationId": "deleteTemplateExclusivePreferences", "parameters": [ { - "description": "Request object for creating exclusive preferences at the template level.", - "name": "templateExclusivePreferences", - "in": "body", + "name": "exclusivePreferenceCode", + "in": "query", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/templateExclusivePreferences" - } - ] - } + "description": "Specifies the Exclusive preference code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "exclusivePreferenceGroup", + "in": "query", + "required": true, + "description": "Specifies the preference group the Exclusive preference belongs to.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete template Exclusive Preferences.OperationId:deleteTemplateExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7864,130 +6274,98 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Delete template Exclusive Preferences", - "operationId": "deleteTemplateExclusivePreferences", + ] + }, + "post": { + "summary": "Create template Exclusive Preferences", + "description": "You can use this API to create template Exclusive Preferences.OperationId:postTemplateExclusivePreferences
", + "operationId": "postTemplateExclusivePreferences", "parameters": [ { - "type": "string", - "description": "Specifies the Exclusive preference code.", - "name": "exclusivePreferenceCode", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Specifies the preference group the Exclusive preference belongs to.", - "name": "exclusivePreferenceGroup", - "in": "query", - "required": true + "name": "templateExclusivePreferences", + "in": "body", + "required": true, + "description": "Request object for creating exclusive preferences at the template level.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/templateExclusivePreferences" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/exclusivePreferences/copy": { - "put": { - "description": "You can use this API to copy Exclusive Preferences.OperationId:copyExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7996,15 +6374,20 @@ ], "tags": [ "ProfileConfiguration" - ], + ] + } + }, + "/exclusivePreferences/copy": { + "put": { "summary": "Copy Exclusive Preferences", + "description": "You can use this API to copy Exclusive Preferences.OperationId:copyExclusivePreferences
", "operationId": "copyExclusivePreferences", "parameters": [ { - "description": "Request object for copying template Exclusive preferences to hotel(s).", "name": "exclusivePreferencesCopy", "in": "body", "required": true, + "description": "Request object for copying template Exclusive preferences to hotel(s).", "schema": { "allOf": [ { @@ -8014,111 +6397,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/fiscalAgentTypes": { - "get": { - "description": "Use this API to get Travel Agent Types.OperationId:getTravelAgentTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8126,143 +6475,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "ProfileConfiguration" + ] + } + }, + "/fiscalAgentTypes": { + "get": { "summary": "Get Travel Agent Types", + "description": "Use this API to get Travel Agent Types.OperationId:getTravelAgentTypes
", "operationId": "getTravelAgentTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Travel Agent Types.", - "schema": { - "$ref": "#/definitions/travelAgentTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Travel Agent Types.", + "schema": { + "$ref": "#/definitions/travelAgentTypesDetails" } }, "204": { "description": "TravelAgentTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Travel Agent Types.OperationId:postTravelAgentTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8271,15 +6597,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Travel Agent Types", + "description": "Use this API to create Travel Agent Types.OperationId:postTravelAgentTypes
", "operationId": "postTravelAgentTypes", "parameters": [ { - "description": "Request object for creating Travel Agent Types.", "name": "travelAgentTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Travel Agent Types.", "schema": { "allOf": [ { @@ -8289,111 +6618,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/fiscalAgentTypes/{fiscalAgentTypeCode}": { - "put": { - "description": "Use this API to update Travel Agent Types.OperationId:changeTravelAgentTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8402,24 +6697,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/fiscalAgentTypes/{fiscalAgentTypeCode}": { + "put": { "summary": "Change Travel Agent Types", + "description": "Use this API to update Travel Agent Types.OperationId:changeTravelAgentTypes
", "operationId": "changeTravelAgentTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Travel Agent Types.", "name": "fiscalAgentTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Travel Agent Types." }, { - "description": "Request object for changing Travel Agent Types.", "name": "travelAgentTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Travel Agent Types.", "schema": { "allOf": [ { @@ -8429,109 +6729,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Travel Agent Types.OperationId:removeTravelAgentTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8540,125 +6808,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Travel Agent Types", + "description": "Use this API to delete Travel Agent Types.OperationId:removeTravelAgentTypes
", "operationId": "removeTravelAgentTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Travel Agent Types.", "name": "fiscalAgentTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Travel Agent Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/genderTypes": { - "get": { - "description": "Use this API to get Gender Types.OperationId:getGenderTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8667,142 +6904,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/genderTypes": { + "get": { "summary": "Get Gender Types", + "description": "Use this API to get Gender Types.OperationId:getGenderTypes
", "operationId": "getGenderTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "code", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "code", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Gender Types.", - "schema": { - "$ref": "#/definitions/genderTypes" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Gender Types.", + "schema": { + "$ref": "#/definitions/genderTypes" } }, "204": { "description": "GenderTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Gender Types.OperationId:postGenderTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8811,15 +7025,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Gender Types", + "description": "Use this API to create Gender Types.OperationId:postGenderTypes
", "operationId": "postGenderTypes", "parameters": [ { - "description": "Request object for creating Gender Types.", "name": "genderTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Gender Types.", "schema": { "allOf": [ { @@ -8829,111 +7046,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/genderTypes/{genderTypeId}": { - "put": { - "description": "Use this API to update Gender Type.OperationId:putGenderTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8942,24 +7125,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/genderTypes/{genderTypeId}": { + "put": { "summary": "Change Gender Types", + "description": "Use this API to update Gender Type.OperationId:putGenderTypes
", "operationId": "putGenderTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Identification code of Gender Type.", "name": "genderTypeId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Identification code of Gender Type." }, { - "description": "Request object for changing Gender Types.", "name": "genderTypesToChange", "in": "body", "required": true, + "description": "Request object for changing Gender Types.", "schema": { "allOf": [ { @@ -8969,109 +7157,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/genderTypesToChange" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/genderTypesToChange" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Gender Types.OperationId:deleteGenderTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9080,135 +7236,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Gender Types", + "description": "Use this API to delete Gender Types.OperationId:deleteGenderTypes
", "operationId": "deleteGenderTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Identification code of Gender Types.", "name": "genderTypeId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Identification code of Gender Types." }, { + "name": "code", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "code", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/guestStatuses": { - "get": { - "description": "Use this API to get Guest Statuses.OperationId:getGuestStatuses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9217,142 +7343,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/guestStatuses": { + "get": { "summary": "Get Guest Statuses", + "description": "Use this API to get Guest Statuses.OperationId:getGuestStatuses
", "operationId": "getGuestStatuses", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Guest Statuses.", - "schema": { - "$ref": "#/definitions/guestStatusesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Guest Statuses.", + "schema": { + "$ref": "#/definitions/guestStatusesDetails" } }, "204": { "description": "GuestStatuses not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Guest Statuses.OperationId:postGuestStatuses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9361,15 +7464,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Guest Statuses", + "description": "Use this API to create Guest Statuses.OperationId:postGuestStatuses
", "operationId": "postGuestStatuses", "parameters": [ { - "description": "Request object for creating Guest Statuses.", "name": "guestStatusesCriteria", "in": "body", "required": true, + "description": "Request object for creating Guest Statuses.", "schema": { "allOf": [ { @@ -9379,111 +7485,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/guestStatuses/{guestStatusCode}": { - "put": { - "description": "Use this API to update Guest Statuses.OperationId:changeGuestStatuses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9492,24 +7564,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/guestStatuses/{guestStatusCode}": { + "put": { "summary": "Change Guest Statuses", + "description": "Use this API to update Guest Statuses.OperationId:changeGuestStatuses
", "operationId": "changeGuestStatuses", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Guest Statuses.", "name": "guestStatusCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Guest Statuses." }, { - "description": "Request object for changing Guest Statuses.", "name": "guestStatusesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Guest Statuses.", "schema": { "allOf": [ { @@ -9519,109 +7596,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Guest Statuses.OperationId:removeGuestStatuses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9630,125 +7675,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Guest Statuses", + "description": "Use this API to delete Guest Statuses.OperationId:removeGuestStatuses
", "operationId": "removeGuestStatuses", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Guest Statuses.", "name": "guestStatusCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Guest Statuses." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/guestTitles": { - "get": { - "description": "Use this API to get Guest Titles.OperationId:getGuestTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9757,139 +7771,115 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/guestTitles": { + "get": { "summary": "Get Guest Titles", + "description": "Use this API to get Guest Titles.OperationId:getGuestTitles
", "operationId": "getGuestTitles", "parameters": [ { + "name": "codes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "codes", - "in": "query" + "required": false }, { + "name": "titleCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "titleCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Description of the Guest Title.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the Guest Title.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Guest Titles.", - "schema": { - "$ref": "#/definitions/guestTitlesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Guest Titles.", + "schema": { + "$ref": "#/definitions/guestTitlesDetails" } }, "204": { "description": "GuestTitles not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Guest Titles.OperationId:postGuestTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9898,15 +7888,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Guest Titles", + "description": "Use this API to create Guest Titles.OperationId:postGuestTitles
", "operationId": "postGuestTitles", "parameters": [ { - "description": "Request object for creating Guest Titles.", "name": "guestTitlesCriteria", "in": "body", "required": true, + "description": "Request object for creating Guest Titles.", "schema": { "allOf": [ { @@ -9916,111 +7909,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/guestTitles/{guestTitlesCode}": { - "put": { - "description": "Use this API to update Guest Titles.OperationId:putGuestTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10029,24 +7988,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/guestTitles/{guestTitlesCode}": { + "put": { "summary": "Change Guest Titles", + "description": "Use this API to update Guest Titles.OperationId:putGuestTitles
", "operationId": "putGuestTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Guest Titles.", "name": "guestTitlesCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Guest Titles." }, { - "description": "Request object for changing Guest Titles.", "name": "guestTitlesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Guest Titles.", "schema": { "allOf": [ { @@ -10056,109 +8020,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Guest Titles.OperationId:deleteGuestTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10167,195 +8099,171 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Guest Titles", + "description": "Use this API to delete Guest Titles.OperationId:deleteGuestTitles
", "operationId": "deleteGuestTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Guest Titles.", "name": "guestTitlesCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Guest Titles." }, { + "name": "languageCode", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Language code of the Guest Title.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Language code of the Guest Title.", - "name": "languageCode", - "in": "query" + "required": false }, { + "name": "titleType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Title Type for advanced title configuration.", "items": { "type": "integer" }, - "collectionFormat": "multi", - "description": "Title Type for advanced title configuration.", - "name": "titleType", - "in": "query" + "required": false }, { + "name": "description", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Description of the Guest Title.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Description of the Guest Title.", - "name": "description", - "in": "query" + "required": false }, { + "name": "greeting", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Business Title for advanced title configuration.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Business Title for advanced title configuration.", - "name": "greeting", - "in": "query" + "required": false }, { + "name": "displayOrder", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Guest Title record sequence number.", "items": { "type": "number" }, - "collectionFormat": "multi", - "description": "Guest Title record sequence number.", - "name": "displayOrder", - "in": "query" + "required": false }, { + "name": "newTitleType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Description of the Guest Title.", "items": { "type": "integer" }, - "collectionFormat": "multi", - "description": "Description of the Guest Title.", - "name": "newTitleType", - "in": "query" + "required": false }, { + "name": "newLanguageCode", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Description of the Guest Title.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Description of the Guest Title.", - "name": "newLanguageCode", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/guestTypes": { - "get": { - "description": "Use this API to get Guest Types.OperationId:getGuestTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10364,142 +8272,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/guestTypes": { + "get": { "summary": "Get Guest Types", + "description": "Use this API to get Guest Types.OperationId:getGuestTypes
", "operationId": "getGuestTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Guest Types.", - "schema": { - "$ref": "#/definitions/guestTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Guest Types.", + "schema": { + "$ref": "#/definitions/guestTypesDetails" } }, "204": { "description": "GuestTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Guest Types.OperationId:postGuestTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10508,15 +8393,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Guest Types", + "description": "Use this API to create Guest Types.OperationId:postGuestTypes
", "operationId": "postGuestTypes", "parameters": [ { - "description": "Request object for creating Guest Types.", "name": "guestTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Guest Types.", "schema": { "allOf": [ { @@ -10526,111 +8414,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/guestTypes/{guestTypeCode}": { - "put": { - "description": "Use this API to update Guest Types.OperationId:changeGuestTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10639,24 +8493,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/guestTypes/{guestTypeCode}": { + "put": { "summary": "Change Guest Types", + "description": "Use this API to update Guest Types.OperationId:changeGuestTypes
", "operationId": "changeGuestTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Guest Types.", "name": "guestTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Guest Types." }, { - "description": "Request object for changing Guest Types.", "name": "guestTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Guest Types.", "schema": { "allOf": [ { @@ -10666,109 +8525,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Guest Types.OperationId:removeGuestTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10777,125 +8604,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Guest Types", + "description": "Use this API to delete Guest Types.OperationId:removeGuestTypes
", "operationId": "removeGuestTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Guest Types.", "name": "guestTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Guest Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/eCertificateLocationTypes": { - "get": { - "description": "Use this API to get Ecertificate Location Types.OperationId:getEcertificateLocationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10904,151 +8700,128 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/hotels/{hotelId}/eCertificateLocationTypes": { + "get": { "summary": "Get Ecertificate Location Types", + "description": "Use this API to get Ecertificate Location Types.OperationId:getEcertificateLocationTypes
", "operationId": "getEcertificateLocationTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Ecertificate Location Types.", - "schema": { - "$ref": "#/definitions/ecertificateLocationTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Ecertificate Location Types.", + "schema": { + "$ref": "#/definitions/ecertificateLocationTypesDetails" } }, "204": { "description": "EcertificateLocationTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Ecertificate Location Types.OperationId:postEcertificateLocationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11057,24 +8830,27 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Ecertificate Location Types", + "description": "Use this API to create Ecertificate Location Types.OperationId:postEcertificateLocationTypes
", "operationId": "postEcertificateLocationTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating Ecertificate Location Types.", "name": "ecertificateLocationTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Ecertificate Location Types.", "schema": { "allOf": [ { @@ -11084,111 +8860,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/eCertificateLocationTypes/{locationId}": { - "put": { - "description": "Use this API to update Ecertificate Location Types.OperationId:changeEcertificateLocationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11197,33 +8939,38 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/hotels/{hotelId}/eCertificateLocationTypes/{locationId}": { + "put": { "summary": "Change Ecertificate Location Types", + "description": "Use this API to update Ecertificate Location Types.OperationId:changeEcertificateLocationTypes
", "operationId": "changeEcertificateLocationTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of location.", "name": "locationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of location." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing Ecertificate Location Types.", "name": "ecertificateLocationTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Ecertificate Location Types.", "schema": { "allOf": [ { @@ -11233,109 +8980,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Ecertificate Location Types.OperationId:removeEcertificateLocationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11344,134 +9059,103 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Ecertificate Location Types", + "description": "Use this API to delete Ecertificate Location Types.OperationId:removeEcertificateLocationTypes
", "operationId": "removeEcertificateLocationTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of location.", "name": "locationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of location." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/exclusivePreferences": { - "get": { - "description": "You can use this API to get Exclusive preferences at hotel Level.OperationId:getExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11479,153 +9163,129 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], + "ChainConfig" + ] + } + }, + "/hotels/{hotelId}/exclusivePreferences": { + "get": { "summary": "Get Exclusive preferences", + "description": "You can use this API to get Exclusive preferences at hotel Level.OperationId:getExclusivePreferences
", "operationId": "getExclusivePreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "exclusivePreferenceCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "exclusivePreferenceCodes", - "in": "query" + "required": false }, { + "name": "preferenceGroupsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "preferenceGroupsCodes", - "in": "query" + "required": false }, { + "name": "preferenceCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "preferenceCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Exclusive preferences at the property level.", - "schema": { - "$ref": "#/definitions/exclusivePreferences" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Exclusive preferences at the property level.", + "schema": { + "$ref": "#/definitions/exclusivePreferences" } }, "204": { "description": "ExclusivePreferences not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change Exclusive Preferences at hotel Level.OperationId:putExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11634,24 +9294,27 @@ ], "tags": [ "ProfileConfiguration" - ], + ] + }, + "put": { "summary": "Change Exclusive Preferences", + "description": "You can use this API to change Exclusive Preferences at hotel Level.OperationId:putExclusivePreferences
", "operationId": "putExclusivePreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing Exclusive preferences at the property level.", "name": "exclusivePreferences", "in": "body", "required": true, + "description": "Request object for changing Exclusive preferences at the property level.", "schema": { "allOf": [ { @@ -11661,109 +9324,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create Exclusive Preferences at hotel Level.OperationId:postExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11772,136 +9403,108 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Create Exclusive Preferences", - "operationId": "postExclusivePreferences", + ] + }, + "delete": { + "summary": "Delete Exclusive Preferences", + "description": "You can use this API to delete Exclusive Preferences at hotel Level.OperationId:deleteExclusivePreferences
", + "operationId": "deleteExclusivePreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating Exclusive preferences at the property level.", - "name": "exclusivePreferences", - "in": "body", + "name": "exclusivePreferenceCode", + "in": "query", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/exclusivePreferences" - } - ] - } + "description": "Specifies the Exclusive preference code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "exclusivePreferenceGroup", + "in": "query", + "required": true, + "description": "Specifies the preference group the Exclusive preference belongs to.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete Exclusive Preferences at hotel Level.OperationId:deleteExclusivePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11910,139 +9513,107 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Delete Exclusive Preferences", - "operationId": "deleteExclusivePreferences", + ] + }, + "post": { + "summary": "Create Exclusive Preferences", + "description": "You can use this API to create Exclusive Preferences at hotel Level.OperationId:postExclusivePreferences
", + "operationId": "postExclusivePreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true - }, - { + "required": true, "type": "string", - "description": "Specifies the Exclusive preference code.", - "name": "exclusivePreferenceCode", - "in": "query", - "required": true + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Specifies the preference group the Exclusive preference belongs to.", - "name": "exclusivePreferenceGroup", - "in": "query", - "required": true + "name": "exclusivePreferences", + "in": "body", + "required": true, + "description": "Request object for creating Exclusive preferences at the property level.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/exclusivePreferences" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/preferences": { - "get": { - "description": "Use this API to get all configured guest preferences. Use preference grouping code or preference code to narrow down the results.OperationId:getPreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12051,152 +9622,128 @@ ], "tags": [ "ProfileConfiguration" - ], + ] + } + }, + "/hotels/{hotelId}/preferences": { + "get": { "summary": "Get preferences", + "description": "Use this API to get all configured guest preferences. Use preference grouping code or preference code to narrow down the results.OperationId:getPreferences
", "operationId": "getPreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "preferenceCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "preferenceCodes", - "in": "query" + "required": false }, { + "name": "preferenceGroupsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "preferenceGroupsCodes", - "in": "query" + "required": false }, { + "name": "createdByUserIds", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "integer" + "type": "integer", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "createdByUserIds", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching preferences at the property level.", - "schema": { - "$ref": "#/definitions/hotelPreferences" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching preferences at the property level.", + "schema": { + "$ref": "#/definitions/hotelPreferences" } }, "204": { "description": "Preferences not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to update and change existing preferences.OperationId:putPreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12205,24 +9752,27 @@ ], "tags": [ "ProfileConfiguration" - ], + ] + }, + "put": { "summary": "Change preferences", + "description": "Use this API to update and change existing preferences.OperationId:putPreferences
", "operationId": "putPreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing preferences at the property level.", "name": "hotelPreferences", "in": "body", "required": true, + "description": "Request object for changing preferences at the property level.", "schema": { "allOf": [ { @@ -12232,109 +9782,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "This will allow you to create new preferences.OperationId:postPreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12343,136 +9861,108 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Create preferences", - "operationId": "postPreferences", + ] + }, + "delete": { + "summary": "Delete preferences", + "description": "Use this API to delete preferences.OperationId:deletePreferences
", + "operationId": "deletePreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating preferences at the property level.", - "name": "hotelPreferences", - "in": "body", + "name": "preferenceCode", + "in": "query", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/hotelPreferences" - } - ] - } + "description": "Specifies the preference code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "preferenceGroup", + "in": "query", + "required": true, + "description": "Specifies the preference group the preference belongs to.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete preferences.OperationId:deletePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12481,139 +9971,107 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Delete preferences", - "operationId": "deletePreferences", + ] + }, + "post": { + "summary": "Create preferences", + "description": "This will allow you to create new preferences.OperationId:postPreferences
", + "operationId": "postPreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true - }, - { + "required": true, "type": "string", - "description": "Specifies the preference code.", - "name": "preferenceCode", - "in": "query", - "required": true + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Specifies the preference group the preference belongs to.", - "name": "preferenceGroup", - "in": "query", - "required": true + "name": "hotelPreferences", + "in": "body", + "required": true, + "description": "Request object for creating preferences at the property level.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/hotelPreferences" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/identificationTypes": { - "get": { - "description": "Use this API to get Identification Types such as passport, driver license, military ID, and so on.OperationId:getIdentificationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12621,143 +10079,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get identification types", - "operationId": "getIdentificationTypes", + "ProfileConfiguration" + ] + } + }, + "/identificationCountries": { + "get": { + "summary": "Get Identification Countries", + "description": "Use this API to get Identification Countries.OperationId:getIdentificationCountries
", + "operationId": "getIdentificationCountries", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" - }, + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Identification Types.", - "schema": { - "$ref": "#/definitions/identificationTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Identification Countries.", + "schema": { + "$ref": "#/definitions/identificationCountriesDetails" } }, "204": { - "description": "IdentificationTypes not found." + "description": "IdentificationCountries not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Identification Types.OperationId:postIdentificationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12766,129 +10201,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Identification Types", - "operationId": "postIdentificationTypes", + ] + }, + "post": { + "summary": "Create Identification Countries", + "description": "Use this API to create Identification Countries.OperationId:postIdentificationCountries
", + "operationId": "postIdentificationCountries", "parameters": [ { - "description": "Request object for creating Identification Types.", - "name": "identificationTypesCriteria", + "name": "identificationCountriesCriteria", "in": "body", "required": true, + "description": "Request object for creating Identification Countries.", "schema": { "allOf": [ { - "$ref": "#/definitions/identificationTypesCriteria" + "$ref": "#/definitions/identificationCountriesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/identificationTypes/{identificationTypesId}": { - "put": { - "description": "Use this API to update Identification Types.OperationId:putIdentificationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12897,136 +10301,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Identification Types", - "operationId": "putIdentificationTypes", + ] + } + }, + "/identificationCountries/{identificationCountriesId}": { + "put": { + "summary": "Change Identification Countries", + "description": "Use this API to update Identification Countries.OperationId:putIdentificationCountries
", + "operationId": "putIdentificationCountries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Identification Types.", - "name": "identificationTypesId", + "name": "identificationCountriesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Identification Countries." }, { - "description": "Request object for changing Identification Types.", - "name": "identificationTypesToBeChanged", + "name": "identificationCountriesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Identification Countries.", "schema": { "allOf": [ { - "$ref": "#/definitions/identificationTypesToBeChanged" + "$ref": "#/definitions/identificationCountriesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Identification Types.OperationId:deleteIdentificationTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13035,125 +10412,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Identification Types", - "operationId": "deleteIdentificationTypes", + ] + }, + "delete": { + "summary": "Delete Identification Countries", + "description": "Use this API to delete Identification Countries.OperationId:deleteIdentificationCountries
", + "operationId": "deleteIdentificationCountries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Identification Types.", - "name": "identificationTypesId", + "name": "identificationCountriesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Identification Countries." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/immigrationStatuses": { - "get": { - "description": "Use this API to get Immigration Statuses.OperationId:getImmigrationStatuses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13162,142 +10508,119 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Get Immigration Statuses", - "operationId": "getImmigrationStatuses", + ] + } + }, + "/identificationTypes": { + "get": { + "summary": "Get identification types", + "description": "Use this API to get Identification Types such as passport, driver license, military ID, and so on.OperationId:getIdentificationTypes
", + "operationId": "getIdentificationTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Immigration Statuses.", - "schema": { - "$ref": "#/definitions/immigrationStatusesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Identification Types.", + "schema": { + "$ref": "#/definitions/identificationTypesDetails" } }, "204": { - "description": "ImmigrationStatuses not found." + "description": "IdentificationTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Immigration Statuses.OperationId:postImmigrationStatuses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13306,129 +10629,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Immigration Statuses", - "operationId": "postImmigrationStatuses", + ] + }, + "post": { + "summary": "Create Identification Types", + "description": "Use this API to create Identification Types.OperationId:postIdentificationTypes
", + "operationId": "postIdentificationTypes", "parameters": [ { - "description": "Request object for creating Immigration Statuses.", - "name": "immigrationStatusesCriteria", + "name": "identificationTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Identification Types.", "schema": { "allOf": [ { - "$ref": "#/definitions/immigrationStatusesCriteria" + "$ref": "#/definitions/identificationTypesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/immigrationStatuses/{immigrationStatusCode}": { - "put": { - "description": "Use this API to update Immigration Statuses.OperationId:changeImmigrationStatuses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13437,136 +10729,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Immigration Statuses", - "operationId": "changeImmigrationStatuses", + ] + } + }, + "/identificationTypes/{identificationTypesId}": { + "put": { + "summary": "Change Identification Types", + "description": "Use this API to update Identification Types.OperationId:putIdentificationTypes
", + "operationId": "putIdentificationTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Immigration Statuses.", - "name": "immigrationStatusCode", + "name": "identificationTypesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Identification Types." }, { - "description": "Request object for changing Immigration Statuses.", - "name": "immigrationStatusesToBeChanged", + "name": "identificationTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Identification Types.", "schema": { "allOf": [ { - "$ref": "#/definitions/immigrationStatusesToBeChanged" + "$ref": "#/definitions/identificationTypesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Immigration Statuses.OperationId:removeImmigrationStatuses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13575,125 +10840,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Immigration Statuses", - "operationId": "removeImmigrationStatuses", + ] + }, + "delete": { + "summary": "Delete Identification Types", + "description": "Use this API to delete Identification Types.OperationId:deleteIdentificationTypes
", + "operationId": "deleteIdentificationTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Immigration Statuses.", - "name": "immigrationStatusCode", + "name": "identificationTypesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Identification Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/industryCodes": { - "get": { - "description": "Use this API to get Industry Codes.OperationId:getIndustryCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13702,142 +10936,119 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Get Industry Codes", - "operationId": "getIndustryCodes", + ] + } + }, + "/immigrationStatuses": { + "get": { + "summary": "Get Immigration Statuses", + "description": "Use this API to get Immigration Statuses.OperationId:getImmigrationStatuses
", + "operationId": "getImmigrationStatuses", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Industry Codes.", - "schema": { - "$ref": "#/definitions/industryCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Immigration Statuses.", + "schema": { + "$ref": "#/definitions/immigrationStatusesDetails" } }, "204": { - "description": "IndustryCodes not found." + "description": "ImmigrationStatuses not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Industry Codes.OperationId:postIndustryCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13846,129 +11057,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Industry Codes", - "operationId": "postIndustryCodes", + ] + }, + "post": { + "summary": "Create Immigration Statuses", + "description": "Use this API to create Immigration Statuses.OperationId:postImmigrationStatuses
", + "operationId": "postImmigrationStatuses", "parameters": [ { - "description": "Request object for creating Industry Codes.", - "name": "industryCodesCriteria", + "name": "immigrationStatusesCriteria", "in": "body", "required": true, + "description": "Request object for creating Immigration Statuses.", "schema": { "allOf": [ { - "$ref": "#/definitions/industryCodesCriteria" + "$ref": "#/definitions/immigrationStatusesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/industryCodes/{industryCodesId}": { - "put": { - "description": "Use this API to update Industry Codes.OperationId:putIndustryCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13977,136 +11157,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Industry Codes", - "operationId": "putIndustryCodes", + ] + } + }, + "/immigrationStatuses/{immigrationStatusCode}": { + "put": { + "summary": "Change Immigration Statuses", + "description": "Use this API to update Immigration Statuses.OperationId:changeImmigrationStatuses
", + "operationId": "changeImmigrationStatuses", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Industry Codes.", - "name": "industryCodesId", + "name": "immigrationStatusCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Immigration Statuses." }, { - "description": "Request object for changing Industry Codes.", - "name": "industryCodesToBeChanged", + "name": "immigrationStatusesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Immigration Statuses.", "schema": { "allOf": [ { - "$ref": "#/definitions/industryCodesToBeChanged" + "$ref": "#/definitions/immigrationStatusesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Industry Codes.OperationId:deleteIndustryCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14115,125 +11268,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Industry Codes", - "operationId": "deleteIndustryCodes", + ] + }, + "delete": { + "summary": "Delete Immigration Statuses", + "description": "Use this API to delete Immigration Statuses.OperationId:removeImmigrationStatuses
", + "operationId": "removeImmigrationStatuses", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Industry Codes.", - "name": "industryCodesId", + "name": "immigrationStatusCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Immigration Statuses." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/influenceCodes": { - "get": { - "description": "Use this API to get Influence Codes.OperationId:getInfluenceCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14242,142 +11364,119 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Get Influence Codes", - "operationId": "getInfluenceCodes", + ] + } + }, + "/industryCodes": { + "get": { + "summary": "Get Industry Codes", + "description": "Use this API to get Industry Codes.OperationId:getIndustryCodes
", + "operationId": "getIndustryCodes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Influence Codes.", - "schema": { - "$ref": "#/definitions/influenceCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Industry Codes.", + "schema": { + "$ref": "#/definitions/industryCodesDetails" } }, "204": { - "description": "InfluenceCodes not found." + "description": "IndustryCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Influence Codes.OperationId:postInfluenceCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14386,129 +11485,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Influence Codes", - "operationId": "postInfluenceCodes", + ] + }, + "post": { + "summary": "Create Industry Codes", + "description": "Use this API to create Industry Codes.OperationId:postIndustryCodes
", + "operationId": "postIndustryCodes", "parameters": [ { - "description": "Request object for creating Influence Codes.", - "name": "influenceCodesCriteria", + "name": "industryCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating Industry Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/influenceCodesCriteria" + "$ref": "#/definitions/industryCodesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/influenceCodes/{influenceCodesId}": { - "put": { - "description": "Use this API to update Influence Codes.OperationId:putInfluenceCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14517,136 +11585,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Influence Codes", - "operationId": "putInfluenceCodes", + ] + } + }, + "/industryCodes/{industryCodesId}": { + "put": { + "summary": "Change Industry Codes", + "description": "Use this API to update Industry Codes.OperationId:putIndustryCodes
", + "operationId": "putIndustryCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Influence Codes.", - "name": "influenceCodesId", + "name": "industryCodesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Industry Codes." }, { - "description": "Request object for changing Influence Codes.", - "name": "influenceCodesToBeChanged", + "name": "industryCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Industry Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/influenceCodesToBeChanged" + "$ref": "#/definitions/industryCodesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Influence Codes.OperationId:deleteInfluenceCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14655,125 +11696,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Influence Codes", - "operationId": "deleteInfluenceCodes", + ] + }, + "delete": { + "summary": "Delete Industry Codes", + "description": "Use this API to delete Industry Codes.OperationId:deleteIndustryCodes
", + "operationId": "deleteIndustryCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Influence Codes.", - "name": "influenceCodesId", + "name": "industryCodesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Industry Codes." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/keywordTypes": { - "get": { - "description": "Use this API to get Keyword Types.OperationId:getKeywordTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14782,142 +11792,119 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Get Keyword Types", - "operationId": "getKeywordTypes", + ] + } + }, + "/influenceCodes": { + "get": { + "summary": "Get Influence Codes", + "description": "Use this API to get Influence Codes.OperationId:getInfluenceCodes
", + "operationId": "getInfluenceCodes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Keyword Types.", - "schema": { - "$ref": "#/definitions/keywordTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Influence Codes.", + "schema": { + "$ref": "#/definitions/influenceCodesDetails" } }, "204": { - "description": "KeywordTypes not found." + "description": "InfluenceCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Keyword Types.OperationId:postKeywordTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14926,129 +11913,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Keyword Types", - "operationId": "postKeywordTypes", + ] + }, + "post": { + "summary": "Create Influence Codes", + "description": "Use this API to create Influence Codes.OperationId:postInfluenceCodes
", + "operationId": "postInfluenceCodes", "parameters": [ { - "description": "Request object for creating Keyword Types.", - "name": "keywordTypesCriteria", + "name": "influenceCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating Influence Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/keywordTypesCriteria" + "$ref": "#/definitions/influenceCodesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/keywordTypes/{keywordTypesId}": { - "put": { - "description": "Use this API to update Keyword Types.OperationId:putKeywordTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15057,136 +12013,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Keyword Types", - "operationId": "putKeywordTypes", + ] + } + }, + "/influenceCodes/{influenceCodesId}": { + "put": { + "summary": "Change Influence Codes", + "description": "Use this API to update Influence Codes.OperationId:putInfluenceCodes
", + "operationId": "putInfluenceCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Keyword Types.", - "name": "keywordTypesId", + "name": "influenceCodesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Influence Codes." }, { - "description": "Request object for changing Keyword Types.", - "name": "keywordTypesToBeChanged", + "name": "influenceCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Influence Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/keywordTypesToBeChanged" + "$ref": "#/definitions/influenceCodesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Keyword Types.OperationId:deleteKeywordTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15195,125 +12124,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Keyword Types", - "operationId": "deleteKeywordTypes", + ] + }, + "delete": { + "summary": "Delete Influence Codes", + "description": "Use this API to delete Influence Codes.OperationId:deleteInfluenceCodes
", + "operationId": "deleteInfluenceCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Keyword Types.", - "name": "keywordTypesId", + "name": "influenceCodesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Influence Codes." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/mailingActionCodes": { - "get": { - "description": "Use this API to get Mailing Action Codes.OperationId:getMailingActionCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15322,142 +12220,119 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Get Mailing Action Codes", - "operationId": "getMailingActionCodes", + ] + } + }, + "/keywordTypes": { + "get": { + "summary": "Get Keyword Types", + "description": "Use this API to get Keyword Types.OperationId:getKeywordTypes
", + "operationId": "getKeywordTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Mailing Action Codes.", - "schema": { - "$ref": "#/definitions/mailingActionCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Keyword Types.", + "schema": { + "$ref": "#/definitions/keywordTypesDetails" } }, "204": { - "description": "MailingActionCodes not found." + "description": "KeywordTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Mailing Action Codes.OperationId:postMailingActionCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15466,129 +12341,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Mailing Action Codes", - "operationId": "postMailingActionCodes", + ] + }, + "post": { + "summary": "Create Keyword Types", + "description": "Use this API to create Keyword Types.OperationId:postKeywordTypes
", + "operationId": "postKeywordTypes", "parameters": [ { - "description": "Request object for creating Mailing Action Codes.", - "name": "mailingActionCodesCriteria", + "name": "keywordTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Keyword Types.", "schema": { "allOf": [ { - "$ref": "#/definitions/mailingActionCodesCriteria" + "$ref": "#/definitions/keywordTypesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/mailingActionCodes/{mailingActionCode}": { - "put": { - "description": "Use this API to update Mailing Action Codes.OperationId:changeMailingActionCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15597,136 +12441,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Mailing Action Codes", - "operationId": "changeMailingActionCodes", + ] + } + }, + "/keywordTypes/{keywordTypesId}": { + "put": { + "summary": "Change Keyword Types", + "description": "Use this API to update Keyword Types.OperationId:putKeywordTypes
", + "operationId": "putKeywordTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Mailing Action.", - "name": "mailingActionCode", + "name": "keywordTypesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Keyword Types." }, { - "description": "Request object for changing Mailing Action Codes.", - "name": "mailingActionCodesToBeChanged", + "name": "keywordTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Keyword Types.", "schema": { "allOf": [ { - "$ref": "#/definitions/mailingActionCodesToBeChanged" + "$ref": "#/definitions/keywordTypesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Mailing Action Codes.OperationId:removeMailingActionCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15735,125 +12552,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Mailing Action Codes", - "operationId": "removeMailingActionCodes", + ] + }, + "delete": { + "summary": "Delete Keyword Types", + "description": "Use this API to delete Keyword Types.OperationId:deleteKeywordTypes
", + "operationId": "deleteKeywordTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Mailing Action.", - "name": "mailingActionCode", + "name": "keywordTypesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Keyword Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipAwards": { - "get": { - "description": "You can use this API to get Membership Awards.OperationId:getMembershipAwards
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15861,162 +12647,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Get Membership Awards", - "operationId": "getMembershipAwards", + "ChainConfig" + ] + } + }, + "/mailingActionCodes": { + "get": { + "summary": "Get Mailing Action Codes", + "description": "Use this API to get Mailing Action Codes.OperationId:getMailingActionCodes
", + "operationId": "getMailingActionCodes", "parameters": [ { - "type": "string", - "description": "Membership type for which awards are defined.", - "name": "membershipType", - "in": "query" + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "awardCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description for the membership award.", "name": "description", - "in": "query" - }, - { - "type": "string", - "format": "date", - "description": "Date when membership award is valid.", - "name": "validForDate", - "in": "query" - }, - { - "type": "boolean", - "description": "Flag to decide whether or not to include inactive records in search result set.", - "name": "includeInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "boolean", - "description": "Fetch operation will return only Membership Award records by default. If Include Details is true, then it will return associated child records like Membership Award Rate/Product/Upgrade/FT as well.", - "name": "includeDetails", - "in": "query" + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-externalsystem" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" - }, - { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response to fetch Membership Awards.", - "schema": { - "$ref": "#/definitions/membershipAwardsInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Mailing Action Codes.", + "schema": { + "$ref": "#/definitions/mailingActionCodesDetails" } }, "204": { - "description": "MembershipAwards not found." + "description": "MailingActionCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create Membership Awards.OperationId:postMembershipAwards
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16024,130 +12768,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Create Membership Awards", - "operationId": "postMembershipAwards", + "ChainConfig" + ] + }, + "post": { + "summary": "Create Mailing Action Codes", + "description": "Use this API to create Mailing Action Codes.OperationId:postMailingActionCodes
", + "operationId": "postMailingActionCodes", "parameters": [ { - "description": "Request object for creating new membership awards.", - "name": "membershipAwards", + "name": "mailingActionCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating Mailing Action Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipAwards" + "$ref": "#/definitions/mailingActionCodesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipAwards/{membershipAwardsId}": { - "put": { - "description": "You can use this API to change Membership Awards.OperationId:putMembershipAwards
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16155,137 +12868,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Change Membership Awards", - "operationId": "putMembershipAwards", + "ChainConfig" + ] + } + }, + "/mailingActionCodes/{mailingActionCode}": { + "put": { + "summary": "Change Mailing Action Codes", + "description": "Use this API to update Mailing Action Codes.OperationId:changeMailingActionCodes
", + "operationId": "changeMailingActionCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipAwardsId", + "name": "mailingActionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Mailing Action." }, { - "description": "Request object for modifying membership awards.", - "name": "membershipAwards", + "name": "mailingActionCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Mailing Action Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipAwards" + "$ref": "#/definitions/mailingActionCodesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete Membership Awards.OperationId:deleteMembershipAwards
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16293,136 +12979,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Delete Membership Awards", - "operationId": "deleteMembershipAwards", + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Mailing Action Codes", + "description": "Use this API to delete Mailing Action Codes.OperationId:removeMailingActionCodes
", + "operationId": "removeMailingActionCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipAwardsId", + "name": "mailingActionCode", "in": "path", - "required": true - }, - { - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "description": "Membership type for which awards are defined.", - "name": "membershipType", - "in": "query" + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Mailing Action." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipBenefitPrograms": { - "get": { - "description": "This API allows you to fetch Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.OperationId:getMembershipBenefitPrograms
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16430,152 +13075,142 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Retrieve a Membership Benefit Program", - "operationId": "getMembershipBenefitPrograms", + "ChainConfig" + ] + } + }, + "/membershipAwards": { + "get": { + "summary": "Get Membership Awards", + "description": "You can use this API to get Membership Awards.OperationId:getMembershipAwards
", + "operationId": "getMembershipAwards", "parameters": [ { - "type": "string", - "description": "Membership type", "name": "membershipType", - "in": "query" + "in": "query", + "required": false, + "description": "Membership type for which awards are defined.", + "type": "string" }, { - "type": "string", - "description": "Benefit Code", - "name": "code", - "in": "query" + "name": "awardCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", - "name": "end", - "in": "query" + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", - "name": "start", - "in": "query" + "name": "description", + "in": "query", + "required": false, + "description": "Description for the membership award.", + "type": "string" }, { + "name": "validForDate", + "in": "query", + "required": false, + "description": "Date when membership award is valid.", "type": "string", - "description": "Min value for membership level. This is the minimum membership level member gets for enrolling into this program.", - "name": "minimumLevel", - "in": "query" + "format": "date" }, { - "type": "boolean", - "description": "Flag to decide whether or not to include inactive records in search result set.", "name": "includeInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Flag to decide whether or not to include inactive records in search result set.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "includeDetails", + "in": "query", + "required": false, + "description": "Fetch operation will return only Membership Award records by default. If Include Details is true, then it will return associated child records like Membership Award Rate/Product/Upgrade/FT as well.", + "type": "boolean" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching membership benefit programs.", - "schema": { - "$ref": "#/definitions/membershipBenefitProgramsInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response to fetch Membership Awards.", + "schema": { + "$ref": "#/definitions/membershipAwardsInfo" } }, "204": { - "description": "MembershipBenefitPrograms not found." + "description": "MembershipAwards not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "This API is used to create Membership Benefit Programs of a Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.OperationId:postMembershipBenefitPrograms
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16584,129 +13219,98 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Create Membership Benefit Program", - "operationId": "postMembershipBenefitPrograms", + ] + }, + "post": { + "summary": "Create Membership Awards", + "description": "You can use this API to create Membership Awards.OperationId:postMembershipAwards
", + "operationId": "postMembershipAwards", "parameters": [ { - "description": "Request object for creating new membership benefit programs.", - "name": "membershipBenefitPrograms", + "name": "membershipAwards", "in": "body", "required": true, + "description": "Request object for creating new membership awards.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipBenefitPrograms" + "$ref": "#/definitions/membershipAwards" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipBenefitPrograms/{membershipBenefitProgramsId}": { - "put": { - "description": "This API allows you to modify Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.OperationId:putMembershipBenefitPrograms
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16715,136 +13319,109 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Change Membership Benefit Program", - "operationId": "putMembershipBenefitPrograms", + ] + } + }, + "/membershipAwards/{membershipAwardsId}": { + "put": { + "summary": "Change Membership Awards", + "description": "You can use this API to change Membership Awards.OperationId:putMembershipAwards
", + "operationId": "putMembershipAwards", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipBenefitProgramsId", + "name": "membershipAwardsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "description": "Request object for modifying membership benefit programs.", - "name": "membershipBenefitPrograms", + "name": "membershipAwards", "in": "body", "required": true, + "description": "Request object for modifying membership awards.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipBenefitPrograms" + "$ref": "#/definitions/membershipAwards" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "This API will allow you to delete s Membership Benefit Programs of a Membership Type.OperationId:deleteMembershipBenefitPrograms
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16853,135 +13430,105 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Delete Membership Benedict Program", - "operationId": "deleteMembershipBenefitPrograms", + ] + }, + "delete": { + "summary": "Delete Membership Awards", + "description": "You can use this API to delete Membership Awards.OperationId:deleteMembershipAwards
", + "operationId": "deleteMembershipAwards", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipBenefitProgramsId", + "name": "membershipAwardsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { + "name": "membershipType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Membership type for which awards are defined.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Membership type", - "name": "membershipType", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipClaimOrigins": { - "get": { - "description": "Use this API to get Membership Claim Origins.OperationId:getMembershipClaimOrigins
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16989,143 +13536,131 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Membership Claim Origins", - "operationId": "getMembershipClaimOrigins", + "MembershipConfig" + ] + } + }, + "/membershipBenefitPrograms": { + "get": { + "summary": "Retrieve a Membership Benefit Program", + "description": "This API allows you to fetch Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.OperationId:getMembershipBenefitPrograms
", + "operationId": "getMembershipBenefitPrograms", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" + "name": "membershipType", + "in": "query", + "required": false, + "description": "Membership type", + "type": "string" }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "name": "code", + "in": "query", + "required": false, + "description": "Benefit Code", + "type": "string" }, { + "name": "end", + "in": "query", + "required": false, + "description": "The ending value of the date range.", "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "format": "date" }, { + "name": "start", + "in": "query", + "required": false, + "description": "The starting value of the date range.", "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "format": "date" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "minimumLevel", + "in": "query", + "required": false, + "description": "Min value for membership level. This is the minimum membership level member gets for enrolling into this program.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Flag to decide whether or not to include inactive records in search result set.", + "type": "boolean" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Claim Origins.", - "schema": { - "$ref": "#/definitions/membershipClaimOriginsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching membership benefit programs.", + "schema": { + "$ref": "#/definitions/membershipBenefitProgramsInfo" } }, "204": { - "description": "MembershipClaimOrigins not found." + "description": "MembershipBenefitPrograms not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Membership Claim Origins.OperationId:postMembershipClaimOrigins
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17133,130 +13668,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Membership Claim Origins", - "operationId": "postMembershipClaimOrigins", + "MembershipConfig" + ] + }, + "post": { + "summary": "Create Membership Benefit Program", + "description": "This API is used to create Membership Benefit Programs of a Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.OperationId:postMembershipBenefitPrograms
", + "operationId": "postMembershipBenefitPrograms", "parameters": [ { - "description": "Request object for creating Membership Claim Origins.", - "name": "membershipClaimOriginsCriteria", + "name": "membershipBenefitPrograms", "in": "body", "required": true, + "description": "Request object for creating new membership benefit programs.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipClaimOriginsCriteria" + "$ref": "#/definitions/membershipBenefitPrograms" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipClaimOrigins/{membershipClaimOriginCode}": { - "put": { - "description": "Use this API to update Membership Claim Origins.OperationId:changeMembershipClaimOrigins
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17264,137 +13768,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Membership Claim Origins", - "operationId": "changeMembershipClaimOrigins", + "MembershipConfig" + ] + } + }, + "/membershipBenefitPrograms/{membershipBenefitProgramsId}": { + "put": { + "summary": "Change Membership Benefit Program", + "description": "This API allows you to modify Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.OperationId:putMembershipBenefitPrograms
", + "operationId": "putMembershipBenefitPrograms", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Membership Claim Origins.", - "name": "membershipClaimOriginCode", + "name": "membershipBenefitProgramsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "description": "Request object for changing Membership Claim Origins.", - "name": "membershipClaimOriginsToBeChanged", + "name": "membershipBenefitPrograms", "in": "body", "required": true, + "description": "Request object for modifying membership benefit programs.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipClaimOriginsToBeChanged" + "$ref": "#/definitions/membershipBenefitPrograms" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Membership Claim Origins.OperationId:removeMembershipClaimOrigins
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17402,126 +13879,106 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Membership Claim Origins", - "operationId": "removeMembershipClaimOrigins", + "MembershipConfig" + ] + }, + "delete": { + "summary": "Delete Membership Benedict Program", + "description": "This API will allow you to delete s Membership Benefit Programs of a Membership Type.OperationId:deleteMembershipBenefitPrograms
", + "operationId": "deleteMembershipBenefitPrograms", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Membership Claim Origins.", - "name": "membershipClaimOriginCode", + "name": "membershipBenefitProgramsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "membershipType", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Membership type", + "items": { + "type": "string" + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipClaimTypes": { - "get": { - "description": "Use this API to get Membership Claim Types.OperationId:getMembershipClaimTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17529,143 +13986,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Membership Claim Types", - "operationId": "getMembershipClaimTypes", + "MembershipConfig" + ] + } + }, + "/membershipClaimOrigins": { + "get": { + "summary": "Get Membership Claim Origins", + "description": "Use this API to get Membership Claim Origins.OperationId:getMembershipClaimOrigins
", + "operationId": "getMembershipClaimOrigins", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Claim Types.", - "schema": { - "$ref": "#/definitions/membershipClaimTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Claim Origins.", + "schema": { + "$ref": "#/definitions/membershipClaimOriginsDetails" } }, "204": { - "description": "MembershipClaimTypes not found." + "description": "MembershipClaimOrigins not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Membership Claim Types.OperationId:postMembershipClaimTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17674,129 +14108,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Membership Claim Types", - "operationId": "postMembershipClaimTypes", + ] + }, + "post": { + "summary": "Create Membership Claim Origins", + "description": "Use this API to create Membership Claim Origins.OperationId:postMembershipClaimOrigins
", + "operationId": "postMembershipClaimOrigins", "parameters": [ { - "description": "Request object for creating Membership Claim Types.", - "name": "membershipClaimTypesCriteria", + "name": "membershipClaimOriginsCriteria", "in": "body", "required": true, + "description": "Request object for creating Membership Claim Origins.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipClaimTypesCriteria" + "$ref": "#/definitions/membershipClaimOriginsCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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" } - } - }, - "400": { - "description": "Bad Request", + }, + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$ref": "#/definitions/status" } }, + "400": { + "$ref": "#/responses/400" + }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipClaimTypes/{membershipClaimTypeCode}": { - "put": { - "description": "Use this API to update Membership Claim Types.OperationId:changeMembershipClaimTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17805,136 +14208,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Membership Claim Types", - "operationId": "changeMembershipClaimTypes", + ] + } + }, + "/membershipClaimOrigins/{membershipClaimOriginCode}": { + "put": { + "summary": "Change Membership Claim Origins", + "description": "Use this API to update Membership Claim Origins.OperationId:changeMembershipClaimOrigins
", + "operationId": "changeMembershipClaimOrigins", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Membership Claim Types.", - "name": "membershipClaimTypeCode", + "name": "membershipClaimOriginCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Membership Claim Origins." }, { - "description": "Request object for changing Membership Claim Types.", - "name": "membershipClaimTypesToBeChanged", + "name": "membershipClaimOriginsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Membership Claim Origins.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipClaimTypesToBeChanged" + "$ref": "#/definitions/membershipClaimOriginsToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Membership Claim Types.OperationId:removeMembershipClaimTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17943,125 +14319,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Membership Claim Types", - "operationId": "removeMembershipClaimTypes", + ] + }, + "delete": { + "summary": "Delete Membership Claim Origins", + "description": "Use this API to delete Membership Claim Origins.OperationId:removeMembershipClaimOrigins
", + "operationId": "removeMembershipClaimOrigins", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Membership Claim Types.", - "name": "membershipClaimTypeCode", + "name": "membershipClaimOriginCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Membership Claim Origins." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipClasses": { - "get": { - "description": "Retrieve a list of membership classes that are configured.OperationId:getMembershipClasses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18069,143 +14414,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Get Membership classes", - "operationId": "getMembershipClasses", + "ChainConfig" + ] + } + }, + "/membershipClaimTypes": { + "get": { + "summary": "Get Membership Claim Types", + "description": "Use this API to get Membership Claim Types.OperationId:getMembershipClaimTypes
", + "operationId": "getMembershipClaimTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Class.", - "schema": { - "$ref": "#/definitions/membershipClassesInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Claim Types.", + "schema": { + "$ref": "#/definitions/membershipClaimTypesDetails" } }, "204": { - "description": "MembershipClasses not found." + "description": "MembershipClaimTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Create a new membership class.OperationId:postMembershipClasses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18213,130 +14535,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Create Membership classes", - "operationId": "postMembershipClasses", + "ChainConfig" + ] + }, + "post": { + "summary": "Create Membership Claim Types", + "description": "Use this API to create Membership Claim Types.OperationId:postMembershipClaimTypes
", + "operationId": "postMembershipClaimTypes", "parameters": [ { - "description": "Request object for creating Membership Class", - "name": "membershipClasses", + "name": "membershipClaimTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Membership Claim Types.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipClasses" + "$ref": "#/definitions/membershipClaimTypesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipClasses/{membershipClassId}": { - "put": { - "description": "Update an existing membership classOperationId:putMembershipClasses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18344,137 +14635,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Change Membership classes", - "operationId": "putMembershipClasses", + "ChainConfig" + ] + } + }, + "/membershipClaimTypes/{membershipClaimTypeCode}": { + "put": { + "summary": "Change Membership Claim Types", + "description": "Use this API to update Membership Claim Types.OperationId:changeMembershipClaimTypes
", + "operationId": "changeMembershipClaimTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipClassId", + "name": "membershipClaimTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Membership Claim Types." }, { - "description": "Request object for changing Membership Class.", - "name": "membershipClasses", + "name": "membershipClaimTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Membership Claim Types.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipClasses" + "$ref": "#/definitions/membershipClaimTypesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for changing Membership Class.", - "schema": { - "$ref": "#/definitions/membershipClassesInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Delete an existing membership class.OperationId:deleteMembershipClasses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18482,126 +14746,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Delete Membership classes", - "operationId": "deleteMembershipClasses", + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Membership Claim Types", + "description": "Use this API to delete Membership Claim Types.OperationId:removeMembershipClaimTypes
", + "operationId": "removeMembershipClaimTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipClassId", + "name": "membershipClaimTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Membership Claim Types." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipEnrollmentCodes": { - "get": { - "description": "Use this API to get Membership Enrollment Codes.OperationId:getMembershipEnrollmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18610,142 +14843,119 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Get Membership Enrollment Codes", - "operationId": "getMembershipEnrollmentCodes", + ] + } + }, + "/membershipClasses": { + "get": { + "summary": "Get Membership classes", + "description": "Retrieve a list of membership classes that are configured.OperationId:getMembershipClasses
", + "operationId": "getMembershipClasses", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Enrollment Codes.", - "schema": { - "$ref": "#/definitions/membershipEnrollmentCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Class.", + "schema": { + "$ref": "#/definitions/membershipClassesInfo" } }, "204": { - "description": "MembershipEnrollmentCodes not found." + "description": "MembershipClasses not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Membership Enrollment Codes.OperationId:postMembershipEnrollmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18753,130 +14963,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Membership Enrollment Codes", - "operationId": "postMembershipEnrollmentCodes", + "MembershipConfig" + ] + }, + "post": { + "summary": "Create Membership classes", + "description": "Create a new membership class.OperationId:postMembershipClasses
", + "operationId": "postMembershipClasses", "parameters": [ { - "description": "Request object for creating Membership Enrollment Codes.", - "name": "membershipEnrollmentCodesCriteria", + "name": "membershipClasses", "in": "body", "required": true, + "description": "Request object for creating Membership Class", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipEnrollmentCodesCriteria" + "$ref": "#/definitions/membershipClasses" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipEnrollmentCodes/{enrollmentCode}": { - "put": { - "description": "Use this API to update Membership Enrollment Codes.OperationId:changeMembershipEnrollmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18884,137 +15063,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Membership Enrollment Codes", - "operationId": "changeMembershipEnrollmentCodes", + "MembershipConfig" + ] + } + }, + "/membershipClasses/{membershipClassId}": { + "put": { + "summary": "Change Membership classes", + "description": "Update an existing membership classOperationId:putMembershipClasses
", + "operationId": "putMembershipClasses", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Enrollment.", - "name": "enrollmentCode", + "name": "membershipClassId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "description": "Request object for changing Membership Enrollment Codes.", - "name": "membershipEnrollmentCodesToBeChanged", + "name": "membershipClasses", "in": "body", "required": true, + "description": "Request object for changing Membership Class.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipEnrollmentCodesToBeChanged" + "$ref": "#/definitions/membershipClasses" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 changing Membership Class.", + "schema": { + "$ref": "#/definitions/membershipClassesInfo" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Membership Enrollment Codes.OperationId:removeMembershipEnrollmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19022,126 +15174,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Membership Enrollment Codes", - "operationId": "removeMembershipEnrollmentCodes", - "parameters": [ - { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Enrollment.", - "name": "enrollmentCode", + "MembershipConfig" + ] + }, + "delete": { + "summary": "Delete Membership classes", + "description": "Delete an existing membership class.OperationId:deleteMembershipClasses
", + "operationId": "deleteMembershipClasses", + "parameters": [ + { + "name": "membershipClassId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipEnrollmentGroups": { - "get": { - "description": "Retrieve a list of membership Enrollment Groups that are configured.OperationId:getMembershipEnrollmentGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19150,149 +15271,119 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Get Membership enrollment groups", - "operationId": "getMembershipEnrollmentGroups", + ] + } + }, + "/membershipEnrollmentCodes": { + "get": { + "summary": "Get Membership Enrollment Codes", + "description": "Use this API to get Membership Enrollment Codes.OperationId:getMembershipEnrollmentCodes
", + "operationId": "getMembershipEnrollmentCodes", "parameters": [ { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "default": 0, - "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", - "name": "offset", - "in": "query" + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "enrollmentCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the enrollment group to be fetched.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching membership enrollment groups.", - "schema": { - "$ref": "#/definitions/membershipEnrollmentGroupsInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Enrollment Codes.", + "schema": { + "$ref": "#/definitions/membershipEnrollmentCodesDetails" } }, "204": { - "description": "MembershipEnrollmentGroups not found." + "description": "MembershipEnrollmentCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Create a new membership enrollment group.OperationId:postMembershipEnrollmentGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19300,130 +15391,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Create Membership enrollment groups", - "operationId": "postMembershipEnrollmentGroups", + "ChainConfig" + ] + }, + "post": { + "summary": "Create Membership Enrollment Codes", + "description": "Use this API to create Membership Enrollment Codes.OperationId:postMembershipEnrollmentCodes
", + "operationId": "postMembershipEnrollmentCodes", "parameters": [ { - "description": "Request object for creating new membership enrollment groups.", - "name": "membershipEnrollmentGroups", + "name": "membershipEnrollmentCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating Membership Enrollment Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipEnrollmentGroups" + "$ref": "#/definitions/membershipEnrollmentCodesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipEnrollmentGroups/{membershipEnrollmentGroupsId}": { - "put": { - "description": "Update an existing membership group.OperationId:putMembershipEnrollmentGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19431,137 +15491,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Change Membership enrollment groups", - "operationId": "putMembershipEnrollmentGroups", + "ChainConfig" + ] + } + }, + "/membershipEnrollmentCodes/{enrollmentCode}": { + "put": { + "summary": "Change Membership Enrollment Codes", + "description": "Use this API to update Membership Enrollment Codes.OperationId:changeMembershipEnrollmentCodes
", + "operationId": "changeMembershipEnrollmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipEnrollmentGroupsId", + "name": "enrollmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Enrollment." }, { - "description": "Request object for changing new membership enrollment groups.", - "name": "membershipEnrollmentGroups", + "name": "membershipEnrollmentCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Membership Enrollment Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipEnrollmentGroups" + "$ref": "#/definitions/membershipEnrollmentCodesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "delete an existing membership group.OperationId:deleteMembershipEnrollmentGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19569,126 +15602,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Remove Membership enrollment groups", - "operationId": "deleteMembershipEnrollmentGroups", + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Membership Enrollment Codes", + "description": "Use this API to delete Membership Enrollment Codes.OperationId:removeMembershipEnrollmentCodes
", + "operationId": "removeMembershipEnrollmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipEnrollmentGroupsId", + "name": "enrollmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Enrollment." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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" } - } - }, - "400": { - "description": "Bad Request", + }, + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$ref": "#/definitions/status" } }, + "400": { + "$ref": "#/responses/400" + }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipFolioTexts": { - "post": { - "description": "You can use this API to Set Membership folio texts.OperationId:postMembershipFolioTexts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19696,130 +15698,128 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Set Membership folio texts", - "operationId": "postMembershipFolioTexts", + "ChainConfig" + ] + } + }, + "/membershipEnrollmentGroups": { + "get": { + "summary": "Get Membership enrollment groups", + "description": "Retrieve a list of membership Enrollment Groups that are configured.OperationId:getMembershipEnrollmentGroups
", + "operationId": "getMembershipEnrollmentGroups", "parameters": [ { - "description": "Collection of FolioTexts to be inserted at MembershipLevel.", - "name": "membershipFolioTexts", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/membershipFolioTexts" - } - ] - } + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "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" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "enrollmentCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "name": "description", + "in": "query", + "required": false, + "description": "Description of the enrollment group to be fetched.", + "type": "string" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" - }, - "Location": { - "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching membership enrollment groups.", + "schema": { + "$ref": "#/definitions/membershipEnrollmentGroupsInfo" } }, + "204": { + "description": "MembershipEnrollmentGroups not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipLevels": { - "get": { - "description": "You can use this API to get Membership levels.OperationId:getMembershipLevels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19828,143 +15828,98 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Get Membership levels", - "operationId": "getMembershipLevels", + ] + }, + "post": { + "summary": "Create Membership enrollment groups", + "description": "Create a new membership enrollment group.OperationId:postMembershipEnrollmentGroups
", + "operationId": "postMembershipEnrollmentGroups", "parameters": [ { - "type": "string", - "description": "Type of membership that the levels belong to.", - "name": "membershipTypeCode", - "in": "query", - "required": true - }, - { - "type": "boolean", - "default": "false", - "description": "Inactive flag - whether or not to display inactive records.", - "name": "includeInactive", - "in": "query" - }, - { - "type": "boolean", - "description": "Boolean flag to fetch membership type levels with/without folio text. 'True' indicates including folio texts for corresponding membership type level.", - "name": "includeFolioTexts", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "hotelIds", - "in": "query" + "name": "membershipEnrollmentGroups", + "in": "body", + "required": true, + "description": "Request object for creating new membership enrollment groups.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipEnrollmentGroups" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Response object for fetching membership levels.", - "schema": { - "$ref": "#/definitions/membershipLevelsInfo" - }, + "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "MembershipLevels not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create Membership levels.OperationId:postMembershipLevels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19973,129 +15928,109 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Create Membership levels", - "operationId": "postMembershipLevels", + ] + } + }, + "/membershipEnrollmentGroups/{membershipEnrollmentGroupsId}": { + "put": { + "summary": "Change Membership enrollment groups", + "description": "Update an existing membership group.OperationId:putMembershipEnrollmentGroups
", + "operationId": "putMembershipEnrollmentGroups", "parameters": [ { - "description": "Request object for creating new membership levels.", - "name": "membershipLevels", + "name": "membershipEnrollmentGroupsId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" + }, + { + "name": "membershipEnrollmentGroups", "in": "body", "required": true, + "description": "Request object for changing new membership enrollment groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipLevels" + "$ref": "#/definitions/membershipEnrollmentGroups" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipLevels/{membershipLevelsId}": { - "put": { - "description": "You can use this API to change Membership levels.OperationId:putMembershipLevels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -20104,136 +16039,94 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Change Membership levels", - "operationId": "putMembershipLevels", + ] + }, + "delete": { + "summary": "Remove Membership enrollment groups", + "description": "delete an existing membership group.OperationId:deleteMembershipEnrollmentGroups
", + "operationId": "deleteMembershipEnrollmentGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipLevelsId", + "name": "membershipEnrollmentGroupsId", "in": "path", - "required": true - }, - { - "description": "Request object for modifying membership levels.", - "name": "membershipLevels", - "in": "body", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/membershipLevels" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete Membership levels.OperationId:deleteMembershipLevels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -20242,135 +16135,100 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Delete Membership levels", - "operationId": "deleteMembershipLevels", + ] + } + }, + "/membershipFolioTexts": { + "post": { + "summary": "Set Membership folio texts", + "description": "You can use this API to Set Membership folio texts.OperationId:postMembershipFolioTexts
", + "operationId": "postMembershipFolioTexts", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipLevelsId", - "in": "path", - "required": true - }, - { - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "description": "Membership type", - "name": "type", - "in": "query" + "name": "membershipFolioTexts", + "in": "body", + "required": true, + "description": "Collection of FolioTexts to be inserted at MembershipLevel.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipFolioTexts" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipMarketGroups": { - "get": { - "description": "You can use this API to get Membership market groups.OperationId:getMembershipMarketGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -20379,142 +16237,119 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Get Membership market groups", - "operationId": "getMembershipMarketGroups", + ] + } + }, + "/membershipLevels": { + "get": { + "summary": "Get Membership levels", + "description": "You can use this API to get Membership levels.OperationId:getMembershipLevels
", + "operationId": "getMembershipLevels", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" + "name": "membershipTypeCode", + "in": "query", + "required": true, + "description": "Type of membership that the levels belong to.", + "type": "string" }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "name": "includeInactive", + "in": "query", + "default": "false", + "required": false, + "description": "Inactive flag - whether or not to display inactive records.", + "type": "boolean" }, { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "name": "includeFolioTexts", + "in": "query", + "required": false, + "description": "Boolean flag to fetch membership type levels with/without folio text. 'True' indicates including folio texts for corresponding membership type level.", + "type": "boolean" }, { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Market Groups configurations.", - "schema": { - "$ref": "#/definitions/membershipMarketGroupsInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching membership levels.", + "schema": { + "$ref": "#/definitions/membershipLevelsInfo" } }, "204": { - "description": "MembershipMarketGroups not found." + "description": "MembershipLevels not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create Membership market groups.OperationId:postMembershipMarketGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -20523,129 +16358,98 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Create Membership market groups", - "operationId": "postMembershipMarketGroups", + ] + }, + "post": { + "summary": "Create Membership levels", + "description": "You can use this API to create Membership levels.OperationId:postMembershipLevels
", + "operationId": "postMembershipLevels", "parameters": [ { - "description": "Request object for creating new Membership Market Group Configurations.", - "name": "membershipMarketGroups", + "name": "membershipLevels", "in": "body", "required": true, + "description": "Request object for creating new membership levels.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipMarketGroups" + "$ref": "#/definitions/membershipLevels" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipMarketGroups/{membershipMarketGroupId}": { - "put": { - "description": "You can use this API to change Membership market groups.OperationId:putMembershipMarketGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -20654,136 +16458,109 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Change Membership market groups", - "operationId": "putMembershipMarketGroups", + ] + } + }, + "/membershipLevels/{membershipLevelsId}": { + "put": { + "summary": "Change Membership levels", + "description": "You can use this API to change Membership levels.OperationId:putMembershipLevels
", + "operationId": "putMembershipLevels", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipMarketGroupId", + "name": "membershipLevelsId", "in": "path", - "required": true - }, - { - "description": "Request object for changing existing Membership Market Groups Configurations.", - "name": "membershipMarketGroups", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" + }, + { + "name": "membershipLevels", "in": "body", "required": true, + "description": "Request object for modifying membership levels.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipMarketGroups" + "$ref": "#/definitions/membershipLevels" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete Membership market groups.OperationId:deleteMembershipMarketGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -20792,125 +16569,105 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Delete Membership market groups", - "operationId": "deleteMembershipMarketGroups", + ] + }, + "delete": { + "summary": "Delete Membership levels", + "description": "You can use this API to delete Membership levels.OperationId:deleteMembershipLevels
", + "operationId": "deleteMembershipLevels", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipMarketGroupId", + "name": "membershipLevelsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "type", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Membership type", + "items": { + "type": "string" + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipPropertyGroups": { - "get": { - "description": "You can use this API to get Membership property groups.OperationId:getMembershipPropertyGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -20919,142 +16676,119 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Get Membership property groups", - "operationId": "getMembershipPropertyGroups", + ] + } + }, + "/membershipMarketGroups": { + "get": { + "summary": "Get Membership market groups", + "description": "You can use this API to get Membership market groups.OperationId:getMembershipMarketGroups
", + "operationId": "getMembershipMarketGroups", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Property Groups configurations.", - "schema": { - "$ref": "#/definitions/membershipPropertyGroupsInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Market Groups configurations.", + "schema": { + "$ref": "#/definitions/membershipMarketGroupsInfo" } }, "204": { - "description": "MembershipPropertyGroups not found." + "description": "MembershipMarketGroups not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create Membership property groups.OperationId:postMembershipPropertyGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -21063,129 +16797,98 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Create Membership property groups", - "operationId": "postMembershipPropertyGroups", + ] + }, + "post": { + "summary": "Create Membership market groups", + "description": "You can use this API to create Membership market groups.OperationId:postMembershipMarketGroups
", + "operationId": "postMembershipMarketGroups", "parameters": [ { - "description": "Request object for creating new Membership Property Groups Configurations.", - "name": "membershipPropertyGroups", + "name": "membershipMarketGroups", "in": "body", "required": true, + "description": "Request object for creating new Membership Market Group Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipPropertyGroups" + "$ref": "#/definitions/membershipMarketGroups" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipPropertyGroups/{membershipPropertyGroupsId}": { - "put": { - "description": "You can use this API to change Membership property groups.OperationId:putMembershipPropertyGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -21194,136 +16897,109 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Change Membership property groups", - "operationId": "putMembershipPropertyGroups", + ] + } + }, + "/membershipMarketGroups/{membershipMarketGroupId}": { + "put": { + "summary": "Change Membership market groups", + "description": "You can use this API to change Membership market groups.OperationId:putMembershipMarketGroups
", + "operationId": "putMembershipMarketGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipPropertyGroupsId", + "name": "membershipMarketGroupId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "description": "Request object for changing existing Membership Property Groups Configurations.", - "name": "membershipPropertyGroups", + "name": "membershipMarketGroups", "in": "body", "required": true, + "description": "Request object for changing existing Membership Market Groups Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipPropertyGroups" + "$ref": "#/definitions/membershipMarketGroups" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete Membership property groups.OperationId:deleteMembershipPropertyGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -21332,125 +17008,94 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Delete Membership property groups", - "operationId": "deleteMembershipPropertyGroups", + ] + }, + "delete": { + "summary": "Delete Membership market groups", + "description": "You can use this API to delete Membership market groups.OperationId:deleteMembershipMarketGroups
", + "operationId": "deleteMembershipMarketGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipPropertyGroupsId", + "name": "membershipMarketGroupId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipRateGroups": { - "get": { - "description": "You can use this API to get Membership rate groups.OperationId:getMembershipRateGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -21459,142 +17104,119 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Get Membership rate groups", - "operationId": "getMembershipRateGroups", + ] + } + }, + "/membershipPropertyGroups": { + "get": { + "summary": "Get Membership property groups", + "description": "You can use this API to get Membership property groups.OperationId:getMembershipPropertyGroups
", + "operationId": "getMembershipPropertyGroups", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Rate Groups.", - "schema": { - "$ref": "#/definitions/membershipRateGroupsInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Property Groups configurations.", + "schema": { + "$ref": "#/definitions/membershipPropertyGroupsInfo" } }, "204": { - "description": "MembershipRateGroups not found." + "description": "MembershipPropertyGroups not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create Membership rate groups.OperationId:postMembershipRateGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -21603,129 +17225,98 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Create Membership rate groups", - "operationId": "postMembershipRateGroups", + ] + }, + "post": { + "summary": "Create Membership property groups", + "description": "You can use this API to create Membership property groups.OperationId:postMembershipPropertyGroups
", + "operationId": "postMembershipPropertyGroups", "parameters": [ { - "description": "Request object for creating new Membership Rate Groups.", - "name": "membershipRateGroups", + "name": "membershipPropertyGroups", "in": "body", "required": true, + "description": "Request object for creating new Membership Property Groups Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipRateGroups" + "$ref": "#/definitions/membershipPropertyGroups" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipRateGroups/{membershipRateGroupId}": { - "put": { - "description": "You can use this API to change Membership rate groups.OperationId:putMembershipRateGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -21734,136 +17325,109 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Change Membership rate groups", - "operationId": "putMembershipRateGroups", + ] + } + }, + "/membershipPropertyGroups/{membershipPropertyGroupsId}": { + "put": { + "summary": "Change Membership property groups", + "description": "You can use this API to change Membership property groups.OperationId:putMembershipPropertyGroups
", + "operationId": "putMembershipPropertyGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipRateGroupId", + "name": "membershipPropertyGroupsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "description": "Request object for modifying Membership Rate Groups.", - "name": "membershipRateGroups", + "name": "membershipPropertyGroups", "in": "body", "required": true, + "description": "Request object for changing existing Membership Property Groups Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipRateGroups" + "$ref": "#/definitions/membershipPropertyGroups" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete Membership rate groups.OperationId:deleteMembershipRateGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -21872,125 +17436,94 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Delete Membership rate groups", - "operationId": "deleteMembershipRateGroups", + ] + }, + "delete": { + "summary": "Delete Membership property groups", + "description": "You can use this API to delete Membership property groups.OperationId:deleteMembershipPropertyGroups
", + "operationId": "deleteMembershipPropertyGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipRateGroupId", + "name": "membershipPropertyGroupsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipStatusCodes": { - "get": { - "description": "Use this API to get Membership Status Codes.OperationId:getMembershipStatusCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -21998,143 +17531,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Membership Status Codes", - "operationId": "getMembershipStatusCodes", + "MembershipConfig" + ] + } + }, + "/membershipRateGroups": { + "get": { + "summary": "Get Membership rate groups", + "description": "You can use this API to get Membership rate groups.OperationId:getMembershipRateGroups
", + "operationId": "getMembershipRateGroups", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Status Codes.", - "schema": { - "$ref": "#/definitions/membershipStatusCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Rate Groups.", + "schema": { + "$ref": "#/definitions/membershipRateGroupsInfo" } }, "204": { - "description": "MembershipStatusCodes not found." + "description": "MembershipRateGroups not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Membership Status Codes.OperationId:postMembershipStatusCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -22142,130 +17652,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Membership Status Codes", - "operationId": "postMembershipStatusCodes", + "MembershipConfig" + ] + }, + "post": { + "summary": "Create Membership rate groups", + "description": "You can use this API to create Membership rate groups.OperationId:postMembershipRateGroups
", + "operationId": "postMembershipRateGroups", "parameters": [ { - "description": "Request object for creating Membership Status Codes.", - "name": "membershipStatusCodesCriteria", + "name": "membershipRateGroups", "in": "body", "required": true, + "description": "Request object for creating new Membership Rate Groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipStatusCodesCriteria" + "$ref": "#/definitions/membershipRateGroups" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipStatusCodes/{membershipStatusCode}": { - "put": { - "description": "Use this API to update Membership Status Codes.OperationId:changeMembershipStatusCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -22273,137 +17752,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Membership Status Codes", - "operationId": "changeMembershipStatusCodes", + "MembershipConfig" + ] + } + }, + "/membershipRateGroups/{membershipRateGroupId}": { + "put": { + "summary": "Change Membership rate groups", + "description": "You can use this API to change Membership rate groups.OperationId:putMembershipRateGroups
", + "operationId": "putMembershipRateGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Membership Status.", - "name": "membershipStatusCode", + "name": "membershipRateGroupId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "description": "Request object for changing Membership Status Codes.", - "name": "membershipStatusCodesToBeChanged", + "name": "membershipRateGroups", "in": "body", "required": true, + "description": "Request object for modifying Membership Rate Groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipStatusCodesToBeChanged" + "$ref": "#/definitions/membershipRateGroups" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Membership Status Codes.OperationId:removeMembershipStatusCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -22411,126 +17863,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Membership Status Codes", - "operationId": "removeMembershipStatusCodes", + "MembershipConfig" + ] + }, + "delete": { + "summary": "Delete Membership rate groups", + "description": "You can use this API to delete Membership rate groups.OperationId:deleteMembershipRateGroups
", + "operationId": "deleteMembershipRateGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Membership Status.", - "name": "membershipStatusCode", + "name": "membershipRateGroupId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipTypeRules": { - "get": { - "description": "get Membership type rules based on criteriaOperationId:getMembershipTypeRules
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -22539,163 +17960,136 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Get Membership type rules", - "operationId": "getMembershipTypeRules", + ] + } + }, + "/membershipRates": { + "get": { + "summary": "Get Membership rates ", + "description": "You can use this API to get Membership rates.OperationId:getMembershipRates
", + "operationId": "getMembershipRates", "parameters": [ { + "name": "hotelIds", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Hotel code of membership rates to be searched.", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "membershipTypesCodes", - "in": "query" + "required": false }, { - "uniqueItems": true, - "enum": [ - "All", - "Points", - "Tier" - ], - "type": "string", - "description": "Membership Type/Program rule types.", - "name": "programType", - "in": "query" + "name": "membershipTypes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Membership type to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Rule code of the membership type rule.", - "name": "ruleCode", - "in": "query" + "name": "ratePlanCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Rate code of the membership rule rate.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "uniqueItems": true, - "enum": [ - "Revenue", - "Stay", - "Nights", - "Enrollment", - "TierUpgrade", - "Renewal", - "Rfm" - ], - "type": "string", - "description": "Indicates Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score.", - "name": "ruleBasedOn", - "in": "query" + "name": "description", + "in": "query", + "required": false, + "description": "Description of the Membership Rate.", + "type": "string" }, { - "type": "boolean", - "description": "Indicates whether search includes inactive membership type rules.", "name": "includeInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates whether search includes inactive membership rates.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching membership type rules.", - "schema": { - "$ref": "#/definitions/membershipTypeRulesInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching membership rates.", + "schema": { + "$ref": "#/definitions/membershipRatesInfo" } }, "204": { - "description": "MembershipTypeRules not found." + "description": "MembershipRates not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create Membership type rules.OperationId:postMembershipTypeRules
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -22704,129 +18098,98 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Create Membership type rules", - "operationId": "postMembershipTypeRules", + ] + }, + "post": { + "summary": "Create Membership rates", + "description": "You can use this API to create Membership rates.OperationId:postMembershipRates
", + "operationId": "postMembershipRates", "parameters": [ { - "description": "Request object for creating new membership type rules.", - "name": "membershipTypeRules", + "name": "membershipRates", "in": "body", "required": true, + "description": "Request object for creating new membership rate code rules.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipTypeRules" + "$ref": "#/definitions/membershipRates" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "Response object for creating membership type rules.", - "schema": { - "$ref": "#/definitions/membershipTypeRulesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipTypeRules/{membershipTypeRulesId}": { - "get": { - "description": "You can use this API to get Membership type rule details.OperationId:getMembershipTypeRule
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -22835,150 +18198,109 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Get Membership type rule details", - "operationId": "getMembershipTypeRule", + ] + } + }, + "/membershipRates/{membershipRatesId}": { + "put": { + "summary": "Change Membership rates", + "description": "You can use this API to change Membership rates.OperationId:putMembershipRates
", + "operationId": "putMembershipRates", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipTypeRulesId", + "name": "membershipRatesId", "in": "path", - "required": true - }, - { + "required": true, "type": "string", - "description": "Membership type of the Rule.", - "name": "membershipType", - "in": "query" - }, - { - "type": "integer", - "description": "Sequence number of the membership type rule.", - "name": "membershipPointsSequence", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "uniqueItems": true, - "type": "array", - "items": { - "enum": [ - "RuleDefinition", - "PointsDefinition", - "RuleConditions" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "To include type rule filters information.", - "name": "fetchInstructions", - "in": "query" + "name": "membershipRates", + "in": "body", + "required": true, + "description": "Request object for changing membership rate rules.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipRates" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching membership type rule.", - "schema": { - "$ref": "#/definitions/membershipTypeRule" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "MembershipTypeRule not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change Membership type rules.OperationId:putMembershipTypeRules
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -22987,136 +18309,105 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Change Membership type rules", - "operationId": "putMembershipTypeRules", + ] + }, + "delete": { + "summary": "Delete Membership rates", + "description": "You can use this API to delete Membership rates.OperationId:deleteMembershipRates
", + "operationId": "deleteMembershipRates", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipTypeRulesId", + "name": "membershipRatesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "description": "Request object for changing membership type rules.", - "name": "membershipTypeRules", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/membershipTypeRules" - } - ] - } + "name": "hotelId", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel code of membership rate.", + "items": { + "type": "string" + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete Membership type rules.OperationId:deleteMembershipTypeRules
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23125,135 +18416,119 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Delete Membership type rules", - "operationId": "deleteMembershipTypeRules", + ] + } + }, + "/membershipStatusCodes": { + "get": { + "summary": "Get Membership Status Codes", + "description": "Use this API to get Membership Status Codes.OperationId:getMembershipStatusCodes
", + "operationId": "getMembershipStatusCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipClasses values based on given membershipClassId", - "name": "membershipTypeRulesId", - "in": "path", - "required": true + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", "items": { - "type": "integer" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "description": "Sequence number of the membership type rule.", - "name": "membershipPointsSequence", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Status Codes.", + "schema": { + "$ref": "#/definitions/membershipStatusCodesDetails" } }, + "204": { + "description": "MembershipStatusCodes not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipTypes": { - "get": { - "description": "Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program. This API will retrieve all configured Membership Types configured.OperationId:getMembershipTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23261,154 +18536,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Get membership types", - "operationId": "getMembershipTypes", + "ChainConfig" + ] + }, + "post": { + "summary": "Create Membership Status Codes", + "description": "Use this API to create Membership Status Codes.OperationId:postMembershipStatusCodes
", + "operationId": "postMembershipStatusCodes", "parameters": [ { - "type": "boolean", - "description": "Search criteria for fetching inactive memberships. When set to true, inactive records will be included.", - "name": "includeInactive", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "membershipTypesCodes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "membershipTypesWildCard", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "membershipClassesCodes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "membershipClassesWildCard", - "in": "query" + "name": "membershipStatusCodesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Membership Status Codes.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipStatusCodesCriteria" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Response object for fetching Membership Types.", - "schema": { - "$ref": "#/definitions/membershipTypes" - }, + "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "MembershipTypes not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program.OperationId:postMembershipTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23416,130 +18636,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Create Membership types", - "operationId": "postMembershipTypes", + "ChainConfig" + ] + } + }, + "/membershipStatusCodes/{membershipStatusCode}": { + "put": { + "summary": "Change Membership Status Codes", + "description": "Use this API to update Membership Status Codes.OperationId:changeMembershipStatusCodes
", + "operationId": "changeMembershipStatusCodes", "parameters": [ { - "description": "Request object to create Membership types. Includes instructions for information which needs to be returned.", - "name": "membershipTypes", + "name": "membershipStatusCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Membership Status." + }, + { + "name": "membershipStatusCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Membership Status Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipTypes" + "$ref": "#/definitions/membershipStatusCodesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/membershipTypes/{membershipTypeId}": { - "get": { - "description": "Use this API to get a specific Membership Type and its details.OperationId:getMembershipType
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23547,149 +18747,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Get a Membership type", - "operationId": "getMembershipType", + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Membership Status Codes", + "description": "Use this API to delete Membership Status Codes.OperationId:removeMembershipStatusCodes
", + "operationId": "removeMembershipStatusCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipTypes values based on given membershipTypeId", - "name": "membershipTypeId", + "name": "membershipStatusCode", "in": "path", - "required": true - }, - { + "required": true, "type": "string", - "description": "Membership type code.", - "name": "membershipTypeCode", - "in": "query" - }, - { - "uniqueItems": true, - "type": "array", - "items": { - "enum": [ - "PrimaryDetails", - "CardNumberDetails", - "PointsDetails", - "ExceptionCriteriaDetails", - "AdditionalDetails", - "EnrollmentDetails", - "Levels" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "Membership levels.", - "name": "fetchInstructions", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Membership Status." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Membership Type.", - "schema": { - "$ref": "#/definitions/membershipTypesDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } - } - }, - "204": { - "description": "MembershipType not found." - }, - "400": { - "description": "Bad Request", + }, + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$ref": "#/definitions/status" } }, + "400": { + "$ref": "#/responses/400" + }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to update an existing Membership TypeOperationId:putMembershipType
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23697,137 +18843,142 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" - ], - "summary": "Change Membership type", - "operationId": "putMembershipType", + "ChainConfig" + ] + } + }, + "/membershipTypeRules": { + "get": { + "summary": "Get Membership type rules", + "description": "get Membership type rules based on criteriaOperationId:getMembershipTypeRules
", + "operationId": "getMembershipTypeRules", "parameters": [ { - "maxLength": 2000, - "minLength": 1, + "name": "membershipTypesCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "programType", + "in": "query", + "required": false, "type": "string", - "description": "Fetch membershipTypes values based on given membershipTypeId", - "name": "membershipTypeId", - "in": "path", - "required": true + "description": "Membership Type/Program rule types.", + "uniqueItems": true, + "enum": [ + "All", + "Points", + "Tier" + ] }, { - "description": "Request object for changing membership type.", - "name": "membershipTypeChangeInstructions", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/membershipTypeChangeInstructions" - } - ] - } + "name": "ruleCode", + "in": "query", + "required": false, + "description": "Rule code of the membership type rule.", + "type": "string" }, { + "name": "ruleBasedOn", + "in": "query", + "required": false, "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "description": "Indicates Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score.", + "uniqueItems": true, + "enum": [ + "Revenue", + "Stay", + "Nights", + "Enrollment", + "TierUpgrade", + "Renewal", + "Rfm" + ] }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Indicates whether search includes inactive membership type rules.", + "type": "boolean" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/membershipTypes" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching membership type rules.", + "schema": { + "$ref": "#/definitions/membershipTypeRulesInfo" } }, + "204": { + "description": "MembershipTypeRules not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete an existing Membership TypeOperationId:deleteMembershipTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23836,125 +18987,98 @@ ], "tags": [ "MembershipConfig" - ], - "summary": "Delete Membership type", - "operationId": "deleteMembershipTypes", + ] + }, + "post": { + "summary": "Create Membership type rules", + "description": "You can use this API to create Membership type rules.OperationId:postMembershipTypeRules
", + "operationId": "postMembershipTypeRules", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Fetch membershipTypes values based on given membershipTypeId", - "name": "membershipTypeId", - "in": "path", - "required": true + "name": "membershipTypeRules", + "in": "body", + "required": true, + "description": "Request object for creating new membership type rules.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipTypeRules" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 creating membership type rules.", + "schema": { + "$ref": "#/definitions/membershipTypeRulesDetails" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/nationalities": { - "get": { - "description": "Use this API to get Nationalities codes and description configured in OPERA.OperationId:getNationalities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23962,143 +19086,127 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get nationalities", - "operationId": "getNationalities", + "MembershipConfig" + ] + } + }, + "/membershipTypeRules/{membershipTypeRulesId}": { + "get": { + "summary": "Get Membership type rule details", + "description": "You can use this API to get Membership type rule details.OperationId:getMembershipTypeRule
", + "operationId": "getMembershipTypeRule", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" + "name": "membershipTypeRulesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "name": "membershipType", + "in": "query", + "required": false, + "description": "Membership type of the Rule.", + "type": "string" }, { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "name": "membershipPointsSequence", + "in": "query", + "required": false, + "description": "Sequence number of the membership type rule.", + "type": "integer" }, { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "To include type rule filters information.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "RuleDefinition", + "PointsDefinition", + "RuleConditions" + ] + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Nationalities.", - "schema": { - "$ref": "#/definitions/nationalitiesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching membership type rule.", + "schema": { + "$ref": "#/definitions/membershipTypeRule" } }, "204": { - "description": "Nationalities not found." + "description": "MembershipTypeRule not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Nationalities.OperationId:postNationalities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24106,130 +19214,108 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Nationalities", - "operationId": "postNationalities", + "MembershipConfig" + ] + }, + "put": { + "summary": "Change Membership type rules", + "description": "You can use this API to change Membership type rules.OperationId:putMembershipTypeRules
", + "operationId": "putMembershipTypeRules", "parameters": [ { - "description": "Request object for creating Nationalities.", - "name": "nationalitiesCriteria", + "name": "membershipTypeRulesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" + }, + { + "name": "membershipTypeRules", "in": "body", "required": true, + "description": "Request object for changing membership type rules.", "schema": { "allOf": [ { - "$ref": "#/definitions/nationalitiesCriteria" + "$ref": "#/definitions/membershipTypeRules" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/nationalities/{nationalitiesId}": { - "put": { - "description": "Use this API to update Nationalities.OperationId:putNationalities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24237,137 +19323,106 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Nationalities", - "operationId": "putNationalities", + "MembershipConfig" + ] + }, + "delete": { + "summary": "Delete Membership type rules", + "description": "You can use this API to delete Membership type rules.OperationId:deleteMembershipTypeRules
", + "operationId": "deleteMembershipTypeRules", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Nationalities.", - "name": "nationalitiesId", + "name": "membershipTypeRulesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "description": "Request object for changing Nationalities.", - "name": "nationalitiesToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/nationalitiesToBeChanged" - } - ] - } + "name": "membershipPointsSequence", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Sequence number of the membership type rule.", + "items": { + "type": "integer" + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Nationalities.OperationId:deleteNationalities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24375,126 +19430,132 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Nationalities", - "operationId": "deleteNationalities", + "MembershipConfig" + ] + } + }, + "/membershipTypes": { + "get": { + "summary": "Get membership types", + "description": "Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program. This API will retrieve all configured Membership Types configured.OperationId:getMembershipTypes
", + "operationId": "getMembershipTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Nationalities.", - "name": "nationalitiesId", - "in": "path", - "required": true + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Search criteria for fetching inactive memberships. When set to true, inactive records will be included.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "membershipTypesCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "membershipTypesWildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "name": "membershipClassesCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "name": "membershipClassesWildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" - }, - "Location": { - "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Types.", + "schema": { + "$ref": "#/definitions/membershipTypes" } }, + "204": { + "description": "MembershipTypes not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/ownerTeams": { - "get": { - "description": "Use this API to get Owner Teams.OperationId:getOwnerTeams
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24502,143 +19563,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Owner Teams", - "operationId": "getOwnerTeams", + "MembershipConfig" + ] + }, + "post": { + "summary": "Create Membership types", + "description": "Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program.OperationId:postMembershipTypes
", + "operationId": "postMembershipTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" + "name": "membershipTypes", + "in": "body", + "required": true, + "description": "Request object to create Membership types. Includes instructions for information which needs to be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipTypes" + } + ] + } }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true - }, - { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true - }, - { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true - }, - { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Response object for fetching Owner Teams.", - "schema": { - "$ref": "#/definitions/ownerTeamsDetails" - }, + "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "OwnerTeams not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Owner Teams.OperationId:postOwnerTeams
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24646,130 +19663,124 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Owner Teams", - "operationId": "postOwnerTeams", + "MembershipConfig" + ] + } + }, + "/membershipTypes/{membershipTypeId}": { + "get": { + "summary": "Get a Membership type", + "description": "Use this API to get a specific Membership Type and its details.OperationId:getMembershipType
", + "operationId": "getMembershipType", "parameters": [ { - "description": "Request object for creating Owner Teams.", - "name": "ownerTeamsCriteria", - "in": "body", + "name": "membershipTypeId", + "in": "path", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/ownerTeamsCriteria" - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipTypes values based on given membershipTypeId" + }, + { + "name": "membershipTypeCode", + "in": "query", + "required": false, + "description": "Membership type code.", + "type": "string" + }, + { + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Membership levels.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "PrimaryDetails", + "CardNumberDetails", + "PointsDetails", + "ExceptionCriteriaDetails", + "AdditionalDetails", + "EnrollmentDetails", + "Levels" ] - } + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Membership Type.", + "schema": { + "$ref": "#/definitions/membershipTypesDetails" } }, + "204": { + "description": "MembershipType not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/ownerTeams/{ownerTeamCode}": { - "put": { - "description": "Use this API to update Owner Teams.OperationId:changeOwnerTeams
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24777,137 +19788,108 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Owner Teams", - "operationId": "changeOwnerTeams", + "MembershipConfig" + ] + }, + "put": { + "summary": "Change Membership type", + "description": "Use this API to update an existing Membership TypeOperationId:putMembershipType
", + "operationId": "putMembershipType", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Owner Teams.", - "name": "ownerTeamCode", + "name": "membershipTypeId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipTypes values based on given membershipTypeId" }, { - "description": "Request object for changing Owner Teams.", - "name": "ownerTeamsToBeChanged", + "name": "membershipTypeChangeInstructions", "in": "body", "required": true, + "description": "Request object for changing membership type.", "schema": { "allOf": [ { - "$ref": "#/definitions/ownerTeamsToBeChanged" + "$ref": "#/definitions/membershipTypeChangeInstructions" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/membershipTypes" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Owner Teams.OperationId:removeOwnerTeams
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24915,126 +19897,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Owner Teams", - "operationId": "removeOwnerTeams", + "MembershipConfig" + ] + }, + "delete": { + "summary": "Delete Membership type", + "description": "Use this API to delete an existing Membership TypeOperationId:deleteMembershipTypes
", + "operationId": "deleteMembershipTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Owner Teams.", - "name": "ownerTeamCode", + "name": "membershipTypeId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipTypes values based on given membershipTypeId" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/payDays": { - "get": { - "description": "Use this API to get Pay Days.OperationId:getPayDays
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25042,143 +19993,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Pay Days", - "operationId": "getPayDays", + "MembershipConfig" + ] + } + }, + "/nationalities": { + "get": { + "summary": "Get nationalities", + "description": "Use this API to get Nationalities codes and description configured in OPERA.OperationId:getNationalities
", + "operationId": "getNationalities", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Pay Days.", - "schema": { - "$ref": "#/definitions/payDaysDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Nationalities.", + "schema": { + "$ref": "#/definitions/nationalitiesDetails" } }, "204": { - "description": "PayDays not found." + "description": "Nationalities not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Pay Days.OperationId:postPayDays
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25187,129 +20115,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Pay Days", - "operationId": "postPayDays", + ] + }, + "post": { + "summary": "Create Nationalities", + "description": "Use this API to create Nationalities.OperationId:postNationalities
", + "operationId": "postNationalities", "parameters": [ { - "description": "Request object for creating Pay Days.", - "name": "payDaysCriteria", + "name": "nationalitiesCriteria", "in": "body", "required": true, + "description": "Request object for creating Nationalities.", "schema": { "allOf": [ { - "$ref": "#/definitions/payDaysCriteria" + "$ref": "#/definitions/nationalitiesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/payDays/{payDaysId}": { - "put": { - "description": "Use this API to update Pay Days.OperationId:putPayDays
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25318,136 +20215,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Pay Days", - "operationId": "putPayDays", + ] + } + }, + "/nationalities/{nationalitiesId}": { + "put": { + "summary": "Change Nationalities", + "description": "Use this API to update Nationalities.OperationId:putNationalities
", + "operationId": "putNationalities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Pay Days.", - "name": "payDaysId", + "name": "nationalitiesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Nationalities." }, { - "description": "Request object for changing Pay Days.", - "name": "payDaysToBeChanged", + "name": "nationalitiesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Nationalities.", "schema": { "allOf": [ { - "$ref": "#/definitions/payDaysToBeChanged" + "$ref": "#/definitions/nationalitiesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Pay Days.OperationId:deletePayDays
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25456,125 +20326,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Pay Days", - "operationId": "deletePayDays", + ] + }, + "delete": { + "summary": "Delete Nationalities", + "description": "Use this API to delete Nationalities.OperationId:deleteNationalities
", + "operationId": "deleteNationalities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Pay Days.", - "name": "payDaysId", + "name": "nationalitiesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Nationalities." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/preference": { - "delete": { - "description": "Use this API to delete preferences, this API allows us to delete both the Global and Hotel level preferences.OperationId:deleteHotelAndGlobalPreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25582,137 +20421,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Delete preferences", - "operationId": "deleteHotelAndGlobalPreferences", + "ChainConfig" + ] + } + }, + "/ownerTeams": { + "get": { + "summary": "Get Owner Teams", + "description": "Use this API to get Owner Teams.OperationId:getOwnerTeams
", + "operationId": "getOwnerTeams", "parameters": [ { - "type": "string", - "description": "Specifies the preference code.", - "name": "preferenceCode", + "name": "fetchInactive", "in": "query", - "required": true + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { - "type": "string", - "description": "Specifies the preference group the preference belongs to.", - "name": "preferenceGroup", + "name": "codes", "in": "query", - "required": true + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Specifies the hotel code for which the preference is specified.", - "name": "hotelId", - "in": "query" + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } - } - }, - "400": { - "description": "Bad Request", + }, + "description": "Response object for fetching Owner Teams.", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$ref": "#/definitions/ownerTeamsDetails" } }, + "204": { + "description": "OwnerTeams not found." + }, + "400": { + "$ref": "#/responses/400" + }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/preferenceGroups": { - "get": { - "description": "The API can be used to retrieve preference groups that match the given criteria in the request.OperationId:getPreferenceGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25720,130 +20542,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Get Preference Groups", - "operationId": "getPreferenceGroups", + "ChainConfig" + ] + }, + "post": { + "summary": "Create Owner Teams", + "description": "Use this API to create Owner Teams.OperationId:postOwnerTeams
", + "operationId": "postOwnerTeams", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "preferenceGroupsCodes", - "in": "query" - }, - { - "type": "string", - "description": "Preference group description to be searched.", - "name": "wildCard", - "in": "query" + "name": "ownerTeamsCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Owner Teams.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/ownerTeamsCriteria" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Response object for fetching preference groups.", - "schema": { - "$ref": "#/definitions/preferenceGroups" - }, + "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "PreferenceGroups not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "This API can be used to modify the preference groups. Changes can be made concurrently to multiple groups.OperationId:putPreferenceGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25851,128 +20642,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Change Preference Groups", - "operationId": "putPreferenceGroups", + "ChainConfig" + ] + } + }, + "/ownerTeams/{ownerTeamCode}": { + "put": { + "summary": "Change Owner Teams", + "description": "Use this API to update Owner Teams.OperationId:changeOwnerTeams
", + "operationId": "changeOwnerTeams", "parameters": [ { - "description": "Request object for changing existing preference groups.", - "name": "preferenceGroups", + "name": "ownerTeamCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Owner Teams." + }, + { + "name": "ownerTeamsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Owner Teams.", "schema": { "allOf": [ { - "$ref": "#/definitions/preferenceGroups" + "$ref": "#/definitions/ownerTeamsToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create a new Preference group.OperationId:postPreferenceGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25980,128 +20753,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Create new preference groups ", - "operationId": "postPreferenceGroups", + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Owner Teams", + "description": "Use this API to delete Owner Teams.OperationId:removeOwnerTeams
", + "operationId": "removeOwnerTeams", "parameters": [ { - "description": "Request object for creating new preference groups.", - "name": "preferenceGroups", - "in": "body", + "name": "ownerTeamCode", + "in": "path", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/preferenceGroups" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Owner Teams." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "This will allow you to delete an existing Preference Group.OperationId:deletePreferenceGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26109,124 +20849,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Delete preference groups", - "operationId": "deletePreferenceGroups", + "ChainConfig" + ] + } + }, + "/payDays": { + "get": { + "summary": "Get Pay Days", + "description": "Use this API to get Pay Days.OperationId:getPayDays
", + "operationId": "getPayDays", "parameters": [ { - "type": "string", - "description": "Code identifying the preference group.", - "name": "preferenceGroup", + "name": "fetchInactive", "in": "query", - "required": true + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Pay Days.", + "schema": { + "$ref": "#/definitions/payDaysDetails" } }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "204": { + "description": "PayDays not found." + }, + "400": { + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/preferences": { - "get": { - "description": "You can use this API to get template Preferences.OperationId:getTemplatePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26234,134 +20970,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Get template Preferences", - "operationId": "getTemplatePreferences", + "ChainConfig" + ] + }, + "post": { + "summary": "Create Pay Days", + "description": "Use this API to create Pay Days.OperationId:postPayDays
", + "operationId": "postPayDays", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "preferenceCodes", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "preferenceGroupsCodes", - "in": "query" + "name": "payDaysCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Pay Days.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/payDaysCriteria" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Response object for fetching preferences at the template level.", - "schema": { - "$ref": "#/definitions/templatePreferences" - }, + "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "TemplatePreferences not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change template preferences.OperationId:putTemplatePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26369,128 +21070,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Change template preferences", - "operationId": "putTemplatePreferences", + "ChainConfig" + ] + } + }, + "/payDays/{payDaysId}": { + "put": { + "summary": "Change Pay Days", + "description": "Use this API to update Pay Days.OperationId:putPayDays
", + "operationId": "putPayDays", "parameters": [ { - "description": "Request object for changing preferences at the template level.", - "name": "templatePreferences", + "name": "payDaysId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Pay Days." + }, + { + "name": "payDaysToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Pay Days.", "schema": { "allOf": [ { - "$ref": "#/definitions/templatePreferences" + "$ref": "#/definitions/payDaysToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create template preferences.OperationId:postTemplatePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26498,128 +21181,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Create template preferences", - "operationId": "postTemplatePreferences", + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Pay Days", + "description": "Use this API to delete Pay Days.OperationId:deletePayDays
", + "operationId": "deletePayDays", "parameters": [ { - "description": "Request object for creating preferences at the template level.", - "name": "templatePreferences", - "in": "body", + "name": "payDaysId", + "in": "path", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/templatePreferences" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Pay Days." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete template preferences.OperationId:deleteTemplatePreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26627,131 +21277,109 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Delete template preferences", - "operationId": "deleteTemplatePreferences", + "ChainConfig" + ] + } + }, + "/preference": { + "delete": { + "summary": "Delete preferences", + "description": "Use this API to delete preferences, this API allows us to delete both the Global and Hotel level preferences.OperationId:deleteHotelAndGlobalPreferences
", + "operationId": "deleteHotelAndGlobalPreferences", "parameters": [ { - "type": "string", - "description": "Specifies the preference code.", "name": "preferenceCode", "in": "query", - "required": true + "required": true, + "description": "Specifies the preference code.", + "type": "string" }, { - "type": "string", - "description": "Specifies the preference group the preference belongs to.", "name": "preferenceGroup", "in": "query", - "required": true + "required": true, + "description": "Specifies the preference group the preference belongs to.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "hotelId", + "in": "query", + "required": false, + "description": "Specifies the hotel code for which the preference is specified.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/preferences/copy": { - "put": { - "description": "Use this API to copy preferences.OperationId:copyPreferences
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26760,129 +21388,104 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Copy preferences", - "operationId": "copyPreferences", + ] + } + }, + "/preferenceGroups": { + "get": { + "summary": "Get Preference Groups", + "description": "The API can be used to retrieve preference groups that match the given criteria in the request.OperationId:getPreferenceGroups
", + "operationId": "getPreferenceGroups", "parameters": [ { - "description": "Request object for copying template preferences to hotel(s).", - "name": "preferencesCopy", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/preferencesCopy" - } - ] - } + "name": "preferenceGroupsCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Preference group description to be searched.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" - }, - "Location": { - "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching preference groups.", + "schema": { + "$ref": "#/definitions/preferenceGroups" } }, + "204": { + "description": "PreferenceGroups not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/profileInactiveReasons": { - "get": { - "description": "Use this API to get Profile Inactive Reasons.OperationId:getProfileInactiveReasons
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26890,143 +21493,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Profile Inactive Reasons", - "operationId": "getProfileInactiveReasons", + "ProfileConfiguration" + ] + }, + "put": { + "summary": "Change Preference Groups", + "description": "This API can be used to modify the preference groups. Changes can be made concurrently to multiple groups.OperationId:putPreferenceGroups
", + "operationId": "putPreferenceGroups", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" - }, - { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "name": "preferenceGroups", + "in": "body", + "required": true, + "description": "Request object for changing existing preference groups.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/preferenceGroups" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Profile Inactive Reasons.", - "schema": { - "$ref": "#/definitions/profileInactiveReasonsDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "ProfileInactiveReasons not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Profile Inactive Reasons.OperationId:postProfileInactiveReasons
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27034,130 +21593,93 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Profile Inactive Reasons", - "operationId": "postProfileInactiveReasons", + "ProfileConfiguration" + ] + }, + "delete": { + "summary": "Delete preference groups", + "description": "This will allow you to delete an existing Preference Group.OperationId:deletePreferenceGroups
", + "operationId": "deletePreferenceGroups", "parameters": [ { - "description": "Request object for creating Profile Inactive Reasons.", - "name": "profileInactiveReasonsCriteria", - "in": "body", + "name": "preferenceGroup", + "in": "query", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileInactiveReasonsCriteria" - } - ] - } + "description": "Code identifying the preference group.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/profileInactiveReasons/{profileInactiveReasonsId}": { - "put": { - "description": "Use this API to update Profile Inactive Reasons.OperationId:putProfileInactiveReasons
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27165,137 +21687,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Profile Inactive Reasons", - "operationId": "putProfileInactiveReasons", + "ProfileConfiguration" + ] + }, + "post": { + "summary": "Create new preference groups ", + "description": "Use this API to create a new Preference group.OperationId:postPreferenceGroups
", + "operationId": "postPreferenceGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Profile Inactive Reasons.", - "name": "profileInactiveReasonsId", - "in": "path", - "required": true - }, - { - "description": "Request object for changing Profile Inactive Reasons.", - "name": "profileInactiveReasonsToBeChanged", + "name": "preferenceGroups", "in": "body", "required": true, + "description": "Request object for creating new preference groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileInactiveReasonsToBeChanged" + "$ref": "#/definitions/preferenceGroups" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Profile Inactive Reasons.OperationId:deleteProfileInactiveReasons
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27303,126 +21787,109 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Profile Inactive Reasons", - "operationId": "deleteProfileInactiveReasons", + "ProfileConfiguration" + ] + } + }, + "/preferences": { + "get": { + "summary": "Get template Preferences", + "description": "You can use this API to get template Preferences.OperationId:getTemplatePreferences
", + "operationId": "getTemplatePreferences", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Profile Inactive Reasons.", - "name": "profileInactiveReasonsId", - "in": "path", - "required": true + "name": "preferenceCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "preferenceGroupsCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching preferences at the template level.", + "schema": { + "$ref": "#/definitions/templatePreferences" } }, + "204": { + "description": "TemplatePreferences not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/profileNameValidations": { - "get": { - "description": "You can use this API to get Profile Name Validations.OperationId:getProfileNameValidations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27431,136 +21898,98 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Get Profile Name Validations", - "operationId": "getProfileNameValidations", + ] + }, + "put": { + "summary": "Change template preferences", + "description": "You can use this API to change template preferences.OperationId:putTemplatePreferences
", + "operationId": "putTemplatePreferences", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "typeCodes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" - }, - { - "type": "string", - "description": "Profile Name to be Searched.", - "name": "name", - "in": "query" + "name": "templatePreferences", + "in": "body", + "required": true, + "description": "Request object for changing preferences at the template level.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/templatePreferences" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response for fetching Profile names.", - "schema": { - "$ref": "#/definitions/profileNameValidations" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "ProfileNameValidations not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change Profile Name Validations.OperationId:putProfileNameValidations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27569,127 +21998,99 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Change Profile Name Validations", - "operationId": "putProfileNameValidations", + ] + }, + "delete": { + "summary": "Delete template preferences", + "description": "You can use this API to delete template preferences.OperationId:deleteTemplatePreferences
", + "operationId": "deleteTemplatePreferences", "parameters": [ { - "description": "Request object to edit Profile names.", - "name": "profileNameValidationsToChange", - "in": "body", + "name": "preferenceCode", + "in": "query", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileNameValidationsToChange" - } - ] - } + "description": "Specifies the preference code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "preferenceGroup", + "in": "query", + "required": true, + "description": "Specifies the preference group the preference belongs to.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create Profile Name Validations.OperationId:postProfileNameValidations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27698,127 +22099,98 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Create Profile Name Validations", - "operationId": "postProfileNameValidations", + ] + }, + "post": { + "summary": "Create template preferences", + "description": "You can use this API to create template preferences.OperationId:postTemplatePreferences
", + "operationId": "postTemplatePreferences", "parameters": [ { - "description": "Request object to create Profile names.", - "name": "profileNameValidations", + "name": "templatePreferences", "in": "body", "required": true, + "description": "Request object for creating preferences at the template level.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileNameValidations" + "$ref": "#/definitions/templatePreferences" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete Profile Name Validations.OperationId:deleteProfileNameValidations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27827,136 +22199,100 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Delete Profile Name Validations", - "operationId": "deleteProfileNameValidations", + ] + } + }, + "/preferences/copy": { + "put": { + "summary": "Copy preferences", + "description": "Use this API to copy preferences.OperationId:copyPreferences
", + "operationId": "copyPreferences", "parameters": [ { - "uniqueItems": true, - "enum": [ - "Company", - "TravelAgent", - "Source" - ], - "type": "string", - "description": "Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source.", - "name": "profileType", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Name of the Profile.", - "name": "profileName", - "in": "query", - "required": true + "name": "preferencesCopy", + "in": "body", + "required": true, + "description": "Request object for copying template preferences to hotel(s).", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/preferencesCopy" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/profileRestrictionReasons": { - "get": { - "description": "Use this API to get Profile Restriction Reasons.OperationId:getProfileRestrictionReasons
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27964,143 +22300,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Profile Restriction Reasons", - "operationId": "getProfileRestrictionReasons", + "ProfileConfiguration" + ] + } + }, + "/profileInactiveReasons": { + "get": { + "summary": "Get Profile Inactive Reasons", + "description": "Use this API to get Profile Inactive Reasons.OperationId:getProfileInactiveReasons
", + "operationId": "getProfileInactiveReasons", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Profile Restriction Reasons.", - "schema": { - "$ref": "#/definitions/profileRestrictionReasonsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Profile Inactive Reasons.", + "schema": { + "$ref": "#/definitions/profileInactiveReasonsDetails" } }, "204": { - "description": "ProfileRestrictionReasons not found." + "description": "ProfileInactiveReasons not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Profile Restriction Reasons.OperationId:postProfileRestrictionReasons
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28109,129 +22422,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Profile Restriction Reasons", - "operationId": "postProfileRestrictionReasons", + ] + }, + "post": { + "summary": "Create Profile Inactive Reasons", + "description": "Use this API to create Profile Inactive Reasons.OperationId:postProfileInactiveReasons
", + "operationId": "postProfileInactiveReasons", "parameters": [ { - "description": "Request object for creating Profile Restriction Reasons.", - "name": "profileRestrictionReasonsCriteria", + "name": "profileInactiveReasonsCriteria", "in": "body", "required": true, + "description": "Request object for creating Profile Inactive Reasons.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileRestrictionReasonsCriteria" + "$ref": "#/definitions/profileInactiveReasonsCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/profileRestrictionReasons/{profileRestrictionReasonsId}": { - "put": { - "description": "Use this API to update Profile Restriction Reasons.OperationId:putProfileRestrictionReasons
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28240,136 +22522,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Profile Restriction Reasons", - "operationId": "putProfileRestrictionReasons", + ] + } + }, + "/profileInactiveReasons/{profileInactiveReasonsId}": { + "put": { + "summary": "Change Profile Inactive Reasons", + "description": "Use this API to update Profile Inactive Reasons.OperationId:putProfileInactiveReasons
", + "operationId": "putProfileInactiveReasons", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Profile Restriction Reasons.", - "name": "profileRestrictionReasonsId", + "name": "profileInactiveReasonsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Profile Inactive Reasons." }, { - "description": "Request object for changing Profile Restriction Reasons.", - "name": "profileRestrictionReasonsToBeChanged", + "name": "profileInactiveReasonsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Profile Inactive Reasons.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileRestrictionReasonsToBeChanged" + "$ref": "#/definitions/profileInactiveReasonsToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Profile Restriction Reasons.OperationId:deleteProfileRestrictionReasons
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28378,125 +22633,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Profile Restriction Reasons", - "operationId": "deleteProfileRestrictionReasons", + ] + }, + "delete": { + "summary": "Delete Profile Inactive Reasons", + "description": "Use this API to delete Profile Inactive Reasons.OperationId:deleteProfileInactiveReasons
", + "operationId": "deleteProfileInactiveReasons", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Profile Restriction Reasons.", - "name": "profileRestrictionReasonsId", + "name": "profileInactiveReasonsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Profile Inactive Reasons." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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" } - } - }, - "400": { - "description": "Bad Request", + }, + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$ref": "#/definitions/status" } }, + "400": { + "$ref": "#/responses/400" + }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/profiles/links": { - "get": { - "description": "You can use this API to get profile links.This API is deprecated. Please use getProfileRelationships instead
OperationId:getProfileLinks
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28504,127 +22728,113 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Get profile links", - "operationId": "getProfileLinks", - "deprecated": true, + "ChainConfig" + ] + } + }, + "/profileNameValidations": { + "get": { + "summary": "Get Profile Name Validations", + "description": "You can use this API to get Profile Name Validations.OperationId:getProfileNameValidations
", + "operationId": "getProfileNameValidations", "parameters": [ { - "type": "string", - "description": "From type to process", - "name": "fromType", - "in": "query" + "name": "typeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "To type to process", - "name": "toType", - "in": "query" + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "name", + "in": "query", + "required": false, + "description": "Profile Name to be Searched.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Respose object for fetch profile links", - "schema": { - "$ref": "#/definitions/profileLinks" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response for fetching Profile names.", + "schema": { + "$ref": "#/definitions/profileNameValidations" } }, "204": { - "description": "ProfileLinks not found." + "description": "ProfileNameValidations not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change profile links.This API is deprecated. Please use putProfileRelationships instead
OperationId:putProfileLinks
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28633,128 +22843,98 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Change profile links", - "operationId": "putProfileLinks", - "deprecated": true, + ] + }, + "put": { + "summary": "Change Profile Name Validations", + "description": "You can use this API to change Profile Name Validations.OperationId:putProfileNameValidations
", + "operationId": "putProfileNameValidations", "parameters": [ { - "description": "Request Object for change profile links", - "name": "profileLinks", + "name": "profileNameValidationsToChange", "in": "body", "required": true, + "description": "Request object to edit Profile names.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileLinks" + "$ref": "#/definitions/profileNameValidationsToChange" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create profile links.This API is deprecated. Please use postProfileRelationships instead
OperationId:postProfileLinks
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28763,128 +22943,105 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Create profile links", - "operationId": "postProfileLinks", - "deprecated": true, + ] + }, + "delete": { + "summary": "Delete Profile Name Validations", + "description": "You can use this API to delete Profile Name Validations.OperationId:deleteProfileNameValidations
", + "operationId": "deleteProfileNameValidations", "parameters": [ { - "description": "Request Object to create Profile Links", - "name": "profileLinks", - "in": "body", + "name": "profileType", + "in": "query", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileLinks" - } - ] - } + "type": "string", + "description": "Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source.", + "uniqueItems": true, + "enum": [ + "Company", + "TravelAgent", + "Source" + ] }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "profileName", + "in": "query", + "required": true, + "description": "Name of the Profile.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete profile links.This API is deprecated. Please use deleteProfileRelationships instead
OperationId:deleteProfileLinks
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28893,145 +23050,98 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Delete profile links", - "operationId": "deleteProfileLinks", - "deprecated": true, + ] + }, + "post": { + "summary": "Create Profile Name Validations", + "description": "You can use this API to create Profile Name Validations.OperationId:postProfileNameValidations
", + "operationId": "postProfileNameValidations", "parameters": [ { - "type": "string", - "description": "From type to process", - "name": "fromType", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "To type to process", - "name": "toType", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "From code to process", - "name": "fromCode", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "To code to process", - "name": "toCode", - "in": "query", - "required": true + "name": "profileNameValidations", + "in": "body", + "required": true, + "description": "Request object to create Profile names.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/profileNameValidations" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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" } - } - }, - "400": { - "description": "Bad Request", + }, + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$ref": "#/definitions/status" } }, + "400": { + "$ref": "#/responses/400" + }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/relationships": { - "get": { - "description": "You can use this API to get profile relationships.OperationId:getProfileRelationships
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29040,125 +23150,119 @@ ], "tags": [ "ProfileConfiguration" - ], - "summary": "Get profile relationships", - "operationId": "getProfileRelationships", + ] + } + }, + "/profileRestrictionReasons": { + "get": { + "summary": "Get Profile Restriction Reasons", + "description": "Use this API to get Profile Restriction Reasons.OperationId:getProfileRestrictionReasons
", + "operationId": "getProfileRestrictionReasons", "parameters": [ { - "type": "string", - "description": "From type to process", - "name": "fromType", - "in": "query" + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { - "type": "string", - "description": "To type to process", - "name": "toType", - "in": "query" + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Respose object for fetch profile links", - "schema": { - "$ref": "#/definitions/profileLinks" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Profile Restriction Reasons.", + "schema": { + "$ref": "#/definitions/profileRestrictionReasonsDetails" } }, "204": { - "description": "ProfileRelationships not found." + "description": "ProfileRestrictionReasons not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change profile relationships.OperationId:putProfileRelationships
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29166,128 +23270,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Change profile relationships", - "operationId": "putProfileRelationships", + "ChainConfig" + ] + }, + "post": { + "summary": "Create Profile Restriction Reasons", + "description": "Use this API to create Profile Restriction Reasons.OperationId:postProfileRestrictionReasons
", + "operationId": "postProfileRestrictionReasons", "parameters": [ { - "description": "Request Object for change profile links", - "name": "profileLinks", + "name": "profileRestrictionReasonsCriteria", "in": "body", "required": true, + "description": "Request object for creating Profile Restriction Reasons.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileLinks" + "$ref": "#/definitions/profileRestrictionReasonsCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can use this API to create profile relationships.OperationId:postProfileRelationships
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29295,128 +23370,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Create profile relationships", - "operationId": "postProfileRelationships", + "ChainConfig" + ] + } + }, + "/profileRestrictionReasons/{profileRestrictionReasonsId}": { + "put": { + "summary": "Change Profile Restriction Reasons", + "description": "Use this API to update Profile Restriction Reasons.OperationId:putProfileRestrictionReasons
", + "operationId": "putProfileRestrictionReasons", "parameters": [ { - "description": "Request Object to create Profile Links", - "name": "profileLinks", + "name": "profileRestrictionReasonsId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Profile Restriction Reasons." + }, + { + "name": "profileRestrictionReasonsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Profile Restriction Reasons.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileLinks" + "$ref": "#/definitions/profileRestrictionReasonsToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "You can use this API to delete profile relationships.OperationId:deleteProfileRelationships
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29424,145 +23481,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" - ], - "summary": "Delete profile relationships", - "operationId": "deleteProfileRelationships", + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Profile Restriction Reasons", + "description": "Use this API to delete Profile Restriction Reasons.OperationId:deleteProfileRestrictionReasons
", + "operationId": "deleteProfileRestrictionReasons", "parameters": [ { + "name": "profileRestrictionReasonsId", + "in": "path", + "required": true, "type": "string", - "description": "From type to process", - "name": "fromType", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "To type to process", - "name": "toType", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "From code to process", - "name": "fromCode", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "To code to process", - "name": "toCode", - "in": "query", - "required": true + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Profile Restriction Reasons." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/sources": { - "get": { - "description": "Use this API to get Sources.OperationId:getSources
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29571,142 +23578,101 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Get Sources", - "operationId": "getSources", + ] + } + }, + "/profiles/links": { + "get": { + "summary": "Get profile links", + "description": "You can use this API to get profile links.This API is deprecated. Please use getProfileRelationships instead
OperationId:getProfileLinks
", + "operationId": "getProfileLinks", + "deprecated": true, "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "name": "fromType", + "in": "query", + "required": false, + "description": "From type to process", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "name": "toType", + "in": "query", + "required": false, + "description": "To type to process", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Sources.", - "schema": { - "$ref": "#/definitions/sourcesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Respose object for fetch profile links", + "schema": { + "$ref": "#/definitions/profileLinks" } }, "204": { - "description": "Sources not found." + "description": "ProfileLinks not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Sources.OperationId:postSources
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29714,130 +23680,100 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Sources", - "operationId": "postSources", + "ProfileConfiguration" + ] + }, + "put": { + "summary": "Change profile links", + "description": "You can use this API to change profile links.This API is deprecated. Please use putProfileRelationships instead
OperationId:putProfileLinks
", + "operationId": "putProfileLinks", + "deprecated": true, "parameters": [ { - "description": "Request object for creating Sources.", - "name": "sourcesCriteria", + "name": "profileLinks", "in": "body", "required": true, + "description": "Request Object for change profile links", "schema": { "allOf": [ { - "$ref": "#/definitions/sourcesCriteria" + "$ref": "#/definitions/profileLinks" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/sources/{sourcesId}": { - "put": { - "description": "Use this API to update Sources.OperationId:putSources
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29845,137 +23781,115 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Sources", - "operationId": "putSources", + "ProfileConfiguration" + ] + }, + "delete": { + "summary": "Delete profile links", + "description": "You can use this API to delete profile links.This API is deprecated. Please use deleteProfileRelationships instead
OperationId:deleteProfileLinks
", + "operationId": "deleteProfileLinks", + "deprecated": true, "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Sources.", - "name": "sourcesId", - "in": "path", - "required": true + "name": "fromType", + "in": "query", + "required": true, + "description": "From type to process", + "type": "string" }, { - "description": "Request object for changing Sources.", - "name": "sourcesToBeChanged", - "in": "body", + "name": "toType", + "in": "query", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/sourcesToBeChanged" - } - ] - } + "description": "To type to process", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "fromCode", + "in": "query", + "required": true, + "description": "From code to process", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "toCode", + "in": "query", + "required": true, + "description": "To code to process", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Sources.OperationId:deleteSources
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29983,126 +23897,100 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Sources", - "operationId": "deleteSources", + "ProfileConfiguration" + ] + }, + "post": { + "summary": "Create profile links", + "description": "You can use this API to create profile links.This API is deprecated. Please use postProfileRelationships instead
OperationId:postProfileLinks
", + "operationId": "postProfileLinks", + "deprecated": true, "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Sources.", - "name": "sourcesId", - "in": "path", - "required": true + "name": "profileLinks", + "in": "body", + "required": true, + "description": "Request Object to create Profile Links", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/profileLinks" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/states": { - "get": { - "description": "Use this API to get States.OperationId:getStates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30110,137 +23998,101 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get States", - "operationId": "getStates", + "ProfileConfiguration" + ] + } + }, + "/relationships": { + "get": { + "summary": "Get profile relationships", + "description": "You can use this API to get profile relationships.OperationId:getProfileRelationships
", + "operationId": "getProfileRelationships", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "name": "fromType", + "in": "query", + "required": false, + "description": "From type to process", + "type": "string" }, { - "type": "string", - "description": "State code and state name to search for.", - "name": "stateWildCard", - "in": "query" + "name": "toType", + "in": "query", + "required": false, + "description": "To type to process", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching states.", - "schema": { - "$ref": "#/definitions/statesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Respose object for fetch profile links", + "schema": { + "$ref": "#/definitions/profileLinks" } }, "204": { - "description": "States not found." + "description": "ProfileRelationships not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create States.OperationId:postStates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30248,130 +24100,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create States", - "operationId": "postStates", + "ProfileConfiguration" + ] + }, + "put": { + "summary": "Change profile relationships", + "description": "You can use this API to change profile relationships.OperationId:putProfileRelationships
", + "operationId": "putProfileRelationships", "parameters": [ { - "description": "Request object for creating new states.", - "name": "statesCriteria", + "name": "profileLinks", "in": "body", "required": true, + "description": "Request Object for change profile links", "schema": { "allOf": [ { - "$ref": "#/definitions/statesCriteria" + "$ref": "#/definitions/profileLinks" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/territories": { - "get": { - "description": "Use this API to get Territories.OperationId:getTerritories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30379,143 +24200,114 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Territories", - "operationId": "getTerritories", + "ProfileConfiguration" + ] + }, + "delete": { + "summary": "Delete profile relationships", + "description": "You can use this API to delete profile relationships.OperationId:deleteProfileRelationships
", + "operationId": "deleteProfileRelationships", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" + "name": "fromType", + "in": "query", + "required": true, + "description": "From type to process", + "type": "string" }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "name": "toType", + "in": "query", + "required": true, + "description": "To type to process", + "type": "string" }, { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "name": "fromCode", + "in": "query", + "required": true, + "description": "From code to process", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "name": "toCode", + "in": "query", + "required": true, + "description": "To code to process", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Territories.", - "schema": { - "$ref": "#/definitions/territoriesDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "Territories not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Territories.OperationId:postTerritories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30523,130 +24315,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Territories", - "operationId": "postTerritories", + "ProfileConfiguration" + ] + }, + "post": { + "summary": "Create profile relationships", + "description": "You can use this API to create profile relationships.OperationId:postProfileRelationships
", + "operationId": "postProfileRelationships", "parameters": [ { - "description": "Request object for creating Territories.", - "name": "territoriesCriteria", + "name": "profileLinks", "in": "body", "required": true, + "description": "Request Object to create Profile Links", "schema": { "allOf": [ { - "$ref": "#/definitions/territoriesCriteria" + "$ref": "#/definitions/profileLinks" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/territories/{territoriesId}": { - "put": { - "description": "Use this API to update Territories.OperationId:putTerritories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30654,137 +24415,88 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Territories", - "operationId": "putTerritories", + "ProfileConfiguration" + ] + } + }, + "/services/chainConfig/cache": { + "delete": { + "summary": " clear cache", + "description": "Clear Chain Configuration CacheOperationId:deleteChainConfigServicesCache
", + "operationId": "deleteChainConfigServicesCache", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Territories.", - "name": "territoriesId", - "in": "path", - "required": true + "$ref": "#/parameters/authKey" }, { - "description": "Request object for changing Territories.", - "name": "territoriesToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/territoriesToBeChanged" - } - ] - } - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true - }, - { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Territories.OperationId:deleteTerritories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30793,125 +24505,86 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Territories", - "operationId": "deleteTerritories", + ] + } + }, + "/services/chainConfig/status": { + "get": { + "summary": " ping", + "description": "Ping Chain Configuration ServiceOperationId:pingChainConfigServices
", + "operationId": "pingChainConfigServices", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Territories.", - "name": "territoriesId", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response for Ping operation.", + "schema": { + "$ref": "#/definitions/operaVersion" } }, + "204": { + "description": "pingChainConfigServices not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/titles": { - "get": { - "description": "Use this API to get Titles.OperationId:getTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30920,142 +24593,87 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Get Titles", - "operationId": "getTitles", + ] + } + }, + "/services/hotelConfig/cache": { + "delete": { + "summary": " clear cache", + "description": "Clear Hotel Configuration CacheOperationId:deleteHotelConfigServicesCache
", + "operationId": "deleteHotelConfigServicesCache", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" - }, - { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true - }, - { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Titles.", - "schema": { - "$ref": "#/definitions/titlesDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "Titles not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Titles.OperationId:postTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31063,130 +24681,87 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Titles", - "operationId": "postTitles", + "HotelConfig" + ] + } + }, + "/services/hotelConfig/status": { + "get": { + "summary": " ping", + "description": "Ping Hotel Configuration ServiceOperationId:pingHotelConfigServices
", + "operationId": "pingHotelConfigServices", "parameters": [ { - "description": "Request object for creating Titles.", - "name": "titlesCriteria", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/titlesCriteria" - } - ] - } - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" - }, - "Location": { - "type": "string", - "description": "Location of newly created resource" + "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": "pingHotelConfigServices not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/titles/{titlesId}": { - "put": { - "description": "Use this API to update Titles.OperationId:putTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31194,137 +24769,88 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Titles", - "operationId": "putTitles", + "HotelConfig" + ] + } + }, + "/services/membershipConfig/cache": { + "delete": { + "summary": " clear cache", + "description": "Clear Membership Configuration CacheOperationId:deleteMembershipConfigCache
", + "operationId": "deleteMembershipConfigCache", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Titles.", - "name": "titlesId", - "in": "path", - "required": true - }, - { - "description": "Request object for changing Titles.", - "name": "titlesToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/titlesToBeChanged" - } - ] - } - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Titles.OperationId:deleteTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31332,126 +24858,87 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Titles", - "operationId": "deleteTitles", + "MembershipConfig" + ] + } + }, + "/services/membershipConfig/status": { + "get": { + "summary": " ping", + "description": "Ping Membership Configuration ServiceOperationId:pingMembershipConfigService
", + "operationId": "pingMembershipConfigService", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Titles.", - "name": "titlesId", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "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": "pingMembershipConfigService not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/vipLevels": { - "get": { - "description": "Use this API to get VIP Levels.OperationId:getVIPLevels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31459,143 +24946,88 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get VIP Levels", - "operationId": "getVIPLevels", + "MembershipConfig" + ] + } + }, + "/services/profile/cache": { + "delete": { + "summary": " clear cache", + "description": "Clear Profile Configuratoin CacheOperationId:deleteProfileConfigServiceCache
", + "operationId": "deleteProfileConfigServiceCache", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" - }, - { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching V I P Levels.", - "schema": { - "$ref": "#/definitions/vIPLevelsDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "VIPLevels not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create VIP Levels.OperationId:postVIPLevels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31603,130 +25035,87 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create VIP Levels", - "operationId": "postVIPLevels", + "ProfileConfiguration" + ] + } + }, + "/services/profile/status": { + "get": { + "summary": " ping", + "description": "Ping Profile Configuration ServiceOperationId:pingProfileConfigService
", + "operationId": "pingProfileConfigService", "parameters": [ { - "description": "Request object for creating V I P Levels.", - "name": "vIPLevelsCriteria", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/vIPLevelsCriteria" - } - ] - } - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "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": "pingProfileConfigService not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/vipLevels/{vipLevelsId}": { - "put": { - "description": "Use this API to update VIP Levels.OperationId:putVIPLevels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31734,137 +25123,220 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change VIP Levels", - "operationId": "putVIPLevels", + "ProfileConfiguration" + ] + } + }, + "/sources": { + "get": { + "summary": "Get Sources", + "description": "Use this API to get Sources.OperationId:getSources
", + "operationId": "getSources", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of V I P Levels.", - "name": "vipLevelsId", - "in": "path", - "required": true + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { - "description": "Request object for changing V I P Levels.", - "name": "vIPLevelsToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/vIPLevelsToBeChanged" - } - ] - } + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" - }, - "Location": { - "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Sources.", + "schema": { + "$ref": "#/definitions/sourcesDetails" } }, + "204": { + "description": "Sources not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", + "$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 Sources", + "description": "Use this API to create Sources.OperationId:postSources
", + "operationId": "postSources", + "parameters": [ + { + "name": "sourcesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Sources.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/sourcesCriteria" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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/exceptionDetailType" + "$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": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete VIP Levels.OperationId:deleteVIPLevels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31873,349 +25345,2440 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete VIP Levels", - "operationId": "deleteVIPLevels", + ] + } + }, + "/sources/{sourcesId}": { + "put": { + "summary": "Change Sources", + "description": "Use this API to update Sources.OperationId:putSources
", + "operationId": "putSources", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of V I P Levels.", - "name": "vipLevelsId", + "name": "sourcesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Sources." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "sourcesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing Sources.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/sourcesToBeChanged" + } + ] + } }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", + "$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 Sources", + "description": "Use this API to delete Sources.OperationId:deleteSources
", + "operationId": "deleteSources", + "parameters": [ + { + "name": "sourcesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Sources." + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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/exceptionDetailType" + "$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": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - } - }, - "definitions": { - "accountOwnersDetails": { - "description": "Response object for fetch account owners.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "owners": { - "description": "Collection of the account owners returned.", - "$ref": "#/definitions/ownersType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ChainConfig" + ] } }, - "accountPrioritiesCriteria": { - "description": "Request object for creating Account Priorities.", - "type": "object", - "properties": { - "accountPriorities": { - "description": "Account Prioritiesto be created.", - "$ref": "#/definitions/accountPrioritiesType" + "/states": { + "get": { + "summary": "Get States", + "description": "Use this API to get States.OperationId:getStates
", + "operationId": "getStates", + "parameters": [ + { + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" + }, + { + "name": "stateWildCard", + "in": "query", + "required": false, + "description": "State code and state name to search for.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 states.", + "schema": { + "$ref": "#/definitions/statesDetails" + } + }, + "204": { + "description": "States 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 States", + "description": "Use this API to create States.OperationId:postStates
", + "operationId": "postStates", + "parameters": [ + { + "name": "statesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating new states.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/statesCriteria" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + ] + } + }, + "/territories": { + "get": { + "summary": "Get Territories", + "description": "Use this API to get Territories.OperationId:getTerritories
", + "operationId": "getTerritories", + "parameters": [ + { + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" + }, + { + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "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/x-app-key" + }, + { + "$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 Territories.", + "schema": { + "$ref": "#/definitions/territoriesDetails" + } + }, + "204": { + "description": "Territories 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 Territories", + "description": "Use this API to create Territories.OperationId:postTerritories
", + "operationId": "postTerritories", + "parameters": [ + { + "name": "territoriesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Territories.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/territoriesCriteria" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + ] + } + }, + "/territories/{territoriesId}": { + "put": { + "summary": "Change Territories", + "description": "Use this API to update Territories.OperationId:putTerritories
", + "operationId": "putTerritories", + "parameters": [ + { + "name": "territoriesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Territories." + }, + { + "name": "territoriesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing Territories.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/territoriesToBeChanged" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "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 Territories", + "description": "Use this API to delete Territories.OperationId:deleteTerritories
", + "operationId": "deleteTerritories", + "parameters": [ + { + "name": "territoriesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Territories." + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + ] + } + }, + "/titles": { + "get": { + "summary": "Get Titles", + "description": "Use this API to get Titles.OperationId:getTitles
", + "operationId": "getTitles", + "parameters": [ + { + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" + }, + { + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "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/x-app-key" + }, + { + "$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 Titles.", + "schema": { + "$ref": "#/definitions/titlesDetails" + } + }, + "204": { + "description": "Titles 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 Titles", + "description": "Use this API to create Titles.OperationId:postTitles
", + "operationId": "postTitles", + "parameters": [ + { + "name": "titlesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Titles.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/titlesCriteria" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + ] + } + }, + "/titles/{titlesId}": { + "put": { + "summary": "Change Titles", + "description": "Use this API to update Titles.OperationId:putTitles
", + "operationId": "putTitles", + "parameters": [ + { + "name": "titlesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Titles." + }, + { + "name": "titlesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing Titles.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/titlesToBeChanged" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "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 Titles", + "description": "Use this API to delete Titles.OperationId:deleteTitles
", + "operationId": "deleteTitles", + "parameters": [ + { + "name": "titlesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Titles." + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + ] + } + }, + "/vipLevels": { + "get": { + "summary": "Get VIP Levels", + "description": "Use this API to get VIP Levels.OperationId:getVIPLevels
", + "operationId": "getVIPLevels", + "parameters": [ + { + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" + }, + { + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "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/x-app-key" + }, + { + "$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 V I P Levels.", + "schema": { + "$ref": "#/definitions/vIPLevelsDetails" + } + }, + "204": { + "description": "VIPLevels 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 VIP Levels", + "description": "Use this API to create VIP Levels.OperationId:postVIPLevels
", + "operationId": "postVIPLevels", + "parameters": [ + { + "name": "vIPLevelsCriteria", + "in": "body", + "required": true, + "description": "Request object for creating V I P Levels.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/vIPLevelsCriteria" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + ] + } + }, + "/vipLevels/{vipLevelsId}": { + "put": { + "summary": "Change VIP Levels", + "description": "Use this API to update VIP Levels.OperationId:putVIPLevels
", + "operationId": "putVIPLevels", + "parameters": [ + { + "name": "vipLevelsId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of V I P Levels." + }, + { + "name": "vIPLevelsToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing V I P Levels.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/vIPLevelsToBeChanged" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "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 VIP Levels", + "description": "Use this API to delete VIP Levels.OperationId:deleteVIPLevels
", + "operationId": "deleteVIPLevels", + "parameters": [ + { + "name": "vipLevelsId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of V I P Levels." + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": { + "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-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": 80, + "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": { + "accountOwnersDetails": { + "type": "object", + "description": "Response object for fetch account owners.", + "properties": { + "owners": { + "description": "Collection of the account owners returned.", + "$ref": "#/definitions/ownersType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "ownersType": { + "type": "array", + "description": "Generic type for a list of owners.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/ownerType" + } + }, + "ownerType": { + "type": "object", + "description": "Generic type for information about an owner.", + "properties": { + "hotel": { + "description": "Hotel to which the owner belongs to.", + "$ref": "#/definitions/codeDescriptionType" + }, + "userId": { + "description": "Unique application user ID.", + "$ref": "#/definitions/uniqueID_Type" + }, + "userName": { + "description": "Unique application user name of the owner.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "ownerCode": { + "description": "Unique Code to identify the owner.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "profileId": { + "description": "Unique owner profile information.", + "$ref": "#/definitions/profileId" + }, + "name": { + "description": "Provides name information of the owner.", + "$ref": "#/definitions/personNameType" + }, + "department": { + "description": "Department to which the owner belongs to.", + "$ref": "#/definitions/codeDescriptionType" + }, + "email": { + "description": "Email information of the owner.", + "$ref": "#/definitions/emailInfoType" + }, + "phone": { + "description": "Information on the telephone number of the owner.", + "$ref": "#/definitions/telephoneInfoType" + }, + "relationship": { + "description": "Relationship of the owner within the profile or block.", + "$ref": "#/definitions/codeDescriptionType" + }, + "primary": { + "description": "When true, this is a primary owner.", + "type": "boolean" + } + } + }, + "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 + } + } + }, + "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 + } + } + }, + "profileId": { + "type": "object", + "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).", + "properties": { + "url": { + "description": "URL that identifies the location associated with the record identified by the UniqueID.", + "type": "string" }, - "links": { - "$ref": "#/definitions/links" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "instance": { + "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "id": { + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idExtension": { + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" } } }, - "accountPrioritiesDetails": { - "description": "Response object for fetching Account Priorities.", + "personNameType": { "type": "object", + "description": "This provides name information for a person.", "properties": { - "accountPriorities": { - "description": "Collection of Account Priorities.", - "$ref": "#/definitions/accountPrioritiesType" + "namePrefix": { + "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "links": { - "$ref": "#/definitions/links" + "givenName": { + "description": "Given name, first name or names.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "middleName": { + "description": "The middle name of the person name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "surname": { + "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameSuffix": { + "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameTitle": { + "description": "Degree or honors (e.g., Ph.D., M.D.)", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "nameTitleSuffix": { + "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on.", + "type": "integer" + }, + "envelopeGreeting": { + "description": "Envelope Greeting of the profile", + "type": "string" + }, + "salutation": { + "description": "Salutation of the profile", + "type": "string" + }, + "nameType": { + "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", + "$ref": "#/definitions/personNameTypeType" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "externalSystem": { + "description": "When name type is external, indicates the external system the name belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "accountPrioritiesToBeChanged": { - "description": "Request object for changing Account Priorities.", + "personNameTypeType": { + "type": "string", + "description": "Person's name in an external system.", + "enum": [ + "Primary", + "Alternate", + "Incognito", + "External", + "Phonetic" + ] + }, + "emailInfoType": { "type": "object", + "description": "Information on an email for the customer.", "properties": { - "accountPriorities": { - "description": "Account Prioritiesto be changed.", - "$ref": "#/definitions/accountPrioritiesType" + "email": { + "description": "eMail deatils for the profile.", + "$ref": "#/definitions/emailType" }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "emailType": { + "type": "object", + "description": "Information on an email for the customer.", + "properties": { + "emailAddress": { + "description": "Defines the e-mail address.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "type": { + "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "typeDescription": { + "description": "Describes the Type code", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "emailFormat": { + "description": "Supported Email format.", + "type": "string", + "enum": [ + "Html", + "Text" + ] + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + }, + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" + }, + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "telephoneInfoType": { + "type": "object", + "description": "Information on a telephone number for the customer.", + "properties": { + "telephone": { + "description": "Phone details for the profile.", + "$ref": "#/definitions/telephoneType" + }, + "id": { + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "telephoneType": { + "type": "object", + "description": "Information on a telephone number for the customer.", + "properties": { + "phoneTechType": { + "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "phoneUseType": { + "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "phoneUseTypeDescription": { + "description": "Description of the PhoneUseType code", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "phoneNumber": { + "description": "Telephone number assigned to a single location.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "extension": { + "description": "Extension to reach a specific party at the phone number.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + }, + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" + }, + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "accountPrioritiesType": { - "description": "List of Account Priorities.", + "links": { "type": "array", - "maxItems": 4000, "items": { - "$ref": "#/definitions/accountPriorityType" + "$ref": "#/definitions/instanceLink" } }, - "accountPriorityType": { - "description": "Contains Common Master configuration detail.", + "instanceLink": { "type": "object", + "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", "properties": { - "code": { - "description": "Common Master unique code.", + "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", - "maxLength": 40, - "minLength": 0 + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "PATCH", + "OPTIONS", + "HEAD" + ] }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "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" }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "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" }, - "inactive": { - "description": "Determines whether this code is inactive or not.", - "type": "boolean" + "title": { + "description": "Exact copy of the \"summary\" field on the linked operation.", + "type": "string" } + }, + "required": [ + "href", + "rel", + "method", + "operationId" + ] + }, + "warningsType": { + "type": "array", + "description": "Used in conjunction with the Success element to define a business error.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/warningType" } }, - "accountTypeType": { - "description": "Contains Common Master configuration detail.", + "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": "Common Master unique code.", + "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "docURL": { + "description": "If present, this URL refers to an online description of the error that occurred.", + "type": "string", + "maxLength": 2000 }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "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 }, - "inactive": { - "description": "Indicates the account type is inactive or not.", - "type": "boolean" - } - } - }, - "accountTypesCriteria": { - "description": "Request object for creating Account Types.", - "type": "object", - "properties": { - "accountTypes": { - "description": "Account Typesto be created.", - "$ref": "#/definitions/accountTypesType" + "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 }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "accountTypesDetails": { - "description": "Response object for fetching Account Types.", - "type": "object", - "properties": { - "accountTypes": { - "description": "Collection of Account Types.", - "$ref": "#/definitions/accountTypesType" + "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 }, - "links": { - "$ref": "#/definitions/links" + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "rph": { + "description": "Reference Place Holder used as an index for this warning.", + "type": "string", + "minLength": 1, + "maxLength": 8 } } }, - "accountTypesToBeChanged": { - "description": "Request object for changing Account Types.", + "exceptionDetailType": { + "title": "Error Detail", + "description": "Complex type that contains error details for a REST call.", "type": "object", "properties": { - "accountTypes": { - "description": "Account Typesto be changed.", - "$ref": "#/definitions/accountTypesType" + "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" - }, - "warnings": { - "$ref": "#/definitions/warningsType" } - } - }, - "accountTypesType": { - "description": "List of Account Types.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/accountTypeType" - } + }, + "required": [ + "type", + "title" + ] }, - "addressFormatType": { - "description": "A representation of the information contained by an address format.", + "errorInstance": { + "title": "Error Instance Details", + "description": "Complex type that contains error instance details for a REST call.", "type": "object", "properties": { - "canDelete": { - "description": "Determines whether this address format can be deleted.", - "type": "boolean" + "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)." }, - "description": { - "description": "Description of the address format.", + "title": { "type": "string", - "maxLength": 200, - "minLength": 0 + "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, - "displayOrder": { - "description": "sequence number of the address format.", - "type": "number" + "status": { + "type": "integer", + "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, - "formatCode": { - "description": "Address format code.", + "detail": { "type": "string", - "maxLength": 20, - "minLength": 0 + "description": "Human-readable description specific to this occurrence of the problem." }, - "formatDefinition": { - "description": "Address format definition with the elements of the address.", + "instance": { "type": "string", - "maxLength": 2000, - "minLength": 0 + "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, - "formattedExample": { - "description": "An example address formatted with the current format definition.", + "o:errorCode": { "type": "string", - "maxLength": 2000, - "minLength": 0 + "description": "Application error code, which is different from HTTP error code." }, - "salesFormat": { - "description": "Determines if the format is a sales format or not.", - "type": "boolean" + "o:errorPath": { + "type": "string", + "description": "Path to the problem at the resource or property level." } - } + }, + "required": [ + "type", + "title" + ] }, - "addressFormats": { - "description": "Response object for fetching Address Formats.", + "accountPrioritiesDetails": { "type": "object", + "description": "Response object for fetching Account Priorities.", "properties": { - "formats": { - "description": "Collection of Address formats fetched.", - "$ref": "#/definitions/addressFormatsType" + "accountPriorities": { + "description": "Collection of Account Priorities.", + "$ref": "#/definitions/accountPrioritiesType" }, "links": { "$ref": "#/definitions/links" @@ -32225,23 +27788,23 @@ } } }, - "addressFormatsType": { - "description": "An Address formats.", + "accountPrioritiesType": { "type": "array", + "description": "List of Account Priorities.", "maxItems": 4000, "items": { - "$ref": "#/definitions/addressFormatType" + "$ref": "#/definitions/accountPriorityType" } - }, - "addressTypeType": { - "description": "Contains Common Master configuration detail.", + }, + "accountPriorityType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -32250,92 +27813,58 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" - } - } - }, - "addressTypesCriteria": { - "description": "Request object for creating a new Address Type.", - "type": "object", - "properties": { - "addressTypes": { - "description": "Address Type to be created.", - "$ref": "#/definitions/addressTypesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "addressTypesDetails": { - "description": "Response object for fetching Address Types.", - "type": "object", - "properties": { - "addressTypes": { - "description": "Collection of Address Types.", - "$ref": "#/definitions/addressTypesType" - }, - "links": { - "$ref": "#/definitions/links" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "inactive": { + "description": "Determines whether this code is inactive or not.", + "type": "boolean" } } }, - "addressTypesToBeChanged": { - "description": "Request object for changing an existing Address Type.", + "translationTextType2000": { "type": "object", + "description": "Contains Multiple translated texts and language codes.", "properties": { - "addressTypes": { - "description": "Address Type to be changed.", - "$ref": "#/definitions/addressTypesType" - }, - "links": { - "$ref": "#/definitions/links" + "defaultText": { + "description": "Default text with Character length from 0 to 2000.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "translatedTexts": { + "description": "List of translated text and language codes.", + "$ref": "#/definitions/translationsTextType" } } }, - "addressTypesType": { - "description": "Communication Role Enumeration element.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/addressTypeType" - } - }, - "addtionalCodeInfoType": { - "description": "Holds name of additional code information", + "translationsTextType": { "type": "array", + "description": "Language code for the translation.", "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", - "maxLength": 2000, - "minLength": 0 + "description": "Used for Character Strings, length 0 to 2000.", + "minLength": 0, + "maxLength": 2000 + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" } - } + }, + "description": "Language code for the translation." } }, - "alternateLanguageGuestTitlesCriteria": { - "description": "Request object for creating Alternate Language Guest Titles.", + "accountPrioritiesCriteria": { "type": "object", + "description": "Request object for creating Account Priorities.", "properties": { - "alternateLanguageGuestTitles": { - "description": "Alternate Language Guest Titles to be created.", - "$ref": "#/definitions/guestTitlesType" + "accountPriorities": { + "description": "Account Prioritiesto be created.", + "$ref": "#/definitions/accountPrioritiesType" }, "links": { "$ref": "#/definitions/links" @@ -32345,213 +27874,67 @@ } } }, - "alternateLanguageGuestTitlesDetails": { - "description": "Response object for fetching Alternate Language Guest Titles.", + "status": { "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", "properties": { - "alternateLanguageGuestTitles": { - "description": "Collection of Alternate Language Guest Titles.", - "$ref": "#/definitions/guestTitlesType" - }, - "links": { - "$ref": "#/definitions/links" - }, "warnings": { "$ref": "#/definitions/warningsType" - } - } - }, - "alternateLanguageGuestTitlesToBeChanged": { - "description": "Request object for changing Alternate Language Guest Titles.", - "type": "object", - "properties": { - "alternateLanguageGuestTitles": { - "description": "Alternate Language Guest Titles to be changed.", - "$ref": "#/definitions/guestTitlesType" }, "links": { "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" } } }, - "attachMembershipToReservationRuleType": { - "description": "Indicates when the membership information should get attach to the reservation.", - "type": "string", - "enum": [ - "NewReservation", - "UpdateReservation", - "Checkin", - "Checkout" - ] - }, - "autoGenerateCardNumberType": { - "description": "Holds the configuration to generate membership card number.", + "accountPrioritiesToBeChanged": { "type": "object", + "description": "Request object for changing Account Priorities.", "properties": { - "cardNumberFormat": { - "description": "Indicates what format the random generation card number should follow, Format we support are - 9 for Numbers, X for Alphanumeric mixed, and A for Alpha only. For example, 32093K.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "cardNumberPrefix": { - "description": "Valid card number prefix.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "cardRangeEnd": { - "description": "Card number auto generation range.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "accountPriorities": { + "description": "Account Prioritiesto be changed.", + "$ref": "#/definitions/accountPrioritiesType" }, - "cardRangeStart": { - "description": "Card number auto generation range.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "availablePreferencesDetails": { - "description": "Response object for fetching available preferences for a property.", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "preferenceCollection": { - "description": "A collection of preferences", - "type": "array", - "items": { - "$ref": "#/definitions/preferenceTypeType" - } - }, "warnings": { "$ref": "#/definitions/warningsType" } } - }, - "awardPointsType": { - "description": "Base parent type for membership points comprising common elements between award points and tier points.", - "type": "object", - "properties": { - "activityPeriodMonths": { - "description": "Activity Period in months for Rolling.", - "type": "integer" - }, - "activityPeriodYears": { - "description": "Activity Period in years for Calendar.", - "$ref": "#/definitions/numberOfYearsType" - }, - "awardPointsExpiryDate": { - "description": "Months for which the Points accumulated can be redeemed for Calendar period.", - "$ref": "#/definitions/awardPointsValidityDurationType" - }, - "awardRedeemThreshold": { - "description": "Award redemption threshold", - "type": "integer" - }, - "calendarPeriod": { - "description": "Period of points calculation.", - "$ref": "#/definitions/calendarPeriodType" - }, - "delayInDays": { - "description": "Award points will be recognized in this number of days following the guest's check out date. The minimum number of days is 3 and the maximum number of days is 60. This delay provides a period of time during which adjustments can be made at the PMS level before awards are uploaded to ORS/OCIS.", - "type": "integer" - }, - "exceptionCriteria": { - "description": "Criteria for detecting exceptions in points calculation.", - "$ref": "#/definitions/awardsExceptionCriteriaType" - }, - "expiryMonth": { - "description": "Month of Expiry for Calendar", - "type": "string", - "maxLength": 10, - "minLength": 0 - }, - "expiryPeriod": { - "description": "Membership card expiration period.", - "$ref": "#/definitions/numberOfYearsType" - }, - "gracePeriodMonths": { - "description": "Grace Period in months used for Rolling.", - "type": "integer" - }, - "gracePeriodYear": { - "description": "Grace Period in years used for Calendar.", - "$ref": "#/definitions/calendarGracePeriodType" - }, - "monthsToAwardPointsExpiry": { - "description": "Months for which the Points accumulated can be redeemed for Rolling period.", - "type": "integer" - }, - "nonMemberPoints": { - "description": "Indicates if points will be displayed for guests who are not members.", - "type": "boolean" - }, - "requiredOnStayPeriod": { - "description": "Calculate stay points even if the loyalty membership card is not attached.", - "type": "boolean" - }, - "yearsToExpire": { - "description": "Indicates Membership card will be expired if there is no activity on the card for this number of years.", - "type": "integer" - } - } - }, - "awardPointsValidityDurationType": { - "description": "Five Year period", - "type": "string", - "enum": [ - "DoNotExpire", - "SameYear", - "OneYear", - "TwoYears", - "ThreeYears", - "FourYears", - "FiveYears" - ] - }, - "awardsExceptionCriteriaType": { - "description": "Criteria for detecting exceptions in points calculation", - "type": "object", - "properties": { - "bBCrossMembership": { - "description": "Cross Membership Back to Back Stays", - "type": "boolean" - }, - "bBSingleGroup": { - "description": "Back to back stay at a Single Group", - "type": "boolean" - }, - "bBSingleProperty": { - "description": "Back to Back stay at a Single Property", - "type": "boolean" + }, + "accountTypesDetails": { + "type": "object", + "description": "Response object for fetching Account Types.", + "properties": { + "accountTypes": { + "description": "Collection of Account Types.", + "$ref": "#/definitions/accountTypesType" }, - "externalProcessingException": { - "description": "Number of days while awaiting an external accept/reject response file.", - "type": "integer" + "links": { + "$ref": "#/definitions/links" }, - "multipleRooms": { - "description": "Exception applied to multiple rooms.", - "$ref": "#/definitions/multipleRoomsType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "businessSegmentType": { - "description": "Contains Common Master configuration detail.", + "accountTypesType": { + "type": "array", + "description": "List of Account Types.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/accountTypeType" + } + }, + "accountTypeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -32562,18 +27945,18 @@ "type": "number" }, "inactive": { - "description": "Determines whether this code is inactive or not.", + "description": "Indicates the account type is inactive or not.", "type": "boolean" } } }, - "businessSegmentsCriteria": { - "description": "Request object for creating Business Segments.", + "accountTypesCriteria": { "type": "object", + "description": "Request object for creating Account Types.", "properties": { - "businessSegments": { - "description": "Business Segments to be created.", - "$ref": "#/definitions/businessSegmentsType" + "accountTypes": { + "description": "Account Typesto be created.", + "$ref": "#/definitions/accountTypesType" }, "links": { "$ref": "#/definitions/links" @@ -32583,13 +27966,13 @@ } } }, - "businessSegmentsDetails": { - "description": "Response object for fetching Business Segments.", + "accountTypesToBeChanged": { "type": "object", + "description": "Request object for changing Account Types.", "properties": { - "businessSegments": { - "description": "Collection of Business Segments.", - "$ref": "#/definitions/businessSegmentsType" + "accountTypes": { + "description": "Account Typesto be changed.", + "$ref": "#/definitions/accountTypesType" }, "links": { "$ref": "#/definitions/links" @@ -32599,13 +27982,13 @@ } } }, - "businessSegmentsToBeChanged": { - "description": "Request object for changing Business Segments.", + "addressFormats": { "type": "object", + "description": "Response object for fetching Address Formats.", "properties": { - "businessSegments": { - "description": "Business Segments to be changed.", - "$ref": "#/definitions/businessSegmentsType" + "formats": { + "description": "Collection of Address formats fetched.", + "$ref": "#/definitions/addressFormatsType" }, "links": { "$ref": "#/definitions/links" @@ -32615,169 +27998,211 @@ } } }, - "businessSegmentsType": { - "description": "List of Business Segments.", + "addressFormatsType": { "type": "array", + "description": "An Address formats.", "maxItems": 4000, "items": { - "$ref": "#/definitions/businessSegmentType" + "$ref": "#/definitions/addressFormatType" } }, - "calendarGracePeriodType": { - "description": "Five Year period", - "type": "string", - "enum": [ - "NoGracePeriod", - "OneYear", - "TwoYears", - "ThreeYears", - "FourYears", - "FiveYears" - ] - }, - "calendarPeriodType": { - "description": "12 month period based on starting month.", - "type": "string", - "enum": [ - "Calendar", - "Rolling" - ] - }, - "cardNumberDetailsType": { - "description": "Card Number of membership type.", + "addressFormatType": { "type": "object", + "description": "A representation of the information contained by an address format.", "properties": { - "allowDuplicateCardNumbers": { - "description": "Indicates if the multiple membership cards may be issued with the same membership number.", - "type": "boolean" + "formatCode": { + "description": "Address format code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "cardNumberBasedOn": { - "description": "Indicates new membership card numbers, either based on the enrollment code or on the next available number in the card sequence.", - "$ref": "#/definitions/cardNumberGenerationModeType" + "formatDefinition": { + "description": "Address format definition with the elements of the address.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "chipAndPin": { - "description": "Indicates is there a microchip that stores information which can be used to verify the validity of the membership and authenticate the customer based on a personal identification number (PIN).", - "type": "boolean" + "description": { + "description": "Description of the address format.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "database": { - "description": "Indicates External System from which card number will be generated.", + "displayOrder": { + "description": "sequence number of the address format.", + "type": "number" + }, + "formattedExample": { + "description": "An example address formatted with the current format definition.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "expirationDateRequired": { - "description": "Indicates if the membership expiration date is required for validation of the profile membership information.", + "salesFormat": { + "description": "Determines if the format is a sales format or not.", "type": "boolean" }, - "membershipCardValidationRule": { - "description": "ValidationRules for credit card.", - "$ref": "#/definitions/membershipCardValidationRuleType" - }, - "validationByInterface": { - "description": "Indicates is the membership card is validated through the interface.", + "canDelete": { + "description": "Determines whether this address format can be deleted.", "type": "boolean" } } }, - "cardNumberGenerationModeType": { - "description": "Card Number is generated using Enrollment Code.", - "type": "string", - "enum": [ - "DefaultSequence", - "EnrollmentCode" - ] - }, - "cardRangeType": { - "description": "Card number start and end range.", + "addressTypesDetails": { "type": "object", + "description": "Response object for fetching Address Types.", "properties": { - "from": { - "description": "Starting range of the card.", - "type": "string", - "maxLength": 50, - "minLength": 0 + "addressTypes": { + "description": "Collection of Address Types.", + "$ref": "#/definitions/addressTypesType" }, - "to": { - "description": "End range of the card.", - "type": "string", - "maxLength": 50, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "cardRangesType": { - "description": "Card number start and end range.", + "addressTypesType": { "type": "array", + "description": "Communication Role Enumeration element.", "maxItems": 4000, "items": { - "$ref": "#/definitions/cardRangeType" + "$ref": "#/definitions/addressTypeType" } }, - "cityPostalCodeType": { - "description": "Information about the City and Postal Code.", + "addressTypeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "city": { - "description": "The name of the city which the City and Postal belongs to.", + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "cityPostalCodeId": { - "description": "The identifier of the city and postal code.", + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" + }, + "displayOrder": { + "description": "Common Master record sequence number.", "type": "number" + } + } + }, + "addressTypesCriteria": { + "type": "object", + "description": "Request object for creating a new Address Type.", + "properties": { + "addressTypes": { + "description": "Address Type to be created.", + "$ref": "#/definitions/addressTypesType" }, - "countryCode": { - "description": "The Country which the City and Postal belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "districtCode": { - "description": "The District which the City and Postal belongs to.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "addressTypesToBeChanged": { + "type": "object", + "description": "Request object for changing an existing Address Type.", + "properties": { + "addressTypes": { + "description": "Address Type to be changed.", + "$ref": "#/definitions/addressTypesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "alternateLanguageGuestTitlesDetails": { + "type": "object", + "description": "Response object for fetching Alternate Language Guest Titles.", + "properties": { + "alternateLanguageGuestTitles": { + "description": "Collection of Alternate Language Guest Titles.", + "$ref": "#/definitions/guestTitlesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "guestTitlesType": { + "type": "array", + "description": "List of Guest Titles.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/guestTitleType" + } + }, + "guestTitleType": { + "type": "object", + "description": "Information representation of Guest Title.", + "properties": { + "description": { + "description": "Description of the Guest Title.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "fiscalRegionCode": { - "description": "The Fiscal Region Code which the City and Postal belongs to.", + "greeting": { + "description": "Business Title for advanced title configuration.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 + }, + "displayOrder": { + "description": "Guest Title record sequence number.", + "type": "number" }, - "postalCodeFrom": { - "description": "The start range of the city and postal code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "newTitleType": { + "description": "Description of the Guest Title.", + "type": "integer" }, - "postalCodeTo": { - "description": "The end range of the city and postal code.", + "newLanguageCode": { + "description": "Description of the Guest Title.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "stateCode": { - "description": "The State which the City and Postal belongs to.", + "code": { + "description": "Code of the Guest Title.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "territoryCode": { - "description": "The Territoty which the City and Postal belongs to.", + "titleType": { + "description": "Title Type for advanced title configuration.", + "type": "integer" + }, + "languageCode": { + "description": "Language code of the Guest Title.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "cityPostalCodesCriteria": { - "description": "Request object for creating new city and postal codes.", + "alternateLanguageGuestTitlesCriteria": { "type": "object", + "description": "Request object for creating Alternate Language Guest Titles.", "properties": { - "cityPostalCodes": { - "description": "Collection of city and postal codes to be created.", - "$ref": "#/definitions/cityPostalCodesType" + "alternateLanguageGuestTitles": { + "description": "Alternate Language Guest Titles to be created.", + "$ref": "#/definitions/guestTitlesType" }, "links": { "$ref": "#/definitions/links" @@ -32787,60 +28212,32 @@ } } }, - "cityPostalCodesDetails": { - "description": "Response object for fetching city and postal codes.", + "alternateLanguageGuestTitlesToBeChanged": { "type": "object", + "description": "Request object for changing Alternate Language Guest Titles.", "properties": { - "cityPostalCodes": { - "description": "Collection of city and postal codes fetched based on the search criteria.", - "$ref": "#/definitions/cityPostalCodesType" - }, - "count": { - "description": "Total number of rows returned", - "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" - }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "alternateLanguageGuestTitles": { + "description": "Alternate Language Guest Titles to be changed.", + "$ref": "#/definitions/guestTitlesType" }, "links": { "$ref": "#/definitions/links" }, - "masterInfoList": { - "description": "Refer to Generic common types document.", - "type": "array", - "items": { - "$ref": "#/definitions/masterInfoType" - } - }, - "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" - }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "cityPostalCodesToBeChanged": { - "description": "Request object for updating city and postal codes.", + "availablePreferencesDetails": { "type": "object", + "description": "Response object for fetching available preferences for a property.", "properties": { - "cityPostalCodes": { - "description": "Collection of city and postal codes to be modified.", - "$ref": "#/definitions/cityPostalCodesType" + "preferenceCollection": { + "description": "A collection of preferences", + "type": "array", + "items": { + "$ref": "#/definitions/preferenceTypeType" + } }, "links": { "$ref": "#/definitions/links" @@ -32850,125 +28247,184 @@ } } }, - "cityPostalCodesType": { - "description": "Lists of City and Postal Codes.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/cityPostalCodeType" - } - }, - "codeDescriptionType": { - "description": "This contains a generic code and description information.", + "preferenceTypeType": { "type": "object", + "description": "Preference details for the profile.", "properties": { - "code": { - "description": "Code.", + "preference": { + "description": "Collection of Preferences for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/preferenceType" + } + }, + "preferenceType": { + "description": "Preference group code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "description.", + "preferenceTypeDescription": { + "description": "Preference group description.", + "type": "string" + }, + "sequence": { + "description": "Preference Sequence.", + "type": "string" + }, + "maxQuantity": { + "description": "Maximum quantity of preferences allowed per preference group.", + "type": "integer" + }, + "availableQuantity": { + "description": "Available quantity of preferences (maximum quantity - Existing preferences)per preference group.", + "type": "integer" + }, + "maxResortUsedQuantity": { + "description": "Maximum quantity of preferences used by any resort per preference group.", + "type": "integer" + }, + "reservationPreference": { + "description": "Whether this preference is reservation preference or not.", + "type": "boolean" + }, + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" + }, + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 200 + }, + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "codeInfoType": { + "preferenceType": { "type": "object", + "description": "Guest Preference details for the profile.", "properties": { - "addtionalCodeInfo": { - "$ref": "#/definitions/addtionalCodeInfoType" - }, - "code": { + "preferenceValue": { + "description": "Preference value for display purposes.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, "description": { + "description": "Preference Description for display purposes.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "hotelId": { + "global": { + "description": "Whether this preference is property specific or not.", + "type": "boolean" + }, + "source": { + "description": "Source of the preference.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "hotels": { + "description": "If specified preference belongs to the Hotels listed, otherwise it is a global preference.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "preferenceId": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "excludedPreferencesCount": { + "description": "Specifies the count of preferences excluded for the attached reservation preference.", + "type": "integer" + }, + "copyToProfile": { + "description": "Specifies whether to copy the reservation preference to the profile or not.", + "type": "boolean" } } }, - "codeListType": { - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 - } - }, - "colorType": { - "description": "Color configuration type. This color configuration provides a visual category of entities.", - "type": "string", - "enum": [ - "Red", - "DarkRed", - "Green", - "DarkGreen", - "LightGreen", - "Orange", - "White", - "Yellow", - "DarkYellow", - "Purple", - "Brown", - "Gray", - "Aqua", - "Chocolate", - "Blue", - "LightBlue", - "DarkBlue", - "Cyan", - "DarkCyan", - "Magenta", - "DarkMagenta", - "Black" - ] - }, - "commonMasterColorType": { - "description": "Simple type enumeration for Common Master Colors.", - "type": "string", - "enum": [ - "None", - "Blue", - "Red", - "Cyan", - "Green", - "Black", - "White", - "Yellow", - "Gray" - ] + "businessSegmentsDetails": { + "type": "object", + "description": "Response object for fetching Business Segments.", + "properties": { + "businessSegments": { + "description": "Collection of Business Segments.", + "$ref": "#/definitions/businessSegmentsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } }, - "communicationRoleType": { - "description": "Phone Number Communication Role.", - "type": "string", - "enum": [ - "Email", - "Fax", - "EmailForRequest", - "Webpage", - "Phone" - ] + "businessSegmentsType": { + "type": "array", + "description": "List of Business Segments.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/businessSegmentType" + } }, - "communicationTypeCriteria": { - "description": "Request object for creating a new Communication Type.", + "businessSegmentType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "communicationType": { - "description": "Communication Type to be created.", - "$ref": "#/definitions/communicationTypeType" + "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" + } + } + }, + "businessSegmentsCriteria": { + "type": "object", + "description": "Request object for creating Business Segments.", + "properties": { + "businessSegments": { + "description": "Business Segments to be created.", + "$ref": "#/definitions/businessSegmentsType" }, "links": { "$ref": "#/definitions/links" @@ -32978,13 +28434,13 @@ } } }, - "communicationTypeToBeChanged": { - "description": "Request object for changing an existing Communication Type.", + "businessSegmentsToBeChanged": { "type": "object", + "description": "Request object for changing Business Segments.", "properties": { - "communicationType": { - "description": "Communication Type to be changed.", - "$ref": "#/definitions/communicationTypeType" + "businessSegments": { + "description": "Business Segments to be changed.", + "$ref": "#/definitions/businessSegmentsType" }, "links": { "$ref": "#/definitions/links" @@ -32994,43 +28450,44 @@ } } }, - "communicationTypeType": { - "description": "Communication Type details.", + "cityPostalCodesDetails": { "type": "object", + "description": "Response object for fetching city and postal codes.", "properties": { - "code": { - "description": "Unique Communication Type Code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "cityPostalCodes": { + "description": "Collection of city and postal codes fetched based on the search criteria.", + "$ref": "#/definitions/cityPostalCodesType" }, - "description": { - "description": "Communication Type description.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "masterInfoList": { + "description": "Refer to Generic common types document.", + "type": "array", + "items": { + "$ref": "#/definitions/masterInfoType" + } }, - "role": { - "description": "Communication Role enumeration element.", - "$ref": "#/definitions/communicationRoleType" + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "sequence": { - "description": "Communication Type sequence.", + "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" }, - "textEnabled": { - "description": "Communication Type SMS Text Message enabled.", + "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" - } - } - }, - "communicationTypesDetails": { - "description": "Response object for fetching Communication Types.", - "type": "object", - "properties": { - "communicationTypes": { - "description": "Collection of Communication Types.", - "$ref": "#/definitions/communicationTypesType" + }, + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" }, "links": { "$ref": "#/definitions/links" @@ -33040,41 +28497,177 @@ } } }, - "communicationTypesType": { - "description": "Communication Type details.", + "cityPostalCodesType": { "type": "array", + "description": "Lists of City and Postal Codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/communicationTypeType" + "$ref": "#/definitions/cityPostalCodeType" } }, - "companyTypeType": { - "description": "Contains Common Master configuration detail.", + "cityPostalCodeType": { "type": "object", + "description": "Information about the City and Postal Code.", "properties": { - "code": { - "description": "Common Master unique code.", + "cityPostalCodeId": { + "description": "The identifier of the city and postal code.", + "type": "number" + }, + "postalCodeFrom": { + "description": "The start range of the city and postal code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "postalCodeTo": { + "description": "The end range of the city and postal code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "city": { + "description": "The name of the city which the City and Postal belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "districtCode": { + "description": "The District which the City and Postal belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "stateCode": { + "description": "The State which the City and Postal belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "territoryCode": { + "description": "The Territoty which the City and Postal belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "countryCode": { + "description": "The Country which the City and Postal belongs to.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, + "fiscalRegionCode": { + "description": "The Fiscal Region Code which the City and Postal belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "masterInfoType": { + "type": "object", + "properties": { + "codeInfo": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeInfoType" + } + }, + "codeType": { + "$ref": "#/definitions/masterType" + } + } + }, + "codeInfoType": { + "type": "object", + "description": "", + "properties": { "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "addtionalCodeInfo": { + "$ref": "#/definitions/addtionalCodeInfoType" + }, + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "code": { + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "companyTypesCriteria": { - "description": "Request object for creating Company Types.", + "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" + ] + }, + "cityPostalCodesCriteria": { "type": "object", + "description": "Request object for creating new city and postal codes.", "properties": { - "companyTypes": { - "description": "Company Typesto be created.", - "$ref": "#/definitions/companyTypesType" + "cityPostalCodes": { + "description": "Collection of city and postal codes to be created.", + "$ref": "#/definitions/cityPostalCodesType" }, "links": { "$ref": "#/definitions/links" @@ -33084,13 +28677,13 @@ } } }, - "companyTypesDetails": { - "description": "Response object for fetching Company Types.", + "cityPostalCodesToBeChanged": { "type": "object", + "description": "Request object for updating city and postal codes.", "properties": { - "companyTypes": { - "description": "Collection of Company Types.", - "$ref": "#/definitions/companyTypesType" + "cityPostalCodes": { + "description": "Collection of city and postal codes to be modified.", + "$ref": "#/definitions/cityPostalCodesType" }, "links": { "$ref": "#/definitions/links" @@ -33100,13 +28693,13 @@ } } }, - "companyTypesToBeChanged": { - "description": "Request object for changing Company Types.", + "communicationTypesDetails": { "type": "object", + "description": "Response object for fetching Communication Types.", "properties": { - "companyTypes": { - "description": "Company Typesto be changed.", - "$ref": "#/definitions/companyTypesType" + "communicationTypes": { + "description": "Collection of Communication Types.", + "$ref": "#/definitions/communicationTypesType" }, "links": { "$ref": "#/definitions/links" @@ -33116,45 +28709,62 @@ } } }, - "companyTypesType": { - "description": "List of Company Types.", + "communicationTypesType": { "type": "array", + "description": "Communication Type details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/companyTypeType" + "$ref": "#/definitions/communicationTypeType" } }, - "competitionCodeType": { - "description": "Contains Common Master configuration detail.", + "communicationTypeType": { "type": "object", + "description": "Communication Type details.", "properties": { - "code": { - "description": "Common Master unique code.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "role": { + "description": "Communication Role enumeration element.", + "$ref": "#/definitions/communicationRoleType" }, "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" - }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "description": "Communication Type description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "inactive": { - "description": "Determines whether this code is inactive or not.", + "textEnabled": { + "description": "Communication Type SMS Text Message enabled.", "type": "boolean" + }, + "sequence": { + "description": "Communication Type sequence.", + "type": "integer" + }, + "code": { + "description": "Unique Communication Type Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "competitionCodesCriteria": { - "description": "Request object for creating Competition Codes.", + "communicationRoleType": { + "type": "string", + "description": "Phone Number Communication Role.", + "enum": [ + "Email", + "Fax", + "EmailForRequest", + "Webpage", + "Phone" + ] + }, + "communicationTypeCriteria": { "type": "object", + "description": "Request object for creating a new Communication Type.", "properties": { - "competitionCodes": { - "description": "Competition Codesto be created.", - "$ref": "#/definitions/competitionCodesType" + "communicationType": { + "description": "Communication Type to be created.", + "$ref": "#/definitions/communicationTypeType" }, "links": { "$ref": "#/definitions/links" @@ -33164,13 +28774,13 @@ } } }, - "competitionCodesDetails": { - "description": "Response object for fetching Competition Codes.", + "communicationTypeToBeChanged": { "type": "object", + "description": "Request object for changing an existing Communication Type.", "properties": { - "competitionCodes": { - "description": "Collection of Competition Codes.", - "$ref": "#/definitions/competitionCodesType" + "communicationType": { + "description": "Communication Type to be changed.", + "$ref": "#/definitions/communicationTypeType" }, "links": { "$ref": "#/definitions/links" @@ -33180,287 +28790,115 @@ } } }, - "competitionCodesToBeChanged": { - "description": "Request object for changing Competition Codes.", + "companyTypesDetails": { "type": "object", + "description": "Response object for fetching Company Types.", "properties": { - "competitionCodes": { - "description": "Competition Codesto be changed.", - "$ref": "#/definitions/competitionCodesType" + "companyTypes": { + "description": "Collection of Company Types.", + "$ref": "#/definitions/companyTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "competitionCodesType": { - "description": "List of Competition Codes.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/competitionCodeType" - } - }, - "configCopyExclusivePreferencesType": { - "description": "Copy instructions for copying template Exclusive preferences to hotel(s)", - "type": "object", - "properties": { - "hotelCodes": { - "description": "Hotel codes list to which the exclusive pref is to be copied.", - "$ref": "#/definitions/codeListType" - }, - "templateExclusivePreference": { - "description": "Template Exclusive preference to be copied to the hotel(s).", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/configExclusivePrefCodeAndGroupType" - } - } - } - }, - "configCopyPreferencesType": { - "description": "Copy instructions for copying template preferences to hotel(s)", - "type": "object", - "properties": { - "hotelCodes": { - "description": "Hotel codes to copy the template preferences to.", - "$ref": "#/definitions/codeListType" - }, - "templatePreferences": { - "description": "Template preference to be copied to the hotel(s).", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/configTemplatePreferenceIDType" - } - } - } - }, - "configExclusivePrefCodeAndGroupType": { - "description": "Base details common between both template and property level Exclusive preference ids.", - "type": "object", - "properties": { - "code": { - "description": "Specifies the Exclusive preference code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "preferenceGroup": { - "description": "Specifies the preference group the Exclusive preference belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "configExclusivePreferenceBaseType": { - "description": "Base details common between both template and property level Exclusive preference ids.", - "type": "object", - "properties": { - "code": { - "description": "Specifies the Exclusive preference code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" - }, - "preferenceCodes": { - "description": "Specifies the preference codes mapped to the exclusive preference.", - "$ref": "#/definitions/preferenceCodesType" - }, - "preferenceGroup": { - "description": "Specifies the preference group the Exclusive preference belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "configHotelExclusivePreferenceType": { - "description": "Base details common between both template and property level Exclusive preference ids.", - "type": "object", - "properties": { - "code": { - "description": "Specifies the Exclusive preference code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "hotelId": { - "description": "Specifies the hotel code for which the Exclusive preference is specified.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" - }, - "preferenceCodes": { - "description": "Specifies the preference codes mapped to the exclusive preference.", - "$ref": "#/definitions/preferenceCodesType" - }, - "preferenceGroup": { - "description": "Specifies the preference group the Exclusive preference belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "configHotelExclusivePreferencesType": { - "description": "This gives detailed information about a Exclusive preference at the property level.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/configHotelExclusivePreferenceType" - } - }, - "configHotelPreferenceType": { - "description": "Base details common between both template and property level preferences.", - "type": "object", - "properties": { - "code": { - "description": "Specifies the preference code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "description": { - "description": "The description about the preference.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "hotelId": { - "description": "Specifies the hotel code for which the preference is specified.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "housekeeping": { - "description": "Flag to indicate if this preference should be available on the Task Sheet Workflow configuration. It is only applicable for preference types FLOOR and SPECIALS.", - "type": "boolean" - }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" - }, - "preferenceGroup": { - "description": "Specifies the preference group the preference belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "preferenceSubGroup": { - "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "$ref": "#/definitions/warningsType" } } }, - "configHotelPreferencesType": { - "description": "This type holds a collection of preferences at the property level.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/configHotelPreferenceType" - } - }, - "configTemplateExclusivePreferencesType": { - "description": "Base details common between both template and property level exclusive preferences.", + "companyTypesType": { "type": "array", + "description": "List of Company Types.", "maxItems": 4000, "items": { - "$ref": "#/definitions/configExclusivePreferenceBaseType" + "$ref": "#/definitions/companyTypeType" } }, - "configTemplatePreferenceIDType": { - "description": "Base details common between both template and property level preference ids.", + "companyTypeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { - "description": "Specifies the preference code.", + "description": "Common Master unique code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "preferenceGroup": { - "description": "Specifies the preference group the preference belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" + }, + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "configTemplatePreferenceType": { - "description": "Base details common between both template and property level preferences.", + "companyTypesCriteria": { "type": "object", + "description": "Request object for creating Company Types.", "properties": { - "code": { - "description": "Specifies the preference code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "companyTypes": { + "description": "Company Typesto be created.", + "$ref": "#/definitions/companyTypesType" }, - "description": { - "description": "The description about the preference.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "global": { - "description": "Specifies whether the preference is to be available for selection at all properties .", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "companyTypesToBeChanged": { + "type": "object", + "description": "Request object for changing Company Types.", + "properties": { + "companyTypes": { + "description": "Company Typesto be changed.", + "$ref": "#/definitions/companyTypesType" }, - "housekeeping": { - "description": "Flag to indicate if this preference should be available on the Task Sheet Workflow configuration. It is only applicable for preference types FLOOR and SPECIALS.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "competitionCodesDetails": { + "type": "object", + "description": "Response object for fetching Competition Codes.", + "properties": { + "competitionCodes": { + "description": "Collection of Competition Codes.", + "$ref": "#/definitions/competitionCodesType" }, - "preferenceGroup": { - "description": "Specifies the preference group the preference belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "preferenceSubGroup": { - "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "configTemplatePreferencesType": { - "description": "This type holds a collection of preferences at the template level.", + "competitionCodesType": { "type": "array", + "description": "List of Competition Codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/configTemplatePreferenceType" + "$ref": "#/definitions/competitionCodeType" } }, - "creditRatingType": { - "description": "Contains Common Master configuration detail.", + "competitionCodeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -33471,14 +28909,46 @@ "type": "number" }, "inactive": { - "description": "Determines whether this credit rating is inactive or not.", + "description": "Determines whether this code is inactive or not.", "type": "boolean" } } }, + "competitionCodesCriteria": { + "type": "object", + "description": "Request object for creating Competition Codes.", + "properties": { + "competitionCodes": { + "description": "Competition Codesto be created.", + "$ref": "#/definitions/competitionCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "competitionCodesToBeChanged": { + "type": "object", + "description": "Request object for changing Competition Codes.", + "properties": { + "competitionCodes": { + "description": "Competition Codesto be changed.", + "$ref": "#/definitions/competitionCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, "creditRatings": { - "description": "Response object for fetching credit ratings.", "type": "object", + "description": "Response object for fetching credit ratings.", "properties": { "creditRatings": { "description": "Collection of Credit Ratings.", @@ -33493,40 +28963,22 @@ } }, "creditRatingsType": { - "description": "List of Credit Ratings.", "type": "array", + "description": "List of Credit Ratings.", "maxItems": 4000, "items": { "$ref": "#/definitions/creditRatingType" } }, - "dateRangeType": { - "description": "Date Range with Start and End dates.", + "creditRatingType": { "type": "object", - "properties": { - "end": { - "description": "The ending value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "start": { - "description": "The starting value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 - } - } - }, - "distanceTypeType": { "description": "Contains Common Master configuration detail.", - "type": "object", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -33535,28 +28987,16 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" - } - } - }, - "distanceTypesCriteria": { - "description": "Request object for creating Distance Types.", - "type": "object", - "properties": { - "distanceTypes": { - "description": "Distance Typesto be created.", - "$ref": "#/definitions/distanceTypesType" - }, - "links": { - "$ref": "#/definitions/links" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "inactive": { + "description": "Determines whether this credit rating is inactive or not.", + "type": "boolean" } } }, "distanceTypesDetails": { - "description": "Response object for fetching Distance Types.", "type": "object", + "description": "Response object for fetching Distance Types.", "properties": { "distanceTypes": { "description": "Collection of Distance Types.", @@ -33570,39 +29010,23 @@ } } }, - "distanceTypesToBeChanged": { - "description": "Request object for changing Distance Types.", - "type": "object", - "properties": { - "distanceTypes": { - "description": "Distance Typesto be changed.", - "$ref": "#/definitions/distanceTypesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, "distanceTypesType": { - "description": "List of Distance Types.", "type": "array", + "description": "List of Distance Types.", "maxItems": 4000, "items": { "$ref": "#/definitions/distanceTypeType" } }, - "districtType": { - "description": "Contains Common Master configuration detail.", + "distanceTypeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -33614,13 +29038,13 @@ } } }, - "districtsCriteria": { - "description": "Request object for creating Districts.", + "distanceTypesCriteria": { "type": "object", + "description": "Request object for creating Distance Types.", "properties": { - "districts": { - "description": "Districtsto be created.", - "$ref": "#/definitions/districtsType" + "distanceTypes": { + "description": "Distance Typesto be created.", + "$ref": "#/definitions/distanceTypesType" }, "links": { "$ref": "#/definitions/links" @@ -33630,13 +29054,13 @@ } } }, - "districtsDetails": { - "description": "Response object for fetching Districts.", + "distanceTypesToBeChanged": { "type": "object", + "description": "Request object for changing Distance Types.", "properties": { - "districts": { - "description": "Collection of Districts.", - "$ref": "#/definitions/districtsType" + "distanceTypes": { + "description": "Distance Typesto be changed.", + "$ref": "#/definitions/distanceTypesType" }, "links": { "$ref": "#/definitions/links" @@ -33646,12 +29070,12 @@ } } }, - "districtsToBeChanged": { - "description": "Request object for changing Districts.", + "districtsDetails": { "type": "object", + "description": "Response object for fetching Districts.", "properties": { "districts": { - "description": "Districtsto be changed.", + "description": "Collection of Districts.", "$ref": "#/definitions/districtsType" }, "links": { @@ -33663,22 +29087,22 @@ } }, "districtsType": { - "description": "List of Districts.", "type": "array", + "description": "List of Districts.", "maxItems": 4000, "items": { "$ref": "#/definitions/districtType" } }, - "ecertificateLocationTypeType": { - "description": "Contains Common Master configuration detail.", + "districtType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -33690,13 +29114,13 @@ } } }, - "ecertificateLocationTypesCriteria": { - "description": "Request object for creating Ecertificate Location Types.", + "districtsCriteria": { "type": "object", + "description": "Request object for creating Districts.", "properties": { - "ecertificateLocationTypes": { - "description": "Ecertificate Location Types to be created.", - "$ref": "#/definitions/ecertificateLocationTypesType" + "districts": { + "description": "Districtsto be created.", + "$ref": "#/definitions/districtsType" }, "links": { "$ref": "#/definitions/links" @@ -33706,13 +29130,13 @@ } } }, - "ecertificateLocationTypesDetails": { - "description": "Response object for fetching Ecertificate Location Types.", + "districtsToBeChanged": { "type": "object", + "description": "Request object for changing Districts.", "properties": { - "ecertificateLocationTypes": { - "description": "Collection of Ecertificate Location Types.", - "$ref": "#/definitions/ecertificateLocationTypesType" + "districts": { + "description": "Districtsto be changed.", + "$ref": "#/definitions/districtsType" }, "links": { "$ref": "#/definitions/links" @@ -33722,13 +29146,13 @@ } } }, - "ecertificateLocationTypesToBeChanged": { - "description": "Request object for changing Ecertificate Location Types.", + "templateExclusivePreferences": { "type": "object", + "description": "Response object for fetching exclusive preferences at the template level.", "properties": { - "ecertificateLocationTypes": { - "description": "Ecertificate Location Types to be changed.", - "$ref": "#/definitions/ecertificateLocationTypesType" + "templateExclusivePreferences": { + "description": "Collection of exclusive preferences specified at the template level.", + "$ref": "#/definitions/configTemplateExclusivePreferencesType" }, "links": { "$ref": "#/definitions/links" @@ -33738,219 +29162,176 @@ } } }, - "ecertificateLocationTypesType": { - "description": "List of Ecertificate Location Types.", + "configTemplateExclusivePreferencesType": { "type": "array", + "description": "Base details common between both template and property level exclusive preferences.", "maxItems": 4000, "items": { - "$ref": "#/definitions/ecertificateLocationTypeType" - } - }, - "emailInfoType": { - "description": "Information on an email for the customer.", - "type": "object", - "properties": { - "email": { - "description": "eMail deatils for the profile.", - "$ref": "#/definitions/emailType" - }, - "id": { - "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 - } + "$ref": "#/definitions/configExclusivePreferenceBaseType" } }, - "emailType": { - "description": "Information on an email for the customer.", + "configExclusivePreferenceBaseType": { "type": "object", + "description": "Base details common between both template and property level Exclusive preference ids.", "properties": { - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "emailAddress": { - "description": "Defines the e-mail address.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "emailFormat": { - "description": "Supported Email format.", + "code": { + "description": "Specifies the Exclusive preference code.", "type": "string", - "enum": [ - "Html", - "Text" - ] + "minLength": 0, + "maxLength": 20 }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "preferenceGroup": { + "description": "Specifies the preference group the Exclusive preference belongs to.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "preferenceCodes": { + "description": "Specifies the preference codes mapped to the exclusive preference.", + "$ref": "#/definitions/preferenceCodesType" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" + } + } + }, + "preferenceCodesType": { + "type": "array", + "description": "Specifies the preference code and its description mapped to the exclusive preference.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeDescriptionType" + } + }, + "exclusivePreferencesCopy": { + "type": "object", + "description": "Request object for copying template Exclusive preferences to hotel(s).", + "properties": { + "copyInstructions": { + "description": "List of the template Exclusive preferences to be copied to hotel(s).", + "$ref": "#/definitions/configCopyExclusivePreferencesType" }, - "primaryInd": { - "description": "When true, indicates a primary information.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "configCopyExclusivePreferencesType": { + "type": "object", + "description": "Copy instructions for copying template Exclusive preferences to hotel(s)", + "properties": { + "templateExclusivePreference": { + "description": "Template Exclusive preference to be copied to the hotel(s).", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configExclusivePrefCodeAndGroupType" + } }, - "type": { - "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve).", + "hotelCodes": { + "description": "Hotel codes list to which the exclusive pref is to be copied.", + "$ref": "#/definitions/codeListType" + } + } + }, + "configExclusivePrefCodeAndGroupType": { + "type": "object", + "description": "Base details common between both template and property level Exclusive preference ids.", + "properties": { + "code": { + "description": "Specifies the Exclusive preference code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "typeDescription": { - "description": "Describes the Type code", + "preferenceGroup": { + "description": "Specifies the preference group the Exclusive preference belongs to.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "enrollmentMatchRuleType": { - "description": "Represent Enrollment Match Rule and User Defined Enrollment fields/Attribute configuration for membership type.", + "codeListType": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "travelAgentTypesDetails": { "type": "object", + "description": "Response object for fetching Travel Agent Types.", "properties": { - "advancedEnrollment": { - "description": "Indicates if the Advanced Enrollment is enabled for Membership Type. Advanced Enrollment is required tp apply Membership Enrollment Match Rule and User Defined Enrollment Fields/Attributes.", - "type": "boolean" + "travelAgentTypes": { + "description": "Collection of Travel Agent Types.", + "$ref": "#/definitions/travelAgentTypesType" }, - "membershipEnrollmentMatchRule": { - "description": "Enrollment Match Rule for Membership Type.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "userDefinedEnrollmentFields": { - "description": "User Defined Enrollment fields/Attributes for membership type.", - "$ref": "#/definitions/userDefinedEnrollmentFieldsType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "errorInstance": { - "description": "Complex type that contains error instance details for a REST call.", + "travelAgentTypesType": { + "type": "array", + "description": "List of Travel Agent Types.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/travelAgentTypeType" + } + }, + "travelAgentTypeType": { "type": "object", - "title": "Error Instance Details", - "required": [ - "type", - "title" - ], + "description": "Contains Common Master configuration detail.", "properties": { - "detail": { - "description": "Human-readable description specific to this occurrence of the problem.", - "type": "string" - }, - "instance": { - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.", - "type": "string" - }, - "o:errorCode": { - "description": "Application error code, which is different from HTTP error code.", - "type": "string" - }, - "o:errorPath": { - "description": "Path to the problem at the resource or property level.", - "type": "string" - }, - "status": { - "description": "HTTP status code for this occurrence of the problem, set by the origin server.", - "type": "integer" + "code": { + "description": "Common Master unique code.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "title": { - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.", - "type": "string" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "type": { - "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).", - "type": "string" + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "exceptionDetailType": { - "description": "Complex type that contains error details for a REST call.", + "travelAgentTypesCriteria": { "type": "object", - "title": "Error Detail", - "required": [ - "type", - "title" - ], + "description": "Request object for creating Travel Agent Types.", "properties": { - "detail": { - "description": "Human-readable description specific to this occurrence of the problem.", - "type": "string" - }, - "instance": { - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.", - "type": "string" + "travelAgentTypes": { + "description": "Travel Agent Typesto be created.", + "$ref": "#/definitions/travelAgentTypesType" }, "links": { "$ref": "#/definitions/links" }, - "o:errorCode": { - "description": "Application error code, which is different from HTTP error code.", - "type": "string" - }, - "o:errorDetails": { - "description": "Details of the error message, consisting of a hierarchical tree structure.", - "type": "array", - "items": { - "$ref": "#/definitions/errorInstance" - } - }, - "o:errorPath": { - "description": "Path to the problem at the resource or property level.", - "type": "string" - }, - "status": { - "description": "HTTP status code for this occurrence of the problem, set by the origin server.", - "type": "integer" - }, - "title": { - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.", - "type": "string" - }, - "type": { - "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).", - "type": "string" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "exclusivePreferences": { - "description": "Response object for fetching Exclusive preferences at the property level.", + "travelAgentTypesToBeChanged": { "type": "object", + "description": "Request object for changing Travel Agent Types.", "properties": { - "hotelExclusivePreferences": { - "description": "Collection of Exclusive preferences specified at the property level.", - "$ref": "#/definitions/configHotelExclusivePreferencesType" + "travelAgentTypes": { + "description": "Travel Agent Typesto be changed.", + "$ref": "#/definitions/travelAgentTypesType" }, "links": { "$ref": "#/definitions/links" @@ -33960,13 +29341,13 @@ } } }, - "exclusivePreferencesCopy": { - "description": "Request object for copying template Exclusive preferences to hotel(s).", + "genderTypes": { "type": "object", - "properties": { - "copyInstructions": { - "description": "List of the template Exclusive preferences to be copied to hotel(s).", - "$ref": "#/definitions/configCopyExclusivePreferencesType" + "description": "Response object for fetching Gender Types.", + "properties": { + "genderTypes": { + "description": "Collection of Gender Types.", + "$ref": "#/definitions/genderTypesType" }, "links": { "$ref": "#/definitions/links" @@ -33976,15 +29357,23 @@ } } }, + "genderTypesType": { + "type": "array", + "description": "List of Gender Type.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/genderType" + } + }, "genderType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -34000,12 +29389,12 @@ } } }, - "genderTypes": { - "description": "Response object for fetching Gender Types.", + "genderTypesCriteria": { "type": "object", + "description": "Request object for creating Gender Types.", "properties": { "genderTypes": { - "description": "Collection of Gender Types.", + "description": "Gender Types to be created.", "$ref": "#/definitions/genderTypesType" }, "links": { @@ -34016,12 +29405,12 @@ } } }, - "genderTypesCriteria": { - "description": "Request object for creating Gender Types.", + "genderTypesToChange": { "type": "object", + "description": "Request object for changing Gender Types.", "properties": { "genderTypes": { - "description": "Gender Types to be created.", + "description": "Gender Types to be changed.", "$ref": "#/definitions/genderTypesType" }, "links": { @@ -34032,13 +29421,13 @@ } } }, - "genderTypesToChange": { - "description": "Request object for changing Gender Types.", + "guestStatusesDetails": { "type": "object", + "description": "Response object for fetching Guest Statuses.", "properties": { - "genderTypes": { - "description": "Gender Types to be changed.", - "$ref": "#/definitions/genderTypesType" + "guestStatuses": { + "description": "Collection of Guest Statuses.", + "$ref": "#/definitions/guestStatusesType" }, "links": { "$ref": "#/definitions/links" @@ -34048,23 +29437,23 @@ } } }, - "genderTypesType": { - "description": "List of Gender Type.", + "guestStatusesType": { "type": "array", + "description": "List of Guest Statuses.", "maxItems": 4000, "items": { - "$ref": "#/definitions/genderType" + "$ref": "#/definitions/guestStatusType" } }, "guestStatusType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -34077,8 +29466,8 @@ } }, "guestStatusesCriteria": { - "description": "Request object for creating Guest Statuses.", "type": "object", + "description": "Request object for creating Guest Statuses.", "properties": { "guestStatuses": { "description": "Guest Statuses to be created.", @@ -34092,12 +29481,12 @@ } } }, - "guestStatusesDetails": { - "description": "Response object for fetching Guest Statuses.", + "guestStatusesToBeChanged": { "type": "object", + "description": "Request object for changing Guest Statuses.", "properties": { "guestStatuses": { - "description": "Collection of Guest Statuses.", + "description": "Guest Statuses to be changed.", "$ref": "#/definitions/guestStatusesType" }, "links": { @@ -34108,13 +29497,13 @@ } } }, - "guestStatusesToBeChanged": { - "description": "Request object for changing Guest Statuses.", + "guestTitlesDetails": { "type": "object", + "description": "Response object for fetching Guest Titles.", "properties": { - "guestStatuses": { - "description": "Guest Statuses to be changed.", - "$ref": "#/definitions/guestStatusesType" + "guestTitles": { + "description": "Collection of Guest Titles.", + "$ref": "#/definitions/guestTitlesType" }, "links": { "$ref": "#/definitions/links" @@ -34124,69 +29513,89 @@ } } }, - "guestStatusesType": { - "description": "List of Guest Statuses.", + "guestTitlesCriteria": { + "type": "object", + "description": "Request object for creating Guest Titles.", + "properties": { + "guestTitles": { + "description": "Guest Titles to be created.", + "$ref": "#/definitions/guestTitlesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "guestTitlesToBeChanged": { + "type": "object", + "description": "Request object for changing Guest Titles.", + "properties": { + "guestTitles": { + "description": "Guest Titles to be changed.", + "$ref": "#/definitions/guestTitlesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "guestTypesDetails": { + "type": "object", + "description": "Response object for fetching Guest Types.", + "properties": { + "guestTypes": { + "description": "Collection of Guest Types.", + "$ref": "#/definitions/guestTypesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "guestTypesType": { "type": "array", + "description": "List of Guest Types.", "maxItems": 4000, "items": { - "$ref": "#/definitions/guestStatusType" + "$ref": "#/definitions/guestTypeType" } }, - "guestTitleType": { - "description": "Information representation of Guest Title.", + "guestTypeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { - "description": "Code of the Guest Title.", + "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { - "description": "Description of the Guest Title.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { - "description": "Guest Title record sequence number.", + "description": "Common Master record sequence number.", "type": "number" - }, - "greeting": { - "description": "Business Title for advanced title configuration.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "languageCode": { - "description": "Language code of the Guest Title.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "newLanguageCode": { - "description": "Description of the Guest Title.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "newTitleType": { - "description": "Description of the Guest Title.", - "type": "integer" - }, - "titleType": { - "description": "Title Type for advanced title configuration.", - "type": "integer" } } }, - "guestTitlesCriteria": { - "description": "Request object for creating Guest Titles.", + "guestTypesCriteria": { "type": "object", + "description": "Request object for creating Guest Types.", "properties": { - "guestTitles": { - "description": "Guest Titles to be created.", - "$ref": "#/definitions/guestTitlesType" + "guestTypes": { + "description": "Guest Types to be created.", + "$ref": "#/definitions/guestTypesType" }, "links": { "$ref": "#/definitions/links" @@ -34196,13 +29605,13 @@ } } }, - "guestTitlesDetails": { - "description": "Response object for fetching Guest Titles.", + "guestTypesToBeChanged": { "type": "object", + "description": "Request object for changing Guest Types.", "properties": { - "guestTitles": { - "description": "Collection of Guest Titles.", - "$ref": "#/definitions/guestTitlesType" + "guestTypes": { + "description": "Guest Types to be changed.", + "$ref": "#/definitions/guestTypesType" }, "links": { "$ref": "#/definitions/links" @@ -34212,13 +29621,13 @@ } } }, - "guestTitlesToBeChanged": { - "description": "Request object for changing Guest Titles.", + "ecertificateLocationTypesDetails": { "type": "object", + "description": "Response object for fetching Ecertificate Location Types.", "properties": { - "guestTitles": { - "description": "Guest Titles to be changed.", - "$ref": "#/definitions/guestTitlesType" + "ecertificateLocationTypes": { + "description": "Collection of Ecertificate Location Types.", + "$ref": "#/definitions/ecertificateLocationTypesType" }, "links": { "$ref": "#/definitions/links" @@ -34228,23 +29637,23 @@ } } }, - "guestTitlesType": { - "description": "List of Guest Titles.", + "ecertificateLocationTypesType": { "type": "array", + "description": "List of Ecertificate Location Types.", "maxItems": 4000, "items": { - "$ref": "#/definitions/guestTitleType" + "$ref": "#/definitions/ecertificateLocationTypeType" } }, - "guestTypeType": { - "description": "Contains Common Master configuration detail.", + "ecertificateLocationTypeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -34256,13 +29665,29 @@ } } }, - "guestTypesCriteria": { - "description": "Request object for creating Guest Types.", + "ecertificateLocationTypesCriteria": { + "type": "object", + "description": "Request object for creating Ecertificate Location Types.", + "properties": { + "ecertificateLocationTypes": { + "description": "Ecertificate Location Types to be created.", + "$ref": "#/definitions/ecertificateLocationTypesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "ecertificateLocationTypesToBeChanged": { "type": "object", + "description": "Request object for changing Ecertificate Location Types.", "properties": { - "guestTypes": { - "description": "Guest Types to be created.", - "$ref": "#/definitions/guestTypesType" + "ecertificateLocationTypes": { + "description": "Ecertificate Location Types to be changed.", + "$ref": "#/definitions/ecertificateLocationTypesType" }, "links": { "$ref": "#/definitions/links" @@ -34272,29 +29697,69 @@ } } }, - "guestTypesDetails": { - "description": "Response object for fetching Guest Types.", + "exclusivePreferences": { "type": "object", + "description": "Response object for fetching Exclusive preferences at the property level.", "properties": { - "guestTypes": { - "description": "Collection of Guest Types.", - "$ref": "#/definitions/guestTypesType" + "hotelExclusivePreferences": { + "description": "Collection of Exclusive preferences specified at the property level.", + "$ref": "#/definitions/configHotelExclusivePreferencesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "configHotelExclusivePreferencesType": { + "type": "array", + "description": "This gives detailed information about a Exclusive preference at the property level.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configHotelExclusivePreferenceType" + } + }, + "configHotelExclusivePreferenceType": { + "type": "object", + "description": "Base details common between both template and property level Exclusive preference ids.", + "properties": { + "code": { + "description": "Specifies the Exclusive preference code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "preferenceGroup": { + "description": "Specifies the preference group the Exclusive preference belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "preferenceCodes": { + "description": "Specifies the preference codes mapped to the exclusive preference.", + "$ref": "#/definitions/preferenceCodesType" }, - "links": { - "$ref": "#/definitions/links" + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "hotelId": { + "description": "Specifies the hotel code for which the Exclusive preference is specified.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "guestTypesToBeChanged": { - "description": "Request object for changing Guest Types.", + "hotelPreferences": { "type": "object", + "description": "Response object for fetching preferences at the property level.", "properties": { - "guestTypes": { - "description": "Guest Types to be changed.", - "$ref": "#/definitions/guestTypesType" + "hotelPreferences": { + "description": "Collection of preferences specified at the property level.", + "$ref": "#/definitions/configHotelPreferencesType" }, "links": { "$ref": "#/definitions/links" @@ -34304,61 +29769,65 @@ } } }, - "guestTypesType": { - "description": "List of Guest Types.", + "configHotelPreferencesType": { "type": "array", + "description": "This type holds a collection of preferences at the property level.", "maxItems": 4000, "items": { - "$ref": "#/definitions/guestTypeType" + "$ref": "#/definitions/configHotelPreferenceType" } }, - "hotelFolioTextType": { - "description": "Folio text", + "configHotelPreferenceType": { "type": "object", + "description": "Base details common between both template and property level preferences.", "properties": { - "folioText1": { + "description": { + "description": "The description about the preference.", "type": "string", - "maxLength": 400, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "folioText2": { + "code": { + "description": "Specifies the preference code.", "type": "string", - "maxLength": 400, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "folioText3": { + "preferenceGroup": { + "description": "Specifies the preference group the preference belongs to.", "type": "string", - "maxLength": 400, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "folioText4": { + "preferenceSubGroup": { + "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", "type": "string", - "maxLength": 400, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "housekeeping": { + "description": "Flag to indicate if this preference should be available on the Task Sheet Workflow configuration. It is only applicable for preference types FLOOR and SPECIALS.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" }, "hotelId": { - "description": "Signifies folio text for a specific hotel.", + "description": "Specifies the hotel code for which the preference is specified.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "hotelFolioTextsType": { - "description": "Collection of hotel folio texts", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelFolioTextType" - } - }, - "hotelPreferences": { - "description": "Response object for fetching preferences at the property level.", + "identificationTypesDetails": { "type": "object", + "description": "Response object for fetching Identification Types.", "properties": { - "hotelPreferences": { - "description": "Collection of preferences specified at the property level.", - "$ref": "#/definitions/configHotelPreferencesType" + "identificationTypes": { + "description": "Collection of Identification Types.", + "$ref": "#/definitions/identificationTypesType" }, "links": { "$ref": "#/definitions/links" @@ -34368,26 +29837,23 @@ } } }, - "identificationRoleType": { - "description": "Simple type for storing identification roles.", - "type": "string", - "enum": [ - "Passport", - "DriverLicense", - "Visa", - "Id", - "Unknown" - ] + "identificationTypesType": { + "type": "array", + "description": "List of Identification Types.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/identificationTypeType" + } }, "identificationTypeType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -34403,9 +29869,20 @@ } } }, + "identificationRoleType": { + "type": "string", + "description": "Simple type for storing identification roles.", + "enum": [ + "Passport", + "DriverLicense", + "Visa", + "Id", + "Unknown" + ] + }, "identificationTypesCriteria": { - "description": "Request object for creating Identification Types.", "type": "object", + "description": "Request object for creating Identification Types.", "properties": { "identificationTypes": { "description": "Identification Typesto be created.", @@ -34419,12 +29896,12 @@ } } }, - "identificationTypesDetails": { - "description": "Response object for fetching Identification Types.", + "identificationTypesToBeChanged": { "type": "object", + "description": "Request object for changing Identification Types.", "properties": { "identificationTypes": { - "description": "Collection of Identification Types.", + "description": "Identification Typesto be changed.", "$ref": "#/definitions/identificationTypesType" }, "links": { @@ -34435,13 +29912,13 @@ } } }, - "identificationTypesToBeChanged": { - "description": "Request object for changing Identification Types.", + "immigrationStatusesDetails": { "type": "object", + "description": "Response object for fetching Immigration Statuses.", "properties": { - "identificationTypes": { - "description": "Identification Typesto be changed.", - "$ref": "#/definitions/identificationTypesType" + "immigrationStatuses": { + "description": "Collection of Immigration Statuses.", + "$ref": "#/definitions/immigrationStatusesType" }, "links": { "$ref": "#/definitions/links" @@ -34451,23 +29928,23 @@ } } }, - "identificationTypesType": { - "description": "List of Identification Types.", + "immigrationStatusesType": { "type": "array", + "description": "List of Immigration Statuses.", "maxItems": 4000, "items": { - "$ref": "#/definitions/identificationTypeType" + "$ref": "#/definitions/immigrationStatusType" } }, "immigrationStatusType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -34480,8 +29957,8 @@ } }, "immigrationStatusesCriteria": { - "description": "Request object for creating Immigration Statuses.", "type": "object", + "description": "Request object for creating Immigration Statuses.", "properties": { "immigrationStatuses": { "description": "Immigration Statuses to be created.", @@ -34495,12 +29972,12 @@ } } }, - "immigrationStatusesDetails": { - "description": "Response object for fetching Immigration Statuses.", + "immigrationStatusesToBeChanged": { "type": "object", + "description": "Request object for changing Immigration Statuses.", "properties": { "immigrationStatuses": { - "description": "Collection of Immigration Statuses.", + "description": "Immigration Statuses to be changed.", "$ref": "#/definitions/immigrationStatusesType" }, "links": { @@ -34511,13 +29988,13 @@ } } }, - "immigrationStatusesToBeChanged": { - "description": "Request object for changing Immigration Statuses.", + "industryCodesDetails": { "type": "object", + "description": "Response object for fetching Industry Codes.", "properties": { - "immigrationStatuses": { - "description": "Immigration Statuses to be changed.", - "$ref": "#/definitions/immigrationStatusesType" + "industryCodes": { + "description": "Collection of Industry Codes.", + "$ref": "#/definitions/industryCodesType" }, "links": { "$ref": "#/definitions/links" @@ -34527,23 +30004,23 @@ } } }, - "immigrationStatusesType": { - "description": "List of Immigration Statuses.", + "industryCodesType": { "type": "array", + "description": "List of Industry Codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/immigrationStatusType" + "$ref": "#/definitions/industryCodeType" } }, "industryCodeType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -34560,8 +30037,8 @@ } }, "industryCodesCriteria": { - "description": "Request object for creating Industry Codes.", "type": "object", + "description": "Request object for creating Industry Codes.", "properties": { "industryCodes": { "description": "Industry Codesto be created.", @@ -34575,12 +30052,12 @@ } } }, - "industryCodesDetails": { - "description": "Response object for fetching Industry Codes.", + "industryCodesToBeChanged": { "type": "object", + "description": "Request object for changing Industry Codes.", "properties": { "industryCodes": { - "description": "Collection of Industry Codes.", + "description": "Industry Codesto be changed.", "$ref": "#/definitions/industryCodesType" }, "links": { @@ -34591,13 +30068,13 @@ } } }, - "industryCodesToBeChanged": { - "description": "Request object for changing Industry Codes.", + "influenceCodesDetails": { "type": "object", + "description": "Response object for fetching Influence Codes.", "properties": { - "industryCodes": { - "description": "Industry Codesto be changed.", - "$ref": "#/definitions/industryCodesType" + "influenceCodes": { + "description": "Collection of Influence Codes.", + "$ref": "#/definitions/influenceCodesType" }, "links": { "$ref": "#/definitions/links" @@ -34607,23 +30084,23 @@ } } }, - "industryCodesType": { - "description": "List of Industry Codes.", + "influenceCodesType": { "type": "array", + "description": "List of Influence Codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/industryCodeType" + "$ref": "#/definitions/influenceCodeType" } }, "influenceCodeType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -34639,13 +30116,93 @@ } } }, - "influenceCodesCriteria": { - "description": "Request object for creating Influence Codes.", + "influenceCodesCriteria": { + "type": "object", + "description": "Request object for creating Influence Codes.", + "properties": { + "influenceCodes": { + "description": "Influence Codesto be created.", + "$ref": "#/definitions/influenceCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "influenceCodesToBeChanged": { + "type": "object", + "description": "Request object for changing Influence Codes.", + "properties": { + "influenceCodes": { + "description": "Influence Codesto be changed.", + "$ref": "#/definitions/influenceCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "keywordTypesDetails": { + "type": "object", + "description": "Response object for fetching Keyword Types.", + "properties": { + "keywordTypes": { + "description": "Collection of Keyword Types.", + "$ref": "#/definitions/keywordTypesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "keywordTypesType": { + "type": "array", + "description": "List of Keyword Types.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/keywordTypeType" + } + }, + "keywordTypeType": { + "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" + }, + "masterSubKeyword": { + "description": "Indicates if the KEYWORD TYPE is to be copied from a Company Master to a Company Subsidiary.", + "type": "boolean" + } + } + }, + "keywordTypesCriteria": { "type": "object", + "description": "Request object for creating Keyword Types.", "properties": { - "influenceCodes": { - "description": "Influence Codesto be created.", - "$ref": "#/definitions/influenceCodesType" + "keywordTypes": { + "description": "Keyword Typesto be created.", + "$ref": "#/definitions/keywordTypesType" }, "links": { "$ref": "#/definitions/links" @@ -34655,13 +30212,13 @@ } } }, - "influenceCodesDetails": { - "description": "Response object for fetching Influence Codes.", + "keywordTypesToBeChanged": { "type": "object", + "description": "Request object for changing Keyword Types.", "properties": { - "influenceCodes": { - "description": "Collection of Influence Codes.", - "$ref": "#/definitions/influenceCodesType" + "keywordTypes": { + "description": "Keyword Typesto be changed.", + "$ref": "#/definitions/keywordTypesType" }, "links": { "$ref": "#/definitions/links" @@ -34671,13 +30228,13 @@ } } }, - "influenceCodesToBeChanged": { - "description": "Request object for changing Influence Codes.", + "mailingActionCodesDetails": { "type": "object", + "description": "Response object for fetching Mailing Action Codes.", "properties": { - "influenceCodes": { - "description": "Influence Codesto be changed.", - "$ref": "#/definitions/influenceCodesType" + "mailingActionCodes": { + "description": "Collection of Mailing Action Codes.", + "$ref": "#/definitions/mailingActionCodesType" }, "links": { "$ref": "#/definitions/links" @@ -34687,73 +30244,23 @@ } } }, - "influenceCodesType": { - "description": "List of Influence Codes.", + "mailingActionCodesType": { "type": "array", + "description": "List of Mailing Action Codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/influenceCodeType" + "$ref": "#/definitions/mailingActionCodeType" } }, - "instanceLink": { - "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", + "mailingActionCodeType": { "type": "object", - "required": [ - "href", - "rel", - "method", - "operationId" - ], - "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" - }, - "method": { - "description": "HTTP method for requesting the target of the link.", - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE", - "PATCH", - "OPTIONS", - "HEAD" - ] - }, - "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" - }, - "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" - }, - "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" - }, - "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 - }, - "title": { - "description": "Exact copy of the \"summary\" field on the linked operation.", - "type": "string" - } - } - }, - "keywordTypeType": { "description": "Contains Common Master configuration detail.", - "type": "object", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -34763,19 +30270,19 @@ "description": "Common Master record sequence number.", "type": "number" }, - "masterSubKeyword": { - "description": "Indicates if the KEYWORD TYPE is to be copied from a Company Master to a Company Subsidiary.", + "inactive": { + "description": "Determines whether this code is inactive or not.", "type": "boolean" } } }, - "keywordTypesCriteria": { - "description": "Request object for creating Keyword Types.", + "mailingActionCodesCriteria": { "type": "object", + "description": "Request object for creating Mailing Action Codes.", "properties": { - "keywordTypes": { - "description": "Keyword Typesto be created.", - "$ref": "#/definitions/keywordTypesType" + "mailingActionCodes": { + "description": "Mailing Action Codes to be created.", + "$ref": "#/definitions/mailingActionCodesType" }, "links": { "$ref": "#/definitions/links" @@ -34785,13 +30292,13 @@ } } }, - "keywordTypesDetails": { - "description": "Response object for fetching Keyword Types.", + "mailingActionCodesToBeChanged": { "type": "object", + "description": "Request object for changing Mailing Action Codes.", "properties": { - "keywordTypes": { - "description": "Collection of Keyword Types.", - "$ref": "#/definitions/keywordTypesType" + "mailingActionCodes": { + "description": "Mailing Action Codes to be changed.", + "$ref": "#/definitions/mailingActionCodesType" }, "links": { "$ref": "#/definitions/links" @@ -34801,13 +30308,13 @@ } } }, - "keywordTypesToBeChanged": { - "description": "Request object for changing Keyword Types.", + "membershipAwardsInfo": { "type": "object", + "description": "Response to fetch Membership Awards.", "properties": { - "keywordTypes": { - "description": "Keyword Typesto be changed.", - "$ref": "#/definitions/keywordTypesType" + "membershipAwards": { + "description": "Collection of Membership Awards.", + "$ref": "#/definitions/membershipAwardsType" }, "links": { "$ref": "#/definitions/links" @@ -34817,2516 +30324,2812 @@ } } }, - "keywordTypesType": { - "description": "List of Keyword Types.", + "membershipAwardsType": { "type": "array", + "description": "Membership Award details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/keywordTypeType" + "$ref": "#/definitions/membershipAwardType" } }, - "links": { - "type": "array", - "items": { - "$ref": "#/definitions/instanceLink" + "membershipAwardType": { + "type": "object", + "description": "Values by which membership award is uniquely identied.", + "properties": { + "membershipType": { + "description": "Membership type for which awards are defined.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "awardCode": { + "description": "Membership Award Code.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "shortDescription": { + "description": "Short description of Award.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "longDescription": { + "description": "Detailed description and specification of the Award.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "ruleScheduleCode": { + "description": "Rule Schedule applied to this Award.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "billingGroup": { + "description": "The billing group that represents a billing rule schedule for the membership award.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipLevel": { + "description": "Membership level required for eligibility to receive this award. Other membership levels are not eligible for this award.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "dateRange": { + "description": "Begin date and End date of this membership award.", + "$ref": "#/definitions/dateRangeType" + }, + "inactive": { + "description": "Inactive flag for Membership Award. The award record cannot be deleted.", + "type": "boolean" + }, + "displaySequence": { + "description": "Display sequence of Award.", + "type": "number" + }, + "awardQuantity": { + "description": "Number of awards to be given.", + "type": "integer" + }, + "autoConsume": { + "description": "Indicates if award consumtion is tracked by the system. If value is Y, then system keeps track of availability of award after it is issued.", + "type": "boolean" + }, + "forceVerification": { + "description": "Force verification whether Rate or Product for the Award is valid at reservation.", + "type": "boolean" + }, + "awardBasedOn": { + "description": "Indicates if the Award is based on RATE, PRODUCT,UPGRADE,FT or OTHER.", + "$ref": "#/definitions/membershipAwardBasedOnType" + }, + "rateInfo": { + "description": "Information related to Rate based Award.", + "$ref": "#/definitions/membershipAwardRateInfoType" + }, + "productInfo": { + "description": "Information related to Product based Award.", + "$ref": "#/definitions/membershipAwardProductInfoType" + }, + "upgradeInfo": { + "description": "Information related to Upgrade based Award.", + "$ref": "#/definitions/membershipAwardUpgradeInfoType" + }, + "otherInfo": { + "description": "Information related to Other Award.", + "$ref": "#/definitions/membershipAwardOtherInfoType" + }, + "financialTransactionInfo": { + "description": "Information related to FT based Award.", + "$ref": "#/definitions/membershipAwardFinancialTransactionInfoType" + }, + "awardDetails": { + "description": "Membership Award Rate/Product/FT/Upgrade records associated with this Award.", + "$ref": "#/definitions/membershipAwardDetailsType" + } } }, - "mailingActionCodeType": { - "description": "Contains Common Master configuration detail.", + "dateRangeType": { "type": "object", + "description": "Date Range with Start and End dates.", "properties": { - "code": { - "description": "Common Master unique code.", + "start": { + "description": "The starting value of the date range.", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "end": { + "description": "The ending value of the date range.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "membershipAwardBasedOnType": { + "type": "string", + "description": "This award allows a guest to apply available membership points towards the balance of his or her bill.", + "enum": [ + "Rate", + "Product", + "Upgrade", + "Other", + "Ft" + ] + }, + "membershipAwardRateInfoType": { + "type": "object", + "description": "Membership Award cancel related details.", + "properties": { + "cancelPenaltyDays": { + "description": "If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty.", + "type": "number" }, - "displayOrder": { - "description": "Common Master record sequence number.", + "cancelPenaltyCharge": { + "description": "The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date.", "type": "number" }, - "inactive": { - "description": "Determines whether this code is inactive or not.", - "type": "boolean" + "cancelPenaltyType": { + "description": "Cancel Penalty type POINTS/PERCENT.", + "$ref": "#/definitions/membershipAwardCancelPenaltyType" + }, + "cancelPolicyType": { + "description": "Type of cancel policy - All/Nights.", + "$ref": "#/definitions/membershipAwardCancelPolicyType" + }, + "numberOfNights": { + "description": "Number of nights cancel policy is applicable.", + "type": "integer" } } }, - "mailingActionCodesCriteria": { - "description": "Request object for creating Mailing Action Codes.", + "membershipAwardCancelPenaltyType": { + "type": "string", + "description": "Penalty charge is in percentage.", + "enum": [ + "Points", + "Percent" + ] + }, + "membershipAwardCancelPolicyType": { + "type": "string", + "description": "Cancel policy is applicable only on Nights.", + "enum": [ + "All", + "Nights" + ] + }, + "membershipAwardProductInfoType": { "type": "object", + "description": "Membership Award cancel related details.", "properties": { - "links": { - "$ref": "#/definitions/links" + "cancelPenaltyDays": { + "description": "If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty.", + "type": "number" }, - "mailingActionCodes": { - "description": "Mailing Action Codes to be created.", - "$ref": "#/definitions/mailingActionCodesType" + "cancelPenaltyCharge": { + "description": "The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date.", + "type": "number" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "cancelPenaltyType": { + "description": "Cancel Penalty type POINTS/PERCENT.", + "$ref": "#/definitions/membershipAwardCancelPenaltyType" + }, + "cancelPolicyType": { + "description": "Type of cancel policy - All/Nights.", + "$ref": "#/definitions/membershipAwardCancelPolicyType" + }, + "numberOfNights": { + "description": "Number of nights cancel policy is applicable.", + "type": "integer" } } }, - "mailingActionCodesDetails": { - "description": "Response object for fetching Mailing Action Codes.", + "membershipAwardUpgradeInfoType": { "type": "object", + "description": "Membership Award cancel related details.", "properties": { - "links": { - "$ref": "#/definitions/links" + "cancelPenaltyDays": { + "description": "If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty.", + "type": "number" }, - "mailingActionCodes": { - "description": "Collection of Mailing Action Codes.", - "$ref": "#/definitions/mailingActionCodesType" + "cancelPenaltyCharge": { + "description": "The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date.", + "type": "number" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "cancelPenaltyType": { + "description": "Cancel Penalty type POINTS/PERCENT.", + "$ref": "#/definitions/membershipAwardCancelPenaltyType" + }, + "cancelPolicyType": { + "description": "Type of cancel policy - All/Nights.", + "$ref": "#/definitions/membershipAwardCancelPolicyType" + }, + "numberOfNights": { + "description": "Number of nights cancel policy is applicable.", + "type": "integer" + }, + "basedOnRoomGroup": { + "description": "Indicates if the membership award upgrade is based on room category (N) or room category group (Y).", + "type": "boolean" } } }, - "mailingActionCodesToBeChanged": { - "description": "Request object for changing Mailing Action Codes.", + "membershipAwardOtherInfoType": { "type": "object", + "description": "Information related to Other Award.", "properties": { - "links": { - "$ref": "#/definitions/links" + "pointsRequired": { + "description": "Points required to avail/redeem this award.", + "type": "number" }, - "mailingActionCodes": { - "description": "Mailing Action Codes to be changed.", - "$ref": "#/definitions/mailingActionCodesType" + "awardValue": { + "description": "The actual value of the award, in the amount of currency.", + "type": "number" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "messageLine1": { + "description": "Message for Other awards.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "messageLine2": { + "description": "Message for Other awards.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "messageLine3": { + "description": "Message for Other awards.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "messageLine4": { + "description": "Message for Other awards.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "displaySet": { + "description": "Display set for other type of awards for export purpose.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "mailingActionCodesType": { - "description": "List of Mailing Action Codes.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/mailingActionCodeType" - } - }, - "masterInfoCodeDetailType": { - "type": "string", - "enum": [ - "LongDescription", - "ShortDescription" - ] - }, - "masterInfoType": { + "membershipAwardFinancialTransactionInfoType": { "type": "object", + "description": "Information related to Other Award.", "properties": { - "codeInfo": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/codeInfoType" - } + "pointsRequired": { + "description": "Points required to avail/redeem this award.", + "type": "number" }, - "codeType": { - "$ref": "#/definitions/masterType" - } - } - }, - "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" - ] - }, - "membershipActionType": { - "description": "Type of action that the user wants to attach membership information to the reservation .", - "type": "string", - "enum": [ - "AutoPopulate", - "PromptToPopulate", - "AlwaysPrompt", - "NoAction" - ] - }, - "membershipAwardBasedOnType": { - "description": "This award allows a guest to apply available membership points towards the balance of his or her bill.", - "type": "string", - "enum": [ - "Rate", - "Product", - "Upgrade", - "Other", - "Ft" - ] - }, - "membershipAwardCancelPenaltyType": { - "description": "Penalty charge is in percentage.", - "type": "string", - "enum": [ - "Points", - "Percent" - ] + "awardValue": { + "description": "The actual value of the award, in the amount of currency.", + "type": "number" + }, + "messageLine1": { + "description": "Message for Other awards.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "messageLine2": { + "description": "Message for Other awards.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "messageLine3": { + "description": "Message for Other awards.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "messageLine4": { + "description": "Message for Other awards.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "displaySet": { + "description": "Display set for other type of awards for export purpose.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "exchangeRate": { + "description": "Exchange rate type to be used.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "maxPercentAllowed": { + "description": "Max percent of total value to be allowed to convert money to points.", + "type": "number" + }, + "ignoreFinancialTransaction": { + "description": "Ignore Financial transactions in OPERA or not? If true, Financial transaction is not required in OPERA while giving award as it may be recorded in some external system and only points accounting is done in OCIS.", + "type": "boolean" + } + } }, - "membershipAwardCancelPolicyType": { - "description": "Cancel policy is applicable only on Nights.", - "type": "string", - "enum": [ - "All", - "Nights" - ] + "membershipAwardDetailsType": { + "type": "array", + "description": "Membership Award Rate details.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipAwardDetailType" + } }, "membershipAwardDetailType": { - "description": "Values by which membership award is uniquely identied.", "type": "object", + "description": "Values by which membership award is uniquely identied.", "properties": { + "membershipType": { + "description": "Membership type for which awards are defined.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "awardCode": { "description": "Membership Award Code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "code": { - "description": "Membership Award Detail Code.", + "hotelId": { + "description": "Hotel code to which the record belongs.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "dateRange": { - "description": "Begin date and End date of this membership award upgrade.", - "$ref": "#/definitions/dateRangeType" + "minLength": 0, + "maxLength": 20 }, - "fromRoom": { - "description": "Upgrade from Room.", + "code": { + "description": "Membership Award Detail Code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "fromRoomGroup": { - "description": "Upgrade from Room Group.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "upgradeId": { + "description": "Value to uniquely identify Room/Room Group upgrade record.", + "$ref": "#/definitions/uniqueID_Type" }, "groupUpgrade": { "description": "Identify whether Room or Room Group upgrade record.", "type": "boolean" }, - "hotelId": { - "description": "Hotel code to which the record belongs.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, "inactive": { "description": "Inactive flag for Membership Award detail (Rate/Product/upgrade).", "type": "boolean" }, - "membershipType": { - "description": "Membership type for which awards are defined.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "dateRange": { + "description": "Begin date and End date of this membership award upgrade.", + "$ref": "#/definitions/dateRangeType" }, "pointsRequired": { "description": "Points required to upgrade.", "type": "number" }, + "fromRoom": { + "description": "Upgrade from Room.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "toRoom": { "description": "Upgrade to Room.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "fromRoomGroup": { + "description": "Upgrade from Room Group.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, "toRoomGroup": { "description": "Upgrade to Room Group.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "membershipAwards": { + "type": "object", + "description": "Request object for modifying membership awards.", + "properties": { + "membershipAwards": { + "description": "Collection of membership awards to be changed.", + "$ref": "#/definitions/membershipAwardsType" }, - "upgradeId": { - "description": "Value to uniquely identify Room/Room Group upgrade record.", - "$ref": "#/definitions/uniqueID_Type" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "membershipAwardDetailsType": { - "description": "Membership Award Rate details.", + "membershipBenefitProgramsInfo": { + "type": "object", + "description": "Response object for fetching membership benefit programs.", + "properties": { + "membershipBenefitPrograms": { + "description": "Collection of membership benefit programs.", + "$ref": "#/definitions/membershipBenefitProgramsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipBenefitProgramsType": { "type": "array", + "description": "Membership Benefit Program details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipAwardDetailType" + "$ref": "#/definitions/membershipBenefitProgramType" } }, - "membershipAwardFinancialTransactionInfoType": { - "description": "Information related to Other Award.", + "membershipBenefitProgramType": { "type": "object", + "description": "Type that holds key values, that uniquely identifies a membership benefit program", "properties": { - "awardValue": { - "description": "The actual value of the award, in the amount of currency.", - "type": "number" + "membershipType": { + "description": "Membership type", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "displaySet": { - "description": "Display set for other type of awards for export purpose.", + "code": { + "description": "Benefit Code", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "exchangeRate": { - "description": "Exchange rate type to be used.", + "dateRange": { + "description": "Begin date and End date of this membership benefit program.", + "$ref": "#/definitions/dateRangeType" + }, + "minimumLevel": { + "description": "Min value for membership level. This is the minimum membership level member gets for enrolling into this program.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "ignoreFinancialTransaction": { - "description": "Ignore Financial transactions in OPERA or not? If true, Financial transaction is not required in OPERA while giving award as it may be recorded in some external system and only points accounting is done in OCIS.", + "description": { + "description": "Description of the Membership Benefit Program.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "inactive": { + "description": "Flag indicates whether the Membership Benefit Program is active or not.", "type": "boolean" + } + } + }, + "membershipBenefitPrograms": { + "type": "object", + "description": "Request object for modifying membership benefit programs.", + "properties": { + "membershipBenefitPrograms": { + "description": "Collection of membership benefit programs to be changed.", + "$ref": "#/definitions/membershipBenefitProgramsType" }, - "maxPercentAllowed": { - "description": "Max percent of total value to be allowed to convert money to points.", - "type": "number" + "links": { + "$ref": "#/definitions/links" }, - "messageLine1": { - "description": "Message for Other awards.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipClaimOriginsDetails": { + "type": "object", + "description": "Response object for fetching Membership Claim Origins.", + "properties": { + "membershipClaimOrigins": { + "description": "Collection of Membership Claim Origins.", + "$ref": "#/definitions/membershipClaimOriginsType" }, - "messageLine2": { - "description": "Message for Other awards.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "messageLine3": { - "description": "Message for Other awards.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipClaimOriginsType": { + "type": "array", + "description": "List of Membership Claim Origins.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipClaimOriginType" + } + }, + "membershipClaimOriginType": { + "type": "object", + "description": "Contains Common Master configuration detail.", + "properties": { + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "messageLine4": { - "description": "Message for Other awards.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "pointsRequired": { - "description": "Points required to avail/redeem this award.", + "displayOrder": { + "description": "Common Master record sequence number.", "type": "number" } } }, - "membershipAwardGenerationMethodType": { - "description": "Type of action that generates membership award points.", - "type": "string", - "enum": [ - "Batch", - "Manual", - "System" - ] + "membershipClaimOriginsCriteria": { + "type": "object", + "description": "Request object for creating Membership Claim Origins.", + "properties": { + "membershipClaimOrigins": { + "description": "Membership Claim Origins to be created.", + "$ref": "#/definitions/membershipClaimOriginsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } }, - "membershipAwardOtherInfoType": { - "description": "Information related to Other Award.", + "membershipClaimOriginsToBeChanged": { "type": "object", + "description": "Request object for changing Membership Claim Origins.", "properties": { - "awardValue": { - "description": "The actual value of the award, in the amount of currency.", - "type": "number" + "membershipClaimOrigins": { + "description": "Membership Claim Origins to be changed.", + "$ref": "#/definitions/membershipClaimOriginsType" }, - "displaySet": { - "description": "Display set for other type of awards for export purpose.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "messageLine1": { - "description": "Message for Other awards.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipClaimTypesDetails": { + "type": "object", + "description": "Response object for fetching Membership Claim Types.", + "properties": { + "membershipClaimTypes": { + "description": "Collection of Membership Claim Types.", + "$ref": "#/definitions/membershipClaimTypesType" }, - "messageLine2": { - "description": "Message for Other awards.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "messageLine3": { - "description": "Message for Other awards.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipClaimTypesType": { + "type": "array", + "description": "List of Membership Claim Types.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipClaimTypeType" + } + }, + "membershipClaimTypeType": { + "type": "object", + "description": "Contains Common Master configuration detail.", + "properties": { + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "messageLine4": { - "description": "Message for Other awards.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "pointsRequired": { - "description": "Points required to avail/redeem this award.", + "displayOrder": { + "description": "Common Master record sequence number.", "type": "number" } } }, - "membershipAwardProductInfoType": { - "description": "Membership Award cancel related details.", + "membershipClaimTypesCriteria": { "type": "object", + "description": "Request object for creating Membership Claim Types.", "properties": { - "cancelPenaltyCharge": { - "description": "The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date.", - "type": "number" - }, - "cancelPenaltyDays": { - "description": "If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty.", - "type": "number" - }, - "cancelPenaltyType": { - "description": "Cancel Penalty type POINTS/PERCENT.", - "$ref": "#/definitions/membershipAwardCancelPenaltyType" + "membershipClaimTypes": { + "description": "Membership Claim Types to be created.", + "$ref": "#/definitions/membershipClaimTypesType" }, - "cancelPolicyType": { - "description": "Type of cancel policy - All/Nights.", - "$ref": "#/definitions/membershipAwardCancelPolicyType" + "links": { + "$ref": "#/definitions/links" }, - "numberOfNights": { - "description": "Number of nights cancel policy is applicable.", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "membershipAwardRateInfoType": { - "description": "Membership Award cancel related details.", + "membershipClaimTypesToBeChanged": { "type": "object", + "description": "Request object for changing Membership Claim Types.", "properties": { - "cancelPenaltyCharge": { - "description": "The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date.", - "type": "number" - }, - "cancelPenaltyDays": { - "description": "If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty.", - "type": "number" - }, - "cancelPenaltyType": { - "description": "Cancel Penalty type POINTS/PERCENT.", - "$ref": "#/definitions/membershipAwardCancelPenaltyType" + "membershipClaimTypes": { + "description": "Membership Claim Types to be changed.", + "$ref": "#/definitions/membershipClaimTypesType" }, - "cancelPolicyType": { - "description": "Type of cancel policy - All/Nights.", - "$ref": "#/definitions/membershipAwardCancelPolicyType" + "links": { + "$ref": "#/definitions/links" }, - "numberOfNights": { - "description": "Number of nights cancel policy is applicable.", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "membershipAwardType": { - "description": "Values by which membership award is uniquely identied.", + "membershipClassesInfo": { "type": "object", + "description": "Response object for fetching Membership Class.", "properties": { - "autoConsume": { - "description": "Indicates if award consumtion is tracked by the system. If value is Y, then system keeps track of availability of award after it is issued.", - "type": "boolean" + "membershipClasses": { + "description": "Collection of Membership Classes.", + "$ref": "#/definitions/membershipClassesType" }, - "awardBasedOn": { - "description": "Indicates if the Award is based on RATE, PRODUCT,UPGRADE,FT or OTHER.", - "$ref": "#/definitions/membershipAwardBasedOnType" + "links": { + "$ref": "#/definitions/links" }, - "awardCode": { - "description": "Membership Award Code.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipClassesType": { + "type": "array", + "description": "List of the Membership Class to be configured or fetched", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipClassType" + } + }, + "membershipClassType": { + "type": "object", + "description": "Base type provides information about Membership Market/Property Groups Configuration.", + "properties": { + "code": { + "description": "Code is used to identify a Membership Market/Resort Group.", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "awardDetails": { - "description": "Membership Award Rate/Product/FT/Upgrade records associated with this Award.", - "$ref": "#/definitions/membershipAwardDetailsType" - }, - "awardQuantity": { - "description": "Number of awards to be given.", - "type": "integer" + "minLength": 0, + "maxLength": 20 }, - "billingGroup": { - "description": "The billing group that represents a billing rule schedule for the membership award.", + "description": { + "description": "Description of the Membership Market/Propety Group.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "dateRange": { - "description": "Begin date and End date of this membership award.", - "$ref": "#/definitions/dateRangeType" + "minLength": 0, + "maxLength": 2000 }, "displaySequence": { - "description": "Display sequence of Award.", + "description": "Membership Market/Property Groups display sequence Number", "type": "number" }, - "financialTransactionInfo": { - "description": "Information related to FT based Award.", - "$ref": "#/definitions/membershipAwardFinancialTransactionInfoType" - }, - "forceVerification": { - "description": "Force verification whether Rate or Product for the Award is valid at reservation.", + "loyaltyProgram": { + "description": "This flag indicates whether the membership class is eligible for loyalty program or not.", "type": "boolean" }, - "inactive": { - "description": "Inactive flag for Membership Award. The award record cannot be deleted.", + "frequentFlyer": { + "description": "This flag indicates whether the membership class is eligible for frequent flyer or not.", "type": "boolean" + } + } + }, + "membershipClasses": { + "type": "object", + "description": "Request object for changing Membership Class.", + "properties": { + "membershipClasses": { + "description": "Details of the Membership Classes to be edited.", + "$ref": "#/definitions/membershipClassesType" }, - "longDescription": { - "description": "Detailed description and specification of the Award.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "membershipLevel": { - "description": "Membership level required for eligibility to receive this award. Other membership levels are not eligible for this award.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "membershipType": { - "description": "Membership type for which awards are defined.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "otherInfo": { - "description": "Information related to Other Award.", - "$ref": "#/definitions/membershipAwardOtherInfoType" - }, - "productInfo": { - "description": "Information related to Product based Award.", - "$ref": "#/definitions/membershipAwardProductInfoType" - }, - "rateInfo": { - "description": "Information related to Rate based Award.", - "$ref": "#/definitions/membershipAwardRateInfoType" + "links": { + "$ref": "#/definitions/links" }, - "ruleScheduleCode": { - "description": "Rule Schedule applied to this Award.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipEnrollmentCodesDetails": { + "type": "object", + "description": "Response object for fetching Membership Enrollment Codes.", + "properties": { + "membershipEnrollmentCodes": { + "description": "Collection of Membership Enrollment Codes.", + "$ref": "#/definitions/membershipEnrollmentCodesType" }, - "shortDescription": { - "description": "Short description of Award.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "upgradeInfo": { - "description": "Information related to Upgrade based Award.", - "$ref": "#/definitions/membershipAwardUpgradeInfoType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "membershipAwardUpgradeInfoType": { - "description": "Membership Award cancel related details.", + "membershipEnrollmentCodesType": { + "type": "array", + "description": "List of Membership Enrollment Codes.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipEnrollmentCodeType" + } + }, + "membershipEnrollmentCodeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "basedOnRoomGroup": { - "description": "Indicates if the membership award upgrade is based on room category (N) or room category group (Y).", - "type": "boolean" + "code": { + "description": "Common Master unique code.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "cancelPenaltyCharge": { - "description": "The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date.", - "type": "number" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "cancelPenaltyDays": { - "description": "If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty.", + "displayOrder": { + "description": "Common Master record sequence number.", "type": "number" + } + } + }, + "membershipEnrollmentCodesCriteria": { + "type": "object", + "description": "Request object for creating Membership Enrollment Codes.", + "properties": { + "membershipEnrollmentCodes": { + "description": "Membership Enrollment Codes to be created.", + "$ref": "#/definitions/membershipEnrollmentCodesType" }, - "cancelPenaltyType": { - "description": "Cancel Penalty type POINTS/PERCENT.", - "$ref": "#/definitions/membershipAwardCancelPenaltyType" - }, - "cancelPolicyType": { - "description": "Type of cancel policy - All/Nights.", - "$ref": "#/definitions/membershipAwardCancelPolicyType" - }, - "numberOfNights": { - "description": "Number of nights cancel policy is applicable.", - "type": "integer" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "membershipAwards": { - "description": "Request object for modifying membership awards.", + "membershipEnrollmentCodesToBeChanged": { "type": "object", + "description": "Request object for changing Membership Enrollment Codes.", "properties": { + "membershipEnrollmentCodes": { + "description": "Membership Enrollment Codes to be changed.", + "$ref": "#/definitions/membershipEnrollmentCodesType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipAwards": { - "description": "Collection of membership awards to be changed.", - "$ref": "#/definitions/membershipAwardsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipAwardsInfo": { - "description": "Response to fetch Membership Awards.", + "membershipEnrollmentGroupsInfo": { "type": "object", + "description": "Response object for fetching membership enrollment groups.", "properties": { + "membershipEnrollmentGroups": { + "description": "Collection of membership enrollment groups.", + "$ref": "#/definitions/membershipEnrollmentGroupsType" + }, + "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" }, - "membershipAwards": { - "description": "Collection of Membership Awards.", - "$ref": "#/definitions/membershipAwardsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipAwardsType": { - "description": "Membership Award details.", + "membershipEnrollmentGroupsType": { "type": "array", + "description": "Details of membership enrollment group type.", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipAwardType" + "$ref": "#/definitions/membershipEnrollmentGroupType" } }, - "membershipBenefitProgramType": { - "description": "Type that holds key values, that uniquely identifies a membership benefit program", + "membershipEnrollmentGroupType": { "type": "object", + "description": "Base type provides information about Membership Market/Property Groups Configuration.", "properties": { "code": { - "description": "Benefit Code", + "description": "Code is used to identify a Membership Market/Resort Group.", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "dateRange": { - "description": "Begin date and End date of this membership benefit program.", - "$ref": "#/definitions/dateRangeType" + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the Membership Benefit Program.", + "description": "Description of the Membership Market/Propety Group.", "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "inactive": { - "description": "Flag indicates whether the Membership Benefit Program is active or not.", - "type": "boolean" + "minLength": 0, + "maxLength": 2000 }, - "membershipType": { - "description": "Membership type", - "type": "string", - "maxLength": 20, - "minLength": 0 + "displaySequence": { + "description": "Membership Market/Property Groups display sequence Number", + "type": "number" }, - "minimumLevel": { - "description": "Min value for membership level. This is the minimum membership level member gets for enrolling into this program.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "enrollmentCodes": { + "description": "Collection of code and description of enrollment codes that are associated to the membership enrollment group.", + "$ref": "#/definitions/membershipEnrollmentCodesInfoType" } } }, - "membershipBenefitPrograms": { - "description": "Request object for modifying membership benefit programs.", + "membershipEnrollmentCodesInfoType": { + "type": "array", + "description": "Membership enrollment code code and description.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeDescriptionType" + } + }, + "membershipEnrollmentGroups": { "type": "object", + "description": "Request object for changing new membership enrollment groups.", "properties": { + "membershipEnrollmentGroups": { + "description": "Collection of membership enrollment groups.", + "$ref": "#/definitions/membershipEnrollmentGroupsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipBenefitPrograms": { - "description": "Collection of membership benefit programs to be changed.", - "$ref": "#/definitions/membershipBenefitProgramsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipBenefitProgramsInfo": { - "description": "Response object for fetching membership benefit programs.", + "membershipFolioTexts": { "type": "object", + "description": "Collection of FolioTexts to be inserted at MembershipLevel.", "properties": { + "membershipFolioTexts": { + "type": "array", + "items": { + "$ref": "#/definitions/membershipFolioTextsType" + } + }, "links": { "$ref": "#/definitions/links" }, - "membershipBenefitPrograms": { - "description": "Collection of membership benefit programs.", - "$ref": "#/definitions/membershipBenefitProgramsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipBenefitProgramsType": { - "description": "Membership Benefit Program details.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipBenefitProgramType" - } - }, - "membershipCardValidationRuleType": { - "description": "Payment method card validation rules.", + "membershipFolioTextsType": { "type": "object", + "description": "A type which is used to insert Membership FolioTexts.", "properties": { - "formula": { - "description": "Formula used for card validation. Only valid in case of user defined validation.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "length": { - "description": "Valid lengths of card number.", + "membershipType": { + "description": "Membership Type code.", "type": "string", - "maxLength": 50, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "prefix": { - "description": "Valid card number prefix.", + "membershipLevel": { + "description": "Membership Level code.", "type": "string", - "maxLength": 50, - "minLength": 0 - }, - "ranges": { - "description": "Collection of card number ranges.", - "$ref": "#/definitions/cardRangesType" + "minLength": 0, + "maxLength": 20 }, - "rule": { - "description": "Defines rules to be used for membership card validation.", - "$ref": "#/definitions/membershipCardValidationRuleTypeType" + "folioTexts": { + "description": "Folio Texts.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelFolioTextsType" + } } } }, - "membershipCardValidationRuleTypeType": { - "description": "Defines rules to be used for card validation.", - "type": "string", - "enum": [ - "Mod7", - "Mod10", - "Udef", - "Novalid", - "Internal", - "External" - ] + "hotelFolioTextsType": { + "type": "array", + "description": "Collection of hotel folio texts", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelFolioTextType" + } }, - "membershipClaimOriginType": { - "description": "Contains Common Master configuration detail.", + "hotelFolioTextType": { "type": "object", + "description": "Folio text", "properties": { - "code": { - "description": "Common Master unique code.", + "folioText1": { "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 400 }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "folioText2": { + "type": "string", + "minLength": 0, + "maxLength": 400 }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "membershipClaimOriginsCriteria": { - "description": "Request object for creating Membership Claim Origins.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "folioText3": { + "type": "string", + "minLength": 0, + "maxLength": 400 }, - "membershipClaimOrigins": { - "description": "Membership Claim Origins to be created.", - "$ref": "#/definitions/membershipClaimOriginsType" + "folioText4": { + "type": "string", + "minLength": 0, + "maxLength": 400 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "hotelId": { + "description": "Signifies folio text for a specific hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "membershipClaimOriginsDetails": { - "description": "Response object for fetching Membership Claim Origins.", + "membershipLevelsInfo": { "type": "object", + "description": "Response object for fetching membership levels.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "membershipClaimOrigins": { - "description": "Collection of Membership Claim Origins.", - "$ref": "#/definitions/membershipClaimOriginsType" + "membershipLevels": { + "description": "Collection of membership levels.", + "$ref": "#/definitions/membershipLevelsType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipClaimOriginsToBeChanged": { - "description": "Request object for changing Membership Claim Origins.", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "membershipClaimOrigins": { - "description": "Membership Claim Origins to be changed.", - "$ref": "#/definitions/membershipClaimOriginsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipClaimOriginsType": { - "description": "List of Membership Claim Origins.", + "membershipLevelsType": { "type": "array", + "description": "Collection of membership levels", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipClaimOriginType" + "$ref": "#/definitions/membershipLevelType" } }, - "membershipClaimTypeType": { - "description": "Contains Common Master configuration detail.", + "membershipLevelType": { "type": "object", + "description": "A Type that holds key values, that uniquely identifies a membership level", "properties": { + "type": { + "description": "Membership type", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "code": { - "description": "Common Master unique code.", + "description": "Membership level", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "description": "Description of the Membership level.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "displayOrder": { - "description": "Common Master record sequence number.", + "label": { + "description": "Label of the Membership level.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "rank": { + "description": "Rank of Membership level.", "type": "number" - } - } - }, - "membershipClaimTypesCriteria": { - "description": "Request object for creating Membership Claim Types.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" }, - "membershipClaimTypes": { - "description": "Membership Claim Types to be created.", - "$ref": "#/definitions/membershipClaimTypesType" + "vip": { + "description": "VIP level associated to the Membership level.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "displayColor": { + "description": "Display Colour of Membership level.", + "$ref": "#/definitions/colorType" + }, + "inactive": { + "description": "Inactive flag for a Membership level.", + "type": "boolean" + }, + "folioTexts": { + "description": "Folio text for a specific membership type level for hotels in the chain.", + "$ref": "#/definitions/hotelFolioTextsType" + }, + "fulfillment": { + "description": "Indicates whether memberships upgraded or downgraded to or from this level will be included in the Membership Export.", + "type": "boolean" + }, + "changesRestricted": { + "description": "Indicates whether memberships level is restricted to prevent users from making changes to it.", + "type": "boolean" + }, + "autoRenewGrace": { + "description": "Select the number of graces the member will be allowed before the membership level auto-renews based on the member current points. It is available when the Tier Management Reset option is selected on Membership Type.", + "type": "integer" + }, + "cardValidYears": { + "description": "Specify the time limit (from 1 to 5 years) for membership card expiration for this level", + "type": "integer" + }, + "restrictedLevel": { + "description": "Indicates whether memberships level is restricted to prevent users from making changes to it. It is available when the Advanced Enrollment option is selected on Membership Type.", + "type": "boolean" + }, + "renewCard": { + "description": "Indicates whether membership has expired by the time the membership record is uploaded, the members card will be renewed and updated with a new expiration date.", + "type": "boolean" + }, + "feeRequired": { + "description": "Indicates whether membership fee payment is required upon upgrade to this membership level.", + "type": "boolean" + }, + "maxDowngradeLevel": { + "description": "The lowest level in which this level can be downgraded to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "numberOfTransactions": { + "description": "Number of transaction(s) for each stay. Value will be 2 in case of double dipping otherwise it will be null or 1.", + "type": "integer" } } }, - "membershipClaimTypesDetails": { - "description": "Response object for fetching Membership Claim Types.", + "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" + ] + }, + "membershipLevels": { "type": "object", + "description": "Request object for modifying membership levels.", "properties": { + "membershipLevels": { + "description": "Collection of membership levels to be changed.", + "$ref": "#/definitions/membershipLevelsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipClaimTypes": { - "description": "Collection of Membership Claim Types.", - "$ref": "#/definitions/membershipClaimTypesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipClaimTypesToBeChanged": { - "description": "Request object for changing Membership Claim Types.", + "membershipMarketGroupsInfo": { "type": "object", + "description": "Response object for fetching Membership Market Groups configurations.", "properties": { + "membershipMarketGroups": { + "description": "Collection of Membership Market Groups configurations.", + "$ref": "#/definitions/membershipMarketGroupsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipClaimTypes": { - "description": "Membership Claim Types to be changed.", - "$ref": "#/definitions/membershipClaimTypesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipClaimTypesType": { - "description": "List of Membership Claim Types.", + "membershipMarketGroupsType": { "type": "array", + "description": "Details for Membership Market Group along with associated Market codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipClaimTypeType" + "$ref": "#/definitions/membershipMarketGroupType" } }, - "membershipClassType": { - "description": "Base type provides information about Membership Market/Property Groups Configuration.", + "membershipMarketGroupType": { "type": "object", + "description": "Base type provides information about Membership Market/Property Groups Configuration.", "properties": { "code": { "description": "Code is used to identify a Membership Market/Resort Group.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, "displaySequence": { "description": "Membership Market/Property Groups display sequence Number", "type": "number" }, - "frequentFlyer": { - "description": "This flag indicates whether the membership class is eligible for frequent flyer or not.", - "type": "boolean" - }, - "loyaltyProgram": { - "description": "This flag indicates whether the membership class is eligible for loyalty program or not.", - "type": "boolean" + "marketCodes": { + "description": "Collection of Market codes which associated for a Membership Market Group.", + "$ref": "#/definitions/membershipMarketCodesType" } } }, - "membershipClasses": { - "description": "Request object for changing Membership Class.", + "membershipMarketCodesType": { + "type": "array", + "description": "Membership Markets code and Description.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeDescriptionType" + } + }, + "membershipMarketGroups": { "type": "object", + "description": "Request object for changing existing Membership Market Groups Configurations.", "properties": { + "membershipMarketGroups": { + "description": "Membership Market Groups Configurations to be changed.", + "$ref": "#/definitions/membershipMarketGroupsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipClasses": { - "description": "Details of the Membership Classes to be edited.", - "$ref": "#/definitions/membershipClassesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipClassesInfo": { - "description": "Response object for fetching Membership Class.", + "membershipPropertyGroupsInfo": { "type": "object", + "description": "Response object for fetching Membership Property Groups configurations.", "properties": { + "membershipPropertyGroups": { + "description": "Collection of Membership Property Groups configurations.", + "$ref": "#/definitions/membershipPropertyGroupsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipClasses": { - "description": "Collection of Membership Classes.", - "$ref": "#/definitions/membershipClassesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipClassesType": { - "description": "List of the Membership Class to be configured or fetched", + "membershipPropertyGroupsType": { "type": "array", + "description": "Details for Membership Property Group along with associated property codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipClassType" + "$ref": "#/definitions/membershipPropertyGroupType" } }, - "membershipEnrollmentCodeType": { - "description": "Contains Common Master configuration detail.", + "membershipPropertyGroupType": { "type": "object", + "description": "Base type provides information about Membership Market/Property Groups Configuration.", "properties": { "code": { - "description": "Common Master unique code.", + "description": "Code is used to identify a Membership Market/Resort Group.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "description": "Description of the Membership Market/Propety Group.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "displayOrder": { - "description": "Common Master record sequence number.", + "displaySequence": { + "description": "Membership Market/Property Groups display sequence Number", "type": "number" + }, + "hotels": { + "description": "Collection of property codes which associated for a Membership Property Group.", + "$ref": "#/definitions/membershipPropertyCodesType" } } }, - "membershipEnrollmentCodesCriteria": { - "description": "Request object for creating Membership Enrollment Codes.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "membershipEnrollmentCodes": { - "description": "Membership Enrollment Codes to be created.", - "$ref": "#/definitions/membershipEnrollmentCodesType" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "membershipPropertyCodesType": { + "type": "array", + "description": "Membership Property code and Description.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeDescriptionType" } }, - "membershipEnrollmentCodesDetails": { - "description": "Response object for fetching Membership Enrollment Codes.", + "membershipPropertyGroups": { "type": "object", + "description": "Request object for changing existing Membership Property Groups Configurations.", "properties": { + "membershipPropertyGroups": { + "description": "Membership Property Groups Configurations to be changed.", + "$ref": "#/definitions/membershipPropertyGroupsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipEnrollmentCodes": { - "description": "Collection of Membership Enrollment Codes.", - "$ref": "#/definitions/membershipEnrollmentCodesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipEnrollmentCodesInfoType": { - "description": "Membership enrollment code code and description.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/codeDescriptionType" - } - }, - "membershipEnrollmentCodesToBeChanged": { - "description": "Request object for changing Membership Enrollment Codes.", + "membershipRateGroupsInfo": { "type": "object", + "description": "Response object for fetching Membership Rate Groups.", "properties": { + "membershipRateGroups": { + "description": "Collection of Membership Rate Group.", + "$ref": "#/definitions/membershipRateGroupsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipEnrollmentCodes": { - "description": "Membership Enrollment Codes to be changed.", - "$ref": "#/definitions/membershipEnrollmentCodesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipEnrollmentCodesType": { - "description": "List of Membership Enrollment Codes.", + "membershipRateGroupsType": { "type": "array", + "description": "Details for Membership Rate Group.", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipEnrollmentCodeType" + "$ref": "#/definitions/membershipRateGroupType" } }, - "membershipEnrollmentGroupType": { - "description": "Base type provides information about Membership Market/Property Groups Configuration.", + "membershipRateGroupType": { "type": "object", + "description": "Base type provides information about Membership Market/Property Groups Configuration.", "properties": { "code": { "description": "Code is used to identify a Membership Market/Resort Group.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, "displaySequence": { "description": "Membership Market/Property Groups display sequence Number", "type": "number" }, - "enrollmentCodes": { - "description": "Collection of code and description of enrollment codes that are associated to the membership enrollment group.", - "$ref": "#/definitions/membershipEnrollmentCodesInfoType" + "rateCodes": { + "description": "Collection of Rate codes associated with this Rate Group.", + "$ref": "#/definitions/membershipRateCodesType" } } }, - "membershipEnrollmentGroups": { - "description": "Request object for changing new membership enrollment groups.", + "membershipRateCodesType": { + "type": "array", + "description": "Membership Rates code and Description.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeDescriptionType" + } + }, + "membershipRateGroups": { "type": "object", + "description": "Request object for modifying Membership Rate Groups.", "properties": { + "membershipRateGroups": { + "description": "Collection of Membership Rate Groups to be changed.", + "$ref": "#/definitions/membershipRateGroupsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipEnrollmentGroups": { - "description": "Collection of membership enrollment groups.", - "$ref": "#/definitions/membershipEnrollmentGroupsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipEnrollmentGroupsInfo": { - "description": "Response object for fetching membership enrollment groups.", + "membershipStatusCodesDetails": { "type": "object", + "description": "Response object for fetching Membership Status Codes.", "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "membershipStatusCodes": { + "description": "Collection of Membership Status Codes.", + "$ref": "#/definitions/membershipStatusCodesType" }, "links": { "$ref": "#/definitions/links" }, - "membershipEnrollmentGroups": { - "description": "Collection of membership enrollment groups.", - "$ref": "#/definitions/membershipEnrollmentGroupsType" - }, - "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" - }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipEnrollmentGroupsType": { - "description": "Details of membership enrollment group type.", + "membershipStatusCodesType": { "type": "array", + "description": "List of Membership Status Codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipEnrollmentGroupType" - } - }, - "membershipFolioTexts": { - "description": "Collection of FolioTexts to be inserted at MembershipLevel.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "membershipFolioTexts": { - "type": "array", - "items": { - "$ref": "#/definitions/membershipFolioTextsType" - } - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipFolioTextsType": { - "description": "A type which is used to insert Membership FolioTexts.", - "type": "object", - "properties": { - "folioTexts": { - "description": "Folio Texts.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelFolioTextsType" - } - }, - "membershipLevel": { - "description": "Membership Level code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "membershipType": { - "description": "Membership Type code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "membershipHandlingType": { - "description": "Represents the way a membership type has to be processed.", - "type": "object", - "properties": { - "allowCardNumberOverride": { - "description": "Indicates whether to perform profile merge or not.", - "type": "boolean" - }, - "alternateNameProtected": { - "description": "Prevent profile alternate name change.", - "type": "boolean" - }, - "autoGenerateReferenceNo": { - "description": "Automatically generate the reference number for the primary membership.", - "type": "boolean" - }, - "autoPopulateNumberFromName": { - "description": "Automatically populate number from name.", - "type": "boolean" - }, - "defaultMembershipStatus": { - "description": "Represents Membership status.This status will be assigned to Guest's profile with membership type.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "enrollmentCodeRequired": { - "description": "Indicates whether Enrollment Code required of not.", - "type": "boolean" - }, - "externalDatabase": { - "description": "Indicates database for external system (if applicable).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "fulfillment": { - "description": "True if you wish to be able to select this membership type when creating an export file for fulfillment.", - "type": "boolean" - }, - "levelRequired": { - "description": "Indicates whether to include membership level for validation or not , when profile membership information is send from External System to ORS/OCIS.", - "type": "boolean" - }, - "moveMemPromotions": { - "description": "Move the membership promotions to the active membership.", - "type": "boolean" - }, - "nameOnCardFromAltName": { - "description": "Membership card name using the alternate name.", - "type": "boolean" - }, - "nameProtected": { - "description": "Prevent profile name change.", - "type": "boolean" - }, - "saveCardNumberHistory": { - "description": "Indicates whether to store discard membership number or not.Membership Number will be discarded during profile merge.", - "type": "boolean" - }, - "statementUDFSet": { - "description": "Represents Membership Statement UDF Set. Selected Statement UDF template will be attached to Membership.", - "type": "string", - "maxLength": 40, - "minLength": 0 - } + "$ref": "#/definitions/membershipStatusCodeType" } }, - "membershipLevelType": { - "description": "A Type that holds key values, that uniquely identifies a membership level", + "membershipStatusCodeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "autoRenewGrace": { - "description": "Select the number of graces the member will be allowed before the membership level auto-renews based on the member current points. It is available when the Tier Management Reset option is selected on Membership Type.", - "type": "integer" - }, - "cardValidYears": { - "description": "Specify the time limit (from 1 to 5 years) for membership card expiration for this level", - "type": "integer" - }, - "changesRestricted": { - "description": "Indicates whether memberships level is restricted to prevent users from making changes to it.", - "type": "boolean" - }, "code": { - "description": "Membership level", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "description": { - "description": "Description of the Membership level.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "displayColor": { - "description": "Display Colour of Membership level.", - "$ref": "#/definitions/colorType" - }, - "feeRequired": { - "description": "Indicates whether membership fee payment is required upon upgrade to this membership level.", - "type": "boolean" - }, - "folioTexts": { - "description": "Folio text for a specific membership type level for hotels in the chain.", - "$ref": "#/definitions/hotelFolioTextsType" - }, - "fulfillment": { - "description": "Indicates whether memberships upgraded or downgraded to or from this level will be included in the Membership Export.", - "type": "boolean" - }, - "inactive": { - "description": "Inactive flag for a Membership level.", - "type": "boolean" - }, - "label": { - "description": "Label of the Membership level.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "maxDowngradeLevel": { - "description": "The lowest level in which this level can be downgraded to.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "numberOfTransactions": { - "description": "Number of transaction(s) for each stay. Value will be 2 in case of double dipping otherwise it will be null or 1.", - "type": "integer" - }, - "rank": { - "description": "Rank of Membership level.", - "type": "number" - }, - "renewCard": { - "description": "Indicates whether membership has expired by the time the membership record is uploaded, the members card will be renewed and updated with a new expiration date.", - "type": "boolean" - }, - "restrictedLevel": { - "description": "Indicates whether memberships level is restricted to prevent users from making changes to it. It is available when the Advanced Enrollment option is selected on Membership Type.", - "type": "boolean" - }, - "type": { - "description": "Membership type", + "description": "Common Master unique code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "vip": { - "description": "VIP level associated to the Membership level.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" + }, + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "membershipLevels": { - "description": "Request object for modifying membership levels.", + "membershipStatusCodesCriteria": { "type": "object", + "description": "Request object for creating Membership Status Codes.", "properties": { + "membershipStatusCodes": { + "description": "Membership Status Codes to be created.", + "$ref": "#/definitions/membershipStatusCodesType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipLevels": { - "description": "Collection of membership levels to be changed.", - "$ref": "#/definitions/membershipLevelsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipLevelsInfo": { - "description": "Response object for fetching membership levels.", + "membershipStatusCodesToBeChanged": { "type": "object", + "description": "Request object for changing Membership Status Codes.", "properties": { + "membershipStatusCodes": { + "description": "Membership Status Codes to be changed.", + "$ref": "#/definitions/membershipStatusCodesType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipLevels": { - "description": "Collection of membership levels.", - "$ref": "#/definitions/membershipLevelsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipLevelsType": { - "description": "Collection of membership levels", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipLevelType" + "membershipTypeRulesInfo": { + "type": "object", + "description": "Response object for fetching membership type rules.", + "properties": { + "membershipTypeRules": { + "description": "Collection of membership type rules summary.", + "$ref": "#/definitions/membershipTypeRulesSummariesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "membershipMarketCodesType": { - "description": "Membership Markets code and Description.", + "membershipTypeRulesSummariesType": { "type": "array", + "description": "List of Membership type rules summary information.", "maxItems": 4000, "items": { - "$ref": "#/definitions/codeDescriptionType" + "$ref": "#/definitions/membershipTypeRuleSummaryType" } }, - "membershipMarketGroupType": { - "description": "Base type provides information about Membership Market/Property Groups Configuration.", + "membershipTypeRuleSummaryType": { "type": "object", + "description": "Membership Type rule summary information.", "properties": { - "code": { - "description": "Code is used to identify a Membership Market/Resort Group.", + "membershipTypeRulePrimaryDetails": { + "description": "Membership type rule primary information.", + "$ref": "#/definitions/membershipTypeRulePrimaryDetailsType" + }, + "ruleCode": { + "description": "Rule code of the membership type rule.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "programType": { + "description": "Program(Points/Tier) type of the rule.", + "$ref": "#/definitions/membershipTypeRuleType" + } + } + }, + "membershipTypeRulePrimaryDetailsType": { + "type": "object", + "description": "Membership Type rule primary information.", + "properties": { + "membershipTypeRuleId": { + "description": "Membership type rule ID details.", + "$ref": "#/definitions/membershipTypeRuleIDType" }, "description": { - "description": "Description of the Membership Market/Propety Group.", + "description": "Description of the rule.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "displaySequence": { - "description": "Membership Market/Property Groups display sequence Number", - "type": "number" + "ruleBasedOn": { + "description": "Calculation rule name of the type rule. Determines whether this Membership generates points based on guest Revenue, Stays, Nights, Enrolment.", + "$ref": "#/definitions/membershipTypeRuleBasedOnType" }, - "marketCodes": { - "description": "Collection of Market codes which associated for a Membership Market Group.", - "$ref": "#/definitions/membershipMarketCodesType" + "ruleStartDate": { + "description": "Start date indicates the begin date for this points calculation rule.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "ruleEndDate": { + "description": "End date for this points calculation rule.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "pointsType": { + "description": "Specifies if points are BASE or BONUS.", + "$ref": "#/definitions/rulePointsTypeType" + }, + "inactiveDate": { + "description": "The date that Membership type rule is marked as inactive.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "transactionCode": { + "description": "Tranaction code for membership type rule. e.g. Resident, Non Resident", + "$ref": "#/definitions/membershipTypeRuleTransactionCodeType" } } }, - "membershipMarketGroups": { - "description": "Request object for changing existing Membership Market Groups Configurations.", + "membershipTypeRuleIDType": { "type": "object", + "description": "Membership type rule ID.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "membershipMarketGroups": { - "description": "Membership Market Groups Configurations to be changed.", - "$ref": "#/definitions/membershipMarketGroupsType" + "membershipType": { + "description": "Membership type of the Rule.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "membershipPointsSequence": { + "description": "Sequence number of the membership type rule.", + "type": "integer" } } }, - "membershipMarketGroupsInfo": { - "description": "Response object for fetching Membership Market Groups configurations.", + "membershipTypeRuleBasedOnType": { + "type": "string", + "description": "Indicates Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score.", + "enum": [ + "Revenue", + "Stay", + "Nights", + "Enrollment", + "TierUpgrade", + "Renewal", + "Rfm" + ] + }, + "rulePointsTypeType": { + "type": "string", + "description": "Possible membership points types.", + "enum": [ + "Base", + "Bonus" + ] + }, + "membershipTypeRuleTransactionCodeType": { + "type": "string", + "description": "Determines the Transaction Code for Membership program rule.", + "enum": [ + "Resident", + "NonResident" + ] + }, + "membershipTypeRuleType": { + "type": "string", + "description": "Membership Type/Program rule types.", + "enum": [ + "All", + "Points", + "Tier" + ] + }, + "membershipTypeRules": { "type": "object", + "description": "Request object for changing membership type rules.", "properties": { + "membershipTypeRules": { + "description": "Collection of membership type rules to be changed.", + "$ref": "#/definitions/membershipTypeRuleDetailsType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipMarketGroups": { - "description": "Collection of Membership Market Groups configurations.", - "$ref": "#/definitions/membershipMarketGroupsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipMarketGroupsType": { - "description": "Details for Membership Market Group along with associated Market codes.", + "membershipTypeRuleDetailsType": { "type": "array", + "description": "Collection of Membership type rule details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipMarketGroupType" + "$ref": "#/definitions/membershipTypeRuleDetailType" } }, - "membershipPropertyCodesType": { - "description": "Membership Property code and Description.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/codeDescriptionType" + "membershipTypeRuleDetailType": { + "type": "object", + "description": "Membership type Rule details.", + "properties": { + "rulePrimaryDetails": { + "description": "Membership type rule summary information.", + "$ref": "#/definitions/membershipTypeRulePrimaryDetailsType" + }, + "ruleDefinition": { + "description": "Membership type rule definition details.", + "$ref": "#/definitions/membershipTypeRuleDefinitionType" + }, + "rulePointsDefinition": { + "description": "Membership Type rule points definition details.", + "$ref": "#/definitions/membershipTypeRulePointsDefinitionType" + }, + "ruleConditions": { + "description": "Membership Type rule conditions details.", + "$ref": "#/definitions/membershipTypeRuleConditionsType" + } } }, - "membershipPropertyGroupType": { - "description": "Base type provides information about Membership Market/Property Groups Configuration.", + "membershipTypeRuleDefinitionType": { "type": "object", + "description": "Membership Type Rule definition details.", "properties": { - "code": { - "description": "Code is used to identify a Membership Market/Resort Group.", + "ruleCode": { + "description": "Rule code of the membership type rule.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description of the Membership Market/Propety Group.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "programType": { + "description": "Program(Points/Tier) type of the rule.", + "$ref": "#/definitions/membershipTypeRuleType" }, - "displaySequence": { - "description": "Membership Market/Property Groups display sequence Number", - "type": "number" + "ruleAppliesOn": { + "description": "Rule applies on Reservation Arrival Date, Reservation Departure Date, Any date during stay or RestrictedDates.", + "$ref": "#/definitions/ruleAppliesOnType" }, - "hotels": { - "description": "Collection of property codes which associated for a Membership Property Group.", - "$ref": "#/definitions/membershipPropertyCodesType" + "noOfTimesEligible": { + "description": "Specifies total number of times program rule is eligible .", + "type": "integer" + }, + "ruleExportLabel": { + "description": "This field will be used to store export label and will be used only for exporting purposes.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "ruleExpirationDate": { + "description": "Date on which the rule will be expired.", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "membershipPropertyGroups": { - "description": "Request object for changing existing Membership Property Groups Configurations.", + "ruleAppliesOnType": { + "type": "string", + "description": "Applies on restricted dates.", + "enum": [ + "Arrival", + "Departure", + "Any", + "Restricted" + ] + }, + "membershipTypeRulePointsDefinitionType": { "type": "object", + "description": "Membership Program Rule points details.", "properties": { - "links": { - "$ref": "#/definitions/links" + "points": { + "description": "Specifies the ratio of the points accumulated per Stay or Night or Revenue. This ratio multiplied by the actual Stays or Nights or Revenue will give the Total points accumulated.", + "type": "integer" }, - "membershipPropertyGroups": { - "description": "Membership Property Groups Configurations to be changed.", - "$ref": "#/definitions/membershipPropertyGroupsType" + "costPerPoint": { + "description": "Indicates the cost per point for this membership program.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "revenueUnits": { + "description": "Specifies the minimum units needed.", + "type": "integer" + }, + "pointsRoundingFlag": { + "description": "This flag tells if the total amount computed will be rounded, rounded up or rounded down.", + "$ref": "#/definitions/pointsRoundingFlagType" + }, + "percentagePoints": { + "description": "Points ratio is expressed in terms of %.", + "type": "boolean" + }, + "excludePointProjection": { + "description": "Determines while calculating points projection should the rule be excluded or included. Default is included(N).", + "type": "boolean" } } }, - "membershipPropertyGroupsInfo": { - "description": "Response object for fetching Membership Property Groups configurations.", + "pointsRoundingFlagType": { + "type": "string", + "description": "This flag tells if the total amount computed will be rounded, rounded up or rounded down.", + "enum": [ + "Round", + "Ceil", + "Floor" + ] + }, + "membershipTypeRuleConditionsType": { "type": "object", + "description": "Membership Type Rule Conditions.", "properties": { - "links": { - "$ref": "#/definitions/links" + "generalConditions": { + "description": "Specifies the General Conditions to apply the rules.", + "$ref": "#/definitions/membershipTypeRuleGeneralConditionsType" }, - "membershipPropertyGroups": { - "description": "Collection of Membership Property Groups configurations.", - "$ref": "#/definitions/membershipPropertyGroupsType" + "rateConditions": { + "description": "Specifies the Rate code Conditions to apply the rules.", + "$ref": "#/definitions/membershipTypeRuleRateConditionsType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "roomConditions": { + "description": "Specifies the Room Conditions to apply the rules.", + "$ref": "#/definitions/membershipTypeRuleRoomConditionsType" + }, + "segmentationConditions": { + "description": "Specifies the Segmentation Conditions to apply the rules.", + "$ref": "#/definitions/membershipTypeRuleSegmentationConditionsType" + }, + "reservationConditions": { + "description": "Specifies the Reservation Conditions to apply the rules.", + "$ref": "#/definitions/membershipTypeRuleReservationConditionsType" } } }, - "membershipPropertyGroupsType": { - "description": "Details for Membership Property Group along with associated property codes.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipPropertyGroupType" - } - }, - "membershipRateCodesType": { - "description": "Membership Rates code and Description.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/codeDescriptionType" - } - }, - "membershipRateGroupType": { - "description": "Base type provides information about Membership Market/Property Groups Configuration.", + "membershipTypeRuleGeneralConditionsType": { "type": "object", + "description": "Membership Type Rules general Conditions.", "properties": { - "code": { - "description": "Code is used to identify a Membership Market/Resort Group.", + "reservationChannel": { + "description": "Reservation Channel for which the rule is applied.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description of the Membership Market/Propety Group.", + "property": { + "description": "Property for which the rule is applied.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "displaySequence": { - "description": "Membership Market/Property Groups display sequence Number", - "type": "number" + "propertyGroup": { + "description": "Property group for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "rateCodes": { - "description": "Collection of Rate codes associated with this Rate Group.", - "$ref": "#/definitions/membershipRateCodesType" - } - } - }, - "membershipRateGroups": { - "description": "Request object for modifying Membership Rate Groups.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "enrollmentCode": { + "description": "Enrollment Code for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "membershipRateGroups": { - "description": "Collection of Membership Rate Groups to be changed.", - "$ref": "#/definitions/membershipRateGroupsType" + "enrollmentGroup": { + "description": "Enrollment Group for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "promotionCode": { + "description": "Promotion Code for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipLevel": { + "description": "Membership Level for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "membershipRateGroupsInfo": { - "description": "Response object for fetching Membership Rate Groups.", + "membershipTypeRuleRateConditionsType": { "type": "object", + "description": "Membership Type Rules rate Conditions.", "properties": { - "links": { - "$ref": "#/definitions/links" + "rateCode": { + "description": "Rate code for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "membershipRateGroups": { - "description": "Collection of Membership Rate Group.", - "$ref": "#/definitions/membershipRateGroupsType" + "rateGroup": { + "description": "Rate group for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipRateGroupsType": { - "description": "Details for Membership Rate Group.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipRateGroupType" - } - }, - "membershipStatusCodeType": { - "description": "Contains Common Master configuration detail.", - "type": "object", - "properties": { - "code": { - "description": "Common Master unique code.", + "revenueGroup": { + "description": "Revenue group for which the rule is applied.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "averageRateAmount": { + "description": "Average rate amount of the reservations for which rule will be applied.", + "type": "number" }, - "displayOrder": { - "description": "Common Master record sequence number.", + "minimumRevenue": { + "description": "Minimum revenue on which rule will be applied.", "type": "number" - } - } - }, - "membershipStatusCodesCriteria": { - "description": "Request object for creating Membership Status Codes.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" }, - "membershipStatusCodes": { - "description": "Membership Status Codes to be created.", - "$ref": "#/definitions/membershipStatusCodesType" + "transactionGroup": { + "description": "Transaction group for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "qualifyingRates": { + "description": "Points ratio is expressed in terms of %.", + "type": "boolean" + }, + "excludeRateGroup": { + "description": "To specify the exclusion of rate group.", + "type": "boolean" + }, + "excludeRevenueGroup": { + "description": "To specify the exclusion of revenue group while applying rule.", + "type": "boolean" + }, + "includeTransactionGroup": { + "description": "To specify the inclusion of Transaction group.", + "type": "boolean" + }, + "allMembershipRates": { + "description": "Points Calculation will be based on all rate codes when specify All Membership Rates.", + "type": "boolean" + }, + "allMembershipTrx": { + "description": "Points Calculation will be based on all transaction codes when specify All Membership Transactions.", + "type": "boolean" } } }, - "membershipStatusCodesDetails": { - "description": "Response object for fetching Membership Status Codes.", + "membershipTypeRuleRoomConditionsType": { "type": "object", + "description": "Membership Type Rules room conditions.", "properties": { - "links": { - "$ref": "#/definitions/links" + "roomType": { + "description": "Room type/label for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "membershipStatusCodes": { - "description": "Collection of Membership Status Codes.", - "$ref": "#/definitions/membershipStatusCodesType" + "roomGroup": { + "description": "Membership room group for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "roomClass": { + "description": "Room class for the room for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomsToCharge": { + "description": "Indicates whether to use Room Type or Booked Room Type for the rule. If Y then Booked Room Type will be used for points calculation otherwise Room Type to be used.", + "type": "boolean" } } }, - "membershipStatusCodesToBeChanged": { - "description": "Request object for changing Membership Status Codes.", + "membershipTypeRuleSegmentationConditionsType": { "type": "object", + "description": "Membership Type Rules segmentation conditions.", "properties": { - "links": { - "$ref": "#/definitions/links" + "marketCode": { + "description": "Market Code for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "membershipStatusCodes": { - "description": "Membership Status Codes to be changed.", - "$ref": "#/definitions/membershipStatusCodesType" + "marketGroup": { + "description": "Market group for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "excludeMarketGroup": { + "description": "To specify the exclusion of market group while applying rule.", + "type": "boolean" } } }, - "membershipStatusCodesType": { - "description": "List of Membership Status Codes.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipStatusCodeType" - } - }, - "membershipTypeAdditionalInfoType": { - "description": "Membership Type miscellanous settings.", + "membershipTypeRuleReservationConditionsType": { "type": "object", + "description": "Membership Type Rules reservation conditions.", "properties": { - "adhocStatement": { - "description": "Default membership statement to be sent ad hoc.", + "reservationStartDate": { + "description": "Reservations with start date for which the rule is applied.", "type": "string", - "maxLength": 80, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "autoUpdateWebLogin": { - "description": "Automatically update web login.", + "reservationEndDate": { + "description": "Reservations with end date for which the rule is applied.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "minimumNights": { + "description": "Minimum length of stay required to receive points if membership type is based on STAY.", + "type": "integer" + }, + "maximumNights": { + "description": "Maximum length of stay required to receive points if membership type is based on NIGHTS.", + "type": "integer" + }, + "daysFromEnrollment": { + "description": "Number of days from enrolment.", + "type": "integer" + }, + "sunday": { "type": "boolean" }, - "autoWebEnrollment": { - "description": "Automatically open to allow a web user account to be created.", + "monday": { "type": "boolean" }, - "batchStatement": { - "description": "Batch process statement.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "tuesday": { + "type": "boolean" }, - "enrollmentLetter": { - "description": "When enrolling new members, this is the default letter to be sent.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "membershipTypeChangeInstructionType": { - "description": "Represents the membership type under change .", - "type": "object", - "properties": { - "membershipType": { - "description": "Membership type details.", - "$ref": "#/definitions/membershipTypeType" + "wednesday": { + "type": "boolean" }, - "responseInstructions": { - "description": "Collection of instructions to be returned as a set of membership type information.", - "type": "object", - "properties": { - "confirmationOnly": { - "description": "If this value is set to TRUE, then the operation will only return for a Success or Failed flag.", - "type": "boolean" - }, - "responseInstruction": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipTypeInstructionType" - } - } - } + "thursday": { + "type": "boolean" + }, + "friday": { + "type": "boolean" + }, + "saturday": { + "type": "boolean" } } }, - "membershipTypeChangeInstructions": { - "description": "Request object for changing membership type.", + "membershipTypeRulesDetails": { "type": "object", + "description": "Response object for creating membership type rules.", "properties": { + "membershipTypeRules": { + "description": "Membership type rule primary details on successful creation.", + "$ref": "#/definitions/membershipTypeRulesIDType" + }, "links": { "$ref": "#/definitions/links" }, - "membershipTypeChangeInstructions": { - "description": "A collection of MembershipTypes with information that needs to be changed.", - "type": "array", - "items": { - "$ref": "#/definitions/membershipTypeChangeInstructionType" - } - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipTypeInstructionType": { - "description": "Membership levels.", - "type": "string", - "enum": [ - "PrimaryDetails", - "CardNumberDetails", - "PointsDetails", - "ExceptionCriteriaDetails", - "AdditionalDetails", - "EnrollmentDetails", - "Levels" - ] + "membershipTypeRulesIDType": { + "type": "array", + "description": "List of membership type rule ID's.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipTypeRuleIDType" + } }, "membershipTypeRule": { - "description": "Response object for fetching membership type rule.", "type": "object", + "description": "Response object for fetching membership type rule.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "membershipTypeRule": { "description": "Membership type rule detailed information.", "$ref": "#/definitions/membershipTypeRuleDetailType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipTypeRuleBasedOnType": { - "description": "Indicates Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score.", - "type": "string", - "enum": [ - "Revenue", - "Stay", - "Nights", - "Enrollment", - "TierUpgrade", - "Renewal", - "Rfm" - ] - }, - "membershipTypeRuleConditionsType": { - "description": "Membership Type Rule Conditions.", - "type": "object", - "properties": { - "generalConditions": { - "description": "Specifies the General Conditions to apply the rules.", - "$ref": "#/definitions/membershipTypeRuleGeneralConditionsType" - }, - "rateConditions": { - "description": "Specifies the Rate code Conditions to apply the rules.", - "$ref": "#/definitions/membershipTypeRuleRateConditionsType" - }, - "reservationConditions": { - "description": "Specifies the Reservation Conditions to apply the rules.", - "$ref": "#/definitions/membershipTypeRuleReservationConditionsType" - }, - "roomConditions": { - "description": "Specifies the Room Conditions to apply the rules.", - "$ref": "#/definitions/membershipTypeRuleRoomConditionsType" - }, - "segmentationConditions": { - "description": "Specifies the Segmentation Conditions to apply the rules.", - "$ref": "#/definitions/membershipTypeRuleSegmentationConditionsType" - } - } - }, - "membershipTypeRuleDefinitionType": { - "description": "Membership Type Rule definition details.", - "type": "object", - "properties": { - "noOfTimesEligible": { - "description": "Specifies total number of times program rule is eligible .", - "type": "integer" - }, - "programType": { - "description": "Program(Points/Tier) type of the rule.", - "$ref": "#/definitions/membershipTypeRuleType" - }, - "ruleAppliesOn": { - "description": "Rule applies on Reservation Arrival Date, Reservation Departure Date, Any date during stay or RestrictedDates.", - "$ref": "#/definitions/ruleAppliesOnType" - }, - "ruleCode": { - "description": "Rule code of the membership type rule.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "ruleExpirationDate": { - "description": "Date on which the rule will be expired.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "ruleExportLabel": { - "description": "This field will be used to store export label and will be used only for exporting purposes.", - "type": "string", - "maxLength": 40, - "minLength": 0 - } - } - }, - "membershipTypeRuleDetailType": { - "description": "Membership type Rule details.", + "membershipTypes": { "type": "object", + "description": "Response object for fetching Membership Types.", "properties": { - "ruleConditions": { - "description": "Membership Type rule conditions details.", - "$ref": "#/definitions/membershipTypeRuleConditionsType" - }, - "ruleDefinition": { - "description": "Membership type rule definition details.", - "$ref": "#/definitions/membershipTypeRuleDefinitionType" + "membershipTypes": { + "description": "Collection of Membership types fetched.", + "$ref": "#/definitions/membershipTypesType" }, - "rulePointsDefinition": { - "description": "Membership Type rule points definition details.", - "$ref": "#/definitions/membershipTypeRulePointsDefinitionType" + "links": { + "$ref": "#/definitions/links" }, - "rulePrimaryDetails": { - "description": "Membership type rule summary information.", - "$ref": "#/definitions/membershipTypeRulePrimaryDetailsType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "membershipTypeRuleDetailsType": { - "description": "Collection of Membership type rule details.", + "membershipTypesType": { "type": "array", + "description": "Membership Type", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipTypeRuleDetailType" + "$ref": "#/definitions/membershipTypeType" } }, - "membershipTypeRuleGeneralConditionsType": { - "description": "Membership Type Rules general Conditions.", + "membershipTypeType": { "type": "object", - "properties": { - "enrollmentCode": { - "description": "Enrollment Code for which the rule is applied.", + "description": "A representation of the information contained by a membership type.", + "properties": { + "membershipType": { + "description": "Membership Type code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "enrollmentGroup": { - "description": "Enrollment Group for which the rule is applied.", + "membershipClass": { + "description": "Membership Class code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "membershipLevel": { - "description": "Membership Level for which the rule is applied.", + "description": { + "description": "Description of the membership type.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "promotionCode": { - "description": "Promotion Code for which the rule is applied.", + "pointsLabel": { + "description": "Label used to refer to points for this membership type", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "property": { - "description": "Property for which the rule is applied.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "hasPointCalculationRule": { + "description": "Indicates if this membership type has a point calculation rule.", + "type": "boolean" }, - "propertyGroup": { - "description": "Property group for which the rule is applied.", + "ranking": { + "description": "Defines the priority order of this membership type.", + "type": "integer" + }, + "sequence": { + "description": "Sequence number that controls the position of the membership type when displayed in lists.", + "type": "integer" + }, + "cardDetails": { + "description": "Membership card details.", + "$ref": "#/definitions/cardNumberDetailsType" + }, + "cardNumberAutoGenerateDetails": { + "description": "Membership auto card number generation details.", + "$ref": "#/definitions/autoGenerateCardNumberType" + }, + "currency": { + "description": "The currency in which user would like to calculate the membership points.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "reservationChannel": { - "description": "Reservation Channel for which the rule is applied.", + "membershipAction": { + "description": "\"Type of action that the user wants to attach membership information to the reservation.", + "$ref": "#/definitions/membershipActionType" + }, + "exchangeType": { + "description": "Exchange type to be used in the currency conversion.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "membershipTypeRuleIDType": { - "description": "Membership type rule ID.", - "type": "object", - "properties": { - "membershipPointsSequence": { - "description": "Sequence number of the membership type rule.", - "type": "integer" + "minLength": 0, + "maxLength": 20 }, - "membershipType": { - "description": "Membership type of the Rule.", + "pointCost": { + "description": "The cost per point.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "membershipTypeRulePointsDefinitionType": { - "description": "Membership Program Rule points details.", - "type": "object", - "properties": { - "costPerPoint": { - "description": "Indicates the cost per point for this membership program.", - "type": "integer" + "minLength": 1, + "maxLength": 5 }, - "excludePointProjection": { - "description": "Determines while calculating points projection should the rule be excluded or included. Default is included(N).", + "attachMembershipToReservationRule": { + "description": "Indicates when the membership action to be taken .", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/attachMembershipToReservationRuleType" + } + }, + "memberFolioMessage": { + "description": "Folio message for member.", + "$ref": "#/definitions/translationTextType2000" + }, + "nonMemberFolioMessage": { + "description": "Folio message for non-member.", + "$ref": "#/definitions/translationTextType2000" + }, + "folioMessageFBAPosting": { + "description": "Folio Message FBA Posting.", + "$ref": "#/definitions/translationTextType2000" + }, + "awardGenerationMethod": { + "description": "Award Generation Method.", + "$ref": "#/definitions/membershipAwardGenerationMethodType" + }, + "awardPointsDetail": { + "description": "Detail on award points for membership award upgrades/downgrades.", + "$ref": "#/definitions/awardPointsType" + }, + "tierPointsDetails": { + "description": "Detail on award points for membership tier management.", + "$ref": "#/definitions/tierPointsType" + }, + "additionalDetails": { + "description": "Membership Type additional settings.", + "$ref": "#/definitions/membershipTypeAdditionalInfoType" + }, + "handlingDetails": { + "description": "Membership Handling Details", + "$ref": "#/definitions/membershipHandlingType" + }, + "membershipLevels": { + "description": "Membership levels associated with this membership.", + "$ref": "#/definitions/membershipLevelsType" + }, + "enrollmentMatchRule": { + "description": "Detail on Enrollment Match Rule and User Defined Enrollment fields for membership type.", + "$ref": "#/definitions/enrollmentMatchRuleType" + }, + "inactive": { + "description": "Indicates if the membership type is inactive.", "type": "boolean" }, - "percentagePoints": { - "description": "Points ratio is expressed in terms of %.", + "excludeProfileFromPurge": { + "description": "Indicates exclude profiles with an active membership of this type from the automatic purge utility.", "type": "boolean" }, - "points": { - "description": "Specifies the ratio of the points accumulated per Stay or Night or Revenue. This ratio multiplied by the actual Stays or Nights or Revenue will give the Total points accumulated.", - "type": "integer" + "allowShares": { + "description": "Indicates that the award points to each membership holder attached to the shared reservation.", + "type": "boolean" }, - "pointsRoundingFlag": { - "description": "This flag tells if the total amount computed will be rounded, rounded up or rounded down.", - "$ref": "#/definitions/pointsRoundingFlagType" + "sendCheckoutToInterface": { + "description": "Indicates that the reservation that is eligible for points would have its data processed by the End of Day procedures and transferred to the interface.", + "type": "boolean" }, - "revenueUnits": { - "description": "Specifies the minimum units needed.", - "type": "integer" - } - } - }, - "membershipTypeRulePrimaryDetailsType": { - "description": "Membership Type rule primary information.", - "type": "object", - "properties": { - "description": { - "description": "Description of the rule.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "multiplier": { + "description": "Allows the user to input a value by which the base number of points is multiplied.", + "type": "boolean" }, - "inactiveDate": { - "description": "The date that Membership type rule is marked as inactive.", - "type": "string", - "format": "date", - "maxLength": 8 + "centralSetup": { + "description": "Indicates how the award points for this membership type will be managed.", + "type": "boolean" }, - "membershipTypeRuleId": { - "description": "Membership type rule ID details.", - "$ref": "#/definitions/membershipTypeRuleIDType" + "isLoyaltyProgram": { + "description": "This flag indicates whether the membership class attached to the membership type is eligible for loyalty program or not.", + "type": "boolean" }, - "pointsType": { - "description": "Specifies if points are BASE or BONUS.", - "$ref": "#/definitions/rulePointsTypeType" + "enrollmentCodeRequiredYn": { + "description": "Indicates whether enrollment code is required or not.", + "type": "boolean" }, - "ruleBasedOn": { - "description": "Calculation rule name of the type rule. Determines whether this Membership generates points based on guest Revenue, Stays, Nights, Enrolment.", - "$ref": "#/definitions/membershipTypeRuleBasedOnType" + "bookerProgramYn": { + "description": "Indicates the membership type is for a Booker.", + "type": "boolean" }, - "ruleEndDate": { - "description": "End date for this points calculation rule.", - "type": "string", - "format": "date", - "maxLength": 8 + "companyYn": { + "description": "Add the booker membership to company profile type.", + "type": "boolean" }, - "ruleStartDate": { - "description": "Start date indicates the begin date for this points calculation rule.", - "type": "string", - "format": "date", - "maxLength": 8 + "travelAgentYn": { + "description": "Add the booker membership to travel agent profile type.", + "type": "boolean" }, - "transactionCode": { - "description": "Tranaction code for membership type rule. e.g. Resident, Non Resident", - "$ref": "#/definitions/membershipTypeRuleTransactionCodeType" - } - } - }, - "membershipTypeRuleRateConditionsType": { - "description": "Membership Type Rules rate Conditions.", - "type": "object", - "properties": { - "allMembershipRates": { - "description": "Points Calculation will be based on all rate codes when specify All Membership Rates.", + "sourceYn": { + "description": "Add the booker membership to source profile type.", "type": "boolean" }, - "allMembershipTrx": { - "description": "Points Calculation will be based on all transaction codes when specify All Membership Transactions.", + "groupYn": { + "description": "Add the booker membership to group profile type.", "type": "boolean" }, - "averageRateAmount": { - "description": "Average rate amount of the reservations for which rule will be applied.", - "type": "number" + "contactYn": { + "description": "Add the booker membership to contact profile type.", + "type": "boolean" }, - "excludeRateGroup": { - "description": "To specify the exclusion of rate group.", + "externallyControlled": { + "description": "Flag that affects how a Membership Type is added, edited or deleted from a profile.", "type": "boolean" }, - "excludeRevenueGroup": { - "description": "To specify the exclusion of revenue group while applying rule.", + "enrollmentAddressAllowed": { + "description": "Flag that indicates Profile Address is editable during Enrollment.", "type": "boolean" }, - "includeTransactionGroup": { - "description": "To specify the inclusion of Transaction group.", + "enrollmentCommunicationAllowed": { + "description": "Flag that indicates Profile Communication is editable during Enrollment.", "type": "boolean" }, - "minimumRevenue": { - "description": "Minimum revenue on which rule will be applied.", - "type": "number" + "enrollmentFeeAllowed": { + "description": "Flag that indicates Fee is editable during Enrollment.", + "type": "boolean" }, - "qualifyingRates": { - "description": "Points ratio is expressed in terms of %.", + "enrollmentBirthdateAllowed": { + "description": "Flag that indicates Birthdate field is editable during Enrollment.", "type": "boolean" }, - "rateCode": { - "description": "Rate code for which the rule is applied.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "reIssueNewCard": { + "description": "Indicates whether to re-issue the membership card or not, when it is lost / stolen.", + "type": "boolean" }, - "rateGroup": { - "description": "Rate group for which the rule is applied.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "primaryMembership": { + "description": "Indicates whether primary membership or not.", + "type": "boolean" }, - "revenueGroup": { - "description": "Revenue group for which the rule is applied.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "printFolioMsgOnConfirmation": { + "description": "Print Folio Message on confirmation.", + "type": "boolean" }, - "transactionGroup": { - "description": "Transaction group for which the rule is applied.", + "externalDatabase": { + "description": "Indicates database for external system for Membership Type.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "membershipTypeRuleReservationConditionsType": { - "description": "Membership Type Rules reservation conditions.", + "cardNumberDetailsType": { "type": "object", + "description": "Card Number of membership type.", "properties": { - "daysFromEnrollment": { - "description": "Number of days from enrolment.", - "type": "integer" - }, - "friday": { - "type": "boolean" - }, - "maximumNights": { - "description": "Maximum length of stay required to receive points if membership type is based on NIGHTS.", - "type": "integer" - }, - "minimumNights": { - "description": "Minimum length of stay required to receive points if membership type is based on STAY.", - "type": "integer" - }, - "monday": { - "type": "boolean" + "membershipCardValidationRule": { + "description": "ValidationRules for credit card.", + "$ref": "#/definitions/membershipCardValidationRuleType" }, - "reservationEndDate": { - "description": "Reservations with end date for which the rule is applied.", - "type": "string", - "format": "date", - "maxLength": 8 + "cardNumberBasedOn": { + "description": "Indicates new membership card numbers, either based on the enrollment code or on the next available number in the card sequence.", + "$ref": "#/definitions/cardNumberGenerationModeType" }, - "reservationStartDate": { - "description": "Reservations with start date for which the rule is applied.", + "database": { + "description": "Indicates External System from which card number will be generated.", "type": "string", - "format": "date", - "maxLength": 8 - }, - "saturday": { - "type": "boolean" + "minLength": 0, + "maxLength": 20 }, - "sunday": { + "allowDuplicateCardNumbers": { + "description": "Indicates if the multiple membership cards may be issued with the same membership number.", "type": "boolean" }, - "thursday": { + "expirationDateRequired": { + "description": "Indicates if the membership expiration date is required for validation of the profile membership information.", "type": "boolean" }, - "tuesday": { + "chipAndPin": { + "description": "Indicates is there a microchip that stores information which can be used to verify the validity of the membership and authenticate the customer based on a personal identification number (PIN).", "type": "boolean" }, - "wednesday": { + "validationByInterface": { + "description": "Indicates is the membership card is validated through the interface.", "type": "boolean" } } }, - "membershipTypeRuleRoomConditionsType": { - "description": "Membership Type Rules room conditions.", + "membershipCardValidationRuleType": { "type": "object", + "description": "Payment method card validation rules.", "properties": { - "roomClass": { - "description": "Room class for the room for which the rule is applied.", + "length": { + "description": "Valid lengths of card number.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 50 }, - "roomGroup": { - "description": "Membership room group for which the rule is applied.", + "prefix": { + "description": "Valid card number prefix.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 50 }, - "roomType": { - "description": "Room type/label for which the rule is applied.", + "ranges": { + "description": "Collection of card number ranges.", + "$ref": "#/definitions/cardRangesType" + }, + "formula": { + "description": "Formula used for card validation. Only valid in case of user defined validation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "roomsToCharge": { - "description": "Indicates whether to use Room Type or Booked Room Type for the rule. If Y then Booked Room Type will be used for points calculation otherwise Room Type to be used.", - "type": "boolean" + "rule": { + "description": "Defines rules to be used for membership card validation.", + "$ref": "#/definitions/membershipCardValidationRuleTypeType" } } }, - "membershipTypeRuleSegmentationConditionsType": { - "description": "Membership Type Rules segmentation conditions.", + "cardRangesType": { + "type": "array", + "description": "Card number start and end range.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/cardRangeType" + } + }, + "cardRangeType": { "type": "object", + "description": "Card number start and end range.", "properties": { - "excludeMarketGroup": { - "description": "To specify the exclusion of market group while applying rule.", - "type": "boolean" + "from": { + "description": "Starting range of the card.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "marketCode": { - "description": "Market Code for which the rule is applied.", + "to": { + "description": "End range of the card.", + "type": "string", + "minLength": 0, + "maxLength": 50 + } + } + }, + "membershipCardValidationRuleTypeType": { + "type": "string", + "description": "Defines rules to be used for card validation.", + "enum": [ + "Mod7", + "Mod10", + "Udef", + "Novalid", + "Internal", + "External" + ] + }, + "cardNumberGenerationModeType": { + "type": "string", + "description": "Card Number is generated using Enrollment Code.", + "enum": [ + "DefaultSequence", + "EnrollmentCode" + ] + }, + "autoGenerateCardNumberType": { + "type": "object", + "description": "Holds the configuration to generate membership card number.", + "properties": { + "cardRangeStart": { + "description": "Card number auto generation range.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "marketGroup": { - "description": "Market group for which the rule is applied.", + "cardRangeEnd": { + "description": "Card number auto generation range.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "cardNumberPrefix": { + "description": "Valid card number prefix.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "cardNumberFormat": { + "description": "Indicates what format the random generation card number should follow, Format we support are - 9 for Numbers, X for Alphanumeric mixed, and A for Alpha only. For example, 32093K.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "membershipTypeRuleSummaryType": { - "description": "Membership Type rule summary information.", + "membershipActionType": { + "type": "string", + "description": "Type of action that the user wants to attach membership information to the reservation .", + "enum": [ + "AutoPopulate", + "PromptToPopulate", + "AlwaysPrompt", + "NoAction" + ] + }, + "attachMembershipToReservationRuleType": { + "type": "string", + "description": "Indicates when the membership information should get attach to the reservation.", + "enum": [ + "NewReservation", + "UpdateReservation", + "Checkin", + "Checkout" + ] + }, + "membershipAwardGenerationMethodType": { + "type": "string", + "description": "Type of action that generates membership award points.", + "enum": [ + "Batch", + "Manual", + "System" + ] + }, + "awardPointsType": { "type": "object", + "description": "Base parent type for membership points comprising common elements between award points and tier points.", "properties": { - "membershipTypeRulePrimaryDetails": { - "description": "Membership type rule primary information.", - "$ref": "#/definitions/membershipTypeRulePrimaryDetailsType" + "nonMemberPoints": { + "description": "Indicates if points will be displayed for guests who are not members.", + "type": "boolean" }, - "programType": { - "description": "Program(Points/Tier) type of the rule.", - "$ref": "#/definitions/membershipTypeRuleType" + "delayInDays": { + "description": "Award points will be recognized in this number of days following the guest's check out date. The minimum number of days is 3 and the maximum number of days is 60. This delay provides a period of time during which adjustments can be made at the PMS level before awards are uploaded to ORS/OCIS.", + "type": "integer" }, - "ruleCode": { - "description": "Rule code of the membership type rule.", + "yearsToExpire": { + "description": "Indicates Membership card will be expired if there is no activity on the card for this number of years.", + "type": "integer" + }, + "calendarPeriod": { + "description": "Period of points calculation.", + "$ref": "#/definitions/calendarPeriodType" + }, + "expiryPeriod": { + "description": "Membership card expiration period.", + "$ref": "#/definitions/numberOfYearsType" + }, + "expiryMonth": { + "description": "Month of Expiry for Calendar", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 10 + }, + "monthsToAwardPointsExpiry": { + "description": "Months for which the Points accumulated can be redeemed for Rolling period.", + "type": "integer" + }, + "awardPointsExpiryDate": { + "description": "Months for which the Points accumulated can be redeemed for Calendar period.", + "$ref": "#/definitions/awardPointsValidityDurationType" + }, + "awardRedeemThreshold": { + "description": "Award redemption threshold", + "type": "integer" + }, + "activityPeriodMonths": { + "description": "Activity Period in months for Rolling.", + "type": "integer" + }, + "activityPeriodYears": { + "description": "Activity Period in years for Calendar.", + "$ref": "#/definitions/numberOfYearsType" + }, + "gracePeriodMonths": { + "description": "Grace Period in months used for Rolling.", + "type": "integer" + }, + "gracePeriodYear": { + "description": "Grace Period in years used for Calendar.", + "$ref": "#/definitions/calendarGracePeriodType" + }, + "requiredOnStayPeriod": { + "description": "Calculate stay points even if the loyalty membership card is not attached.", + "type": "boolean" + }, + "exceptionCriteria": { + "description": "Criteria for detecting exceptions in points calculation.", + "$ref": "#/definitions/awardsExceptionCriteriaType" } } }, - "membershipTypeRuleTransactionCodeType": { - "description": "Determines the Transaction Code for Membership program rule.", + "calendarPeriodType": { + "type": "string", + "description": "12 month period based on starting month.", + "enum": [ + "Calendar", + "Rolling" + ] + }, + "numberOfYearsType": { "type": "string", + "description": "Five Year period", "enum": [ - "Resident", - "NonResident" + "One", + "Two", + "Three", + "Four", + "Five" ] }, - "membershipTypeRuleType": { - "description": "Membership Type/Program rule types.", + "awardPointsValidityDurationType": { "type": "string", + "description": "Five Year period", "enum": [ - "All", - "Points", - "Tier" + "DoNotExpire", + "SameYear", + "OneYear", + "TwoYears", + "ThreeYears", + "FourYears", + "FiveYears" ] }, - "membershipTypeRules": { - "description": "Request object for changing membership type rules.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "membershipTypeRules": { - "description": "Collection of membership type rules to be changed.", - "$ref": "#/definitions/membershipTypeRuleDetailsType" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } + "calendarGracePeriodType": { + "type": "string", + "description": "Five Year period", + "enum": [ + "NoGracePeriod", + "OneYear", + "TwoYears", + "ThreeYears", + "FourYears", + "FiveYears" + ] }, - "membershipTypeRulesDetails": { - "description": "Response object for creating membership type rules.", + "awardsExceptionCriteriaType": { "type": "object", + "description": "Criteria for detecting exceptions in points calculation", "properties": { - "links": { - "$ref": "#/definitions/links" + "multipleRooms": { + "description": "Exception applied to multiple rooms.", + "$ref": "#/definitions/multipleRoomsType" }, - "membershipTypeRules": { - "description": "Membership type rule primary details on successful creation.", - "$ref": "#/definitions/membershipTypeRulesIDType" + "bBSingleProperty": { + "description": "Back to Back stay at a Single Property", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipTypeRulesIDType": { - "description": "List of membership type rule ID's.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipTypeRuleIDType" - } - }, - "membershipTypeRulesInfo": { - "description": "Response object for fetching membership type rules.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "bBSingleGroup": { + "description": "Back to back stay at a Single Group", + "type": "boolean" }, - "membershipTypeRules": { - "description": "Collection of membership type rules summary.", - "$ref": "#/definitions/membershipTypeRulesSummariesType" + "bBCrossMembership": { + "description": "Cross Membership Back to Back Stays", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "externalProcessingException": { + "description": "Number of days while awaiting an external accept/reject response file.", + "type": "integer" } } }, - "membershipTypeRulesSummariesType": { - "description": "List of Membership type rules summary information.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipTypeRuleSummaryType" - } + "multipleRoomsType": { + "type": "string", + "description": "Exception rule for 10 Rooms.", + "enum": [ + "Two", + "Three", + "Four", + "Five", + "Six", + "Seven", + "Eight", + "Nine", + "Ten" + ] }, - "membershipTypeType": { - "description": "A representation of the information contained by a membership type.", + "tierPointsType": { "type": "object", + "description": "Base parent type for membership points comprising common elements between award points and tier points.", "properties": { - "additionalDetails": { - "description": "Membership Type additional settings.", - "$ref": "#/definitions/membershipTypeAdditionalInfoType" - }, - "allowShares": { - "description": "Indicates that the award points to each membership holder attached to the shared reservation.", + "nonMemberPoints": { + "description": "Indicates if points will be displayed for guests who are not members.", "type": "boolean" }, - "attachMembershipToReservationRule": { - "description": "Indicates when the membership action to be taken .", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/attachMembershipToReservationRuleType" - } + "basedOn": { + "description": "Date on which the tier management is based.", + "$ref": "#/definitions/pointsCalculationDateType" }, - "awardGenerationMethod": { - "description": "Award Generation Method.", - "$ref": "#/definitions/membershipAwardGenerationMethodType" + "tierExpirationMonth": { + "description": "Month for Upgrade/Downgrade in a Calendar Period.", + "type": "string", + "minLength": 0, + "maxLength": 10 }, - "awardPointsDetail": { - "description": "Detail on award points for membership award upgrades/downgrades.", - "$ref": "#/definitions/awardPointsType" + "requalifyOnUpgrade": { + "description": "Requalify on Upgrade", + "type": "boolean" }, - "bookerProgramYn": { - "description": "Indicates the membership type is for a Booker.", + "downgradeRenewalInAutoJob": { + "description": "Downgrade/Renew the membership level automatically.", "type": "boolean" }, - "cardDetails": { - "description": "Membership card details.", - "$ref": "#/definitions/cardNumberDetailsType" + "upgradePeriodRolling": { + "description": "Upgrade period of points for Rolling period.", + "$ref": "#/definitions/numberOfYearsType" }, - "cardNumberAutoGenerateDetails": { - "description": "Membership auto card number generation details.", - "$ref": "#/definitions/autoGenerateCardNumberType" + "downgradePeriodRolling": { + "description": "Downgrade period of points for Rolling period.", + "$ref": "#/definitions/numberOfYearsType" }, - "centralSetup": { - "description": "Indicates how the award points for this membership type will be managed.", - "type": "boolean" + "upgradePeriodCalendar": { + "description": "Upgrade period of points for Calendar period.", + "$ref": "#/definitions/upgradeDowngradeForCalendarPeriodType" }, - "companyYn": { - "description": "Add the booker membership to company profile type.", - "type": "boolean" + "downgradePeriodCalendar": { + "description": "Downgrade period of points for Calendar period.", + "$ref": "#/definitions/upgradeDowngradeForCalendarPeriodType" }, - "contactYn": { - "description": "Add the booker membership to contact profile type.", + "enableTierManagementReset": { + "description": "TMR (Tier Management Reset) Level Rules configuration enabled or not.", "type": "boolean" - }, - "currency": { - "description": "The currency in which user would like to calculate the membership points.", + } + } + }, + "pointsCalculationDateType": { + "type": "string", + "description": "Tier Management based on date of transaction", + "enum": [ + "ArrivalDate", + "DepartureDate", + "PostingDate", + "TransactionDate" + ] + }, + "upgradeDowngradeForCalendarPeriodType": { + "type": "string", + "description": "Calculate points from five Years", + "enum": [ + "ThisYear", + "LastYear", + "TwoYears", + "ThreeYears", + "FourYears", + "FiveYears" + ] + }, + "membershipTypeAdditionalInfoType": { + "type": "object", + "description": "Membership Type miscellanous settings.", + "properties": { + "enrollmentLetter": { + "description": "When enrolling new members, this is the default letter to be sent.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "description": { - "description": "Description of the membership type.", + "adhocStatement": { + "description": "Default membership statement to be sent ad hoc.", "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "enrollmentAddressAllowed": { - "description": "Flag that indicates Profile Address is editable during Enrollment.", - "type": "boolean" - }, - "enrollmentBirthdateAllowed": { - "description": "Flag that indicates Birthdate field is editable during Enrollment.", - "type": "boolean" - }, - "enrollmentCodeRequiredYn": { - "description": "Indicates whether enrollment code is required or not.", - "type": "boolean" - }, - "enrollmentCommunicationAllowed": { - "description": "Flag that indicates Profile Communication is editable during Enrollment.", - "type": "boolean" - }, - "enrollmentFeeAllowed": { - "description": "Flag that indicates Fee is editable during Enrollment.", - "type": "boolean" - }, - "enrollmentMatchRule": { - "description": "Detail on Enrollment Match Rule and User Defined Enrollment fields for membership type.", - "$ref": "#/definitions/enrollmentMatchRuleType" + "minLength": 0, + "maxLength": 80 }, - "exchangeType": { - "description": "Exchange type to be used in the currency conversion.", + "batchStatement": { + "description": "Batch process statement.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "excludeProfileFromPurge": { - "description": "Indicates exclude profiles with an active membership of this type from the automatic purge utility.", + "autoWebEnrollment": { + "description": "Automatically open to allow a web user account to be created.", "type": "boolean" }, + "autoUpdateWebLogin": { + "description": "Automatically update web login.", + "type": "boolean" + } + } + }, + "membershipHandlingType": { + "type": "object", + "description": "Represents the way a membership type has to be processed.", + "properties": { "externalDatabase": { - "description": "Indicates database for external system for Membership Type.", + "description": "Indicates database for external system (if applicable).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "externallyControlled": { - "description": "Flag that affects how a Membership Type is added, edited or deleted from a profile.", + "levelRequired": { + "description": "Indicates whether to include membership level for validation or not , when profile membership information is send from External System to ORS/OCIS.", "type": "boolean" }, - "folioMessageFBAPosting": { - "description": "Folio Message FBA Posting.", - "$ref": "#/definitions/translationTextType2000" - }, - "groupYn": { - "description": "Add the booker membership to group profile type.", + "fulfillment": { + "description": "True if you wish to be able to select this membership type when creating an export file for fulfillment.", "type": "boolean" }, - "handlingDetails": { - "description": "Membership Handling Details", - "$ref": "#/definitions/membershipHandlingType" - }, - "hasPointCalculationRule": { - "description": "Indicates if this membership type has a point calculation rule.", + "allowCardNumberOverride": { + "description": "Indicates whether to perform profile merge or not.", "type": "boolean" }, - "inactive": { - "description": "Indicates if the membership type is inactive.", + "enrollmentCodeRequired": { + "description": "Indicates whether Enrollment Code required of not.", "type": "boolean" }, - "isLoyaltyProgram": { - "description": "This flag indicates whether the membership class attached to the membership type is eligible for loyalty program or not.", + "saveCardNumberHistory": { + "description": "Indicates whether to store discard membership number or not.Membership Number will be discarded during profile merge.", "type": "boolean" }, - "memberFolioMessage": { - "description": "Folio message for member.", - "$ref": "#/definitions/translationTextType2000" - }, - "membershipAction": { - "description": "\"Type of action that the user wants to attach membership information to the reservation.", - "$ref": "#/definitions/membershipActionType" - }, - "membershipClass": { - "description": "Membership Class code.", + "statementUDFSet": { + "description": "Represents Membership Statement UDF Set. Selected Statement UDF template will be attached to Membership.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "membershipLevels": { - "description": "Membership levels associated with this membership.", - "$ref": "#/definitions/membershipLevelsType" + "minLength": 0, + "maxLength": 40 }, - "membershipType": { - "description": "Membership Type code.", + "defaultMembershipStatus": { + "description": "Represents Membership status.This status will be assigned to Guest's profile with membership type.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "multiplier": { - "description": "Allows the user to input a value by which the base number of points is multiplied.", + "nameProtected": { + "description": "Prevent profile name change.", "type": "boolean" }, - "nonMemberFolioMessage": { - "description": "Folio message for non-member.", - "$ref": "#/definitions/translationTextType2000" - }, - "pointCost": { - "description": "The cost per point.", - "type": "string", - "maxLength": 5, - "minLength": 1 - }, - "pointsLabel": { - "description": "Label used to refer to points for this membership type", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "primaryMembership": { - "description": "Indicates whether primary membership or not.", + "alternateNameProtected": { + "description": "Prevent profile alternate name change.", "type": "boolean" }, - "printFolioMsgOnConfirmation": { - "description": "Print Folio Message on confirmation.", + "autoGenerateReferenceNo": { + "description": "Automatically generate the reference number for the primary membership.", "type": "boolean" }, - "ranking": { - "description": "Defines the priority order of this membership type.", - "type": "integer" - }, - "reIssueNewCard": { - "description": "Indicates whether to re-issue the membership card or not, when it is lost / stolen.", + "autoPopulateNumberFromName": { + "description": "Automatically populate number from name.", "type": "boolean" }, - "sendCheckoutToInterface": { - "description": "Indicates that the reservation that is eligible for points would have its data processed by the End of Day procedures and transferred to the interface.", + "nameOnCardFromAltName": { + "description": "Membership card name using the alternate name.", "type": "boolean" }, - "sequence": { - "description": "Sequence number that controls the position of the membership type when displayed in lists.", - "type": "integer" - }, - "sourceYn": { - "description": "Add the booker membership to source profile type.", + "moveMemPromotions": { + "description": "Move the membership promotions to the active membership.", "type": "boolean" + } + } + }, + "enrollmentMatchRuleType": { + "type": "object", + "description": "Represent Enrollment Match Rule and User Defined Enrollment fields/Attribute configuration for membership type.", + "properties": { + "membershipEnrollmentMatchRule": { + "description": "Enrollment Match Rule for Membership Type.", + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "tierPointsDetails": { - "description": "Detail on award points for membership tier management.", - "$ref": "#/definitions/tierPointsType" + "userDefinedEnrollmentFields": { + "description": "User Defined Enrollment fields/Attributes for membership type.", + "$ref": "#/definitions/userDefinedEnrollmentFieldsType" }, - "travelAgentYn": { - "description": "Add the booker membership to travel agent profile type.", + "advancedEnrollment": { + "description": "Indicates if the Advanced Enrollment is enabled for Membership Type. Advanced Enrollment is required tp apply Membership Enrollment Match Rule and User Defined Enrollment Fields/Attributes.", "type": "boolean" } } }, - "membershipTypes": { - "description": "Response object for fetching Membership Types.", + "userDefinedEnrollmentFieldsType": { + "type": "array", + "description": "Type that holds the User Defined Enrollment field/Attribute such as Communication, First Name , Last Name etc.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/userDefinedEnrollmentFieldType" + } + }, + "userDefinedEnrollmentFieldType": { "type": "object", + "description": "User Defined Enrollment Field/Attribute.", "properties": { - "links": { - "$ref": "#/definitions/links" + "fieldName": { + "description": "Name of the Field/Attribute such as comunication, birthdate etc.", + "$ref": "#/definitions/userDefinedEnrollmentFieldNameType" }, - "membershipTypes": { - "description": "Collection of Membership types fetched.", - "$ref": "#/definitions/membershipTypesType" + "fieldType": { + "description": "Type of the Field/Attribute such as phone, fax, email etc.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "requiredField": { + "description": "Indicates if the Field/Attribute is required for Membership Type.", + "type": "boolean" + }, + "active": { + "description": "Indicates if the Field/Attribute is active for Membership Type.", + "type": "boolean" } } }, + "userDefinedEnrollmentFieldNameType": { + "type": "string", + "description": "Date of birth field of Membership Type.", + "enum": [ + "Communication", + "LastName", + "FirstName", + "Address", + "Fee", + "BirthDate" + ] + }, "membershipTypesDetails": { - "description": "Response object for fetching Membership Type.", "type": "object", + "description": "Response object for fetching Membership Type.", "properties": { - "links": { - "$ref": "#/definitions/links" + "membershipTypes": { + "description": "List of Membership types fetched.", + "$ref": "#/definitions/membershipTypesType" }, "masterInfoList": { "description": "Refer to Generic common types document.", @@ -37335,103 +33138,106 @@ "$ref": "#/definitions/masterInfoType" } }, - "membershipTypes": { - "description": "List of Membership types fetched.", - "$ref": "#/definitions/membershipTypesType" + "links": { + "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "membershipTypesType": { - "description": "Membership Type", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipTypeType" - } - }, - "multipleRoomsType": { - "description": "Exception rule for 10 Rooms.", - "type": "string", - "enum": [ - "Two", - "Three", - "Four", - "Five", - "Six", - "Seven", - "Eight", - "Nine", - "Ten" - ] - }, - "nationalitiesCriteria": { - "description": "Request object for creating Nationalities.", + "membershipTypeChangeInstructions": { "type": "object", + "description": "Request object for changing membership type.", "properties": { + "membershipTypeChangeInstructions": { + "description": "A collection of MembershipTypes with information that needs to be changed.", + "type": "array", + "items": { + "$ref": "#/definitions/membershipTypeChangeInstructionType" + } + }, "links": { "$ref": "#/definitions/links" }, - "nationalities": { - "description": "Nationalities to be created.", - "$ref": "#/definitions/nationalitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, + "membershipTypeChangeInstructionType": { + "type": "object", + "description": "Represents the membership type under change .", + "properties": { + "membershipType": { + "description": "Membership type details.", + "$ref": "#/definitions/membershipTypeType" + }, + "responseInstructions": { + "description": "Collection of instructions to be returned as a set of membership type information.", + "type": "object", + "properties": { + "responseInstruction": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipTypeInstructionType" + } + }, + "confirmationOnly": { + "description": "If this value is set to TRUE, then the operation will only return for a Success or Failed flag.", + "type": "boolean" + } + } + } + } + }, + "membershipTypeInstructionType": { + "type": "string", + "description": "Membership levels.", + "enum": [ + "PrimaryDetails", + "CardNumberDetails", + "PointsDetails", + "ExceptionCriteriaDetails", + "AdditionalDetails", + "EnrollmentDetails", + "Levels" + ] + }, "nationalitiesDetails": { - "description": "Response object for fetching Nationalities.", "type": "object", + "description": "Response object for fetching Nationalities.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "nationalities": { "description": "Collection of Nationalities.", "$ref": "#/definitions/nationalitiesType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "nationalitiesToBeChanged": { - "description": "Request object for changing Nationalities.", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "nationalities": { - "description": "Nationalities to be changed.", - "$ref": "#/definitions/nationalitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "nationalitiesType": { - "description": "List of Nationalities.", "type": "array", + "description": "List of Nationalities.", "maxItems": 4000, "items": { "$ref": "#/definitions/nationalityType" } }, "nationalityType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -37443,170 +33249,71 @@ } } }, - "numberOfYearsType": { - "description": "Five Year period", - "type": "string", - "enum": [ - "One", - "Two", - "Three", - "Four", - "Five" - ] - }, - "operaVersionNumberType": { - "description": "Current Opera Version Number", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "ownerTeamType": { - "description": "Contains Common Master configuration detail.", + "nationalitiesCriteria": { "type": "object", + "description": "Request object for creating Nationalities.", "properties": { - "code": { - "description": "Common Master unique code.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "nationalities": { + "description": "Nationalities to be created.", + "$ref": "#/definitions/nationalitiesType" }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "links": { + "$ref": "#/definitions/links" }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "ownerTeamsCriteria": { - "description": "Request object for creating Owner Teams.", + "nationalitiesToBeChanged": { "type": "object", + "description": "Request object for changing Nationalities.", "properties": { + "nationalities": { + "description": "Nationalities to be changed.", + "$ref": "#/definitions/nationalitiesType" + }, "links": { "$ref": "#/definitions/links" }, - "ownerTeams": { - "description": "Owner Teamsto be created.", - "$ref": "#/definitions/ownerTeamsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ownerTeamsDetails": { - "description": "Response object for fetching Owner Teams.", "type": "object", + "description": "Response object for fetching Owner Teams.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "ownerTeams": { "description": "Collection of Owner Teams.", "$ref": "#/definitions/ownerTeamsType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "ownerTeamsToBeChanged": { - "description": "Request object for changing Owner Teams.", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "ownerTeams": { - "description": "Owner Teamsto be changed.", - "$ref": "#/definitions/ownerTeamsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ownerTeamsType": { - "description": "List of Owner Teams.", "type": "array", + "description": "List of Owner Teams.", "maxItems": 4000, "items": { "$ref": "#/definitions/ownerTeamType" } }, - "ownerType": { - "description": "Generic type for information about an owner.", + "ownerTeamType": { "type": "object", - "properties": { - "department": { - "description": "Department to which the owner belongs to.", - "$ref": "#/definitions/codeDescriptionType" - }, - "email": { - "description": "Email information of the owner.", - "$ref": "#/definitions/emailInfoType" - }, - "hotel": { - "description": "Hotel to which the owner belongs to.", - "$ref": "#/definitions/codeDescriptionType" - }, - "name": { - "description": "Provides name information of the owner.", - "$ref": "#/definitions/personNameType" - }, - "ownerCode": { - "description": "Unique Code to identify the owner.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "phone": { - "description": "Information on the telephone number of the owner.", - "$ref": "#/definitions/telephoneInfoType" - }, - "primary": { - "description": "When true, this is a primary owner.", - "type": "boolean" - }, - "profileId": { - "description": "Unique owner profile information.", - "$ref": "#/definitions/profileId" - }, - "relationship": { - "description": "Relationship of the owner within the profile or block.", - "$ref": "#/definitions/codeDescriptionType" - }, - "userId": { - "description": "Unique application user ID.", - "$ref": "#/definitions/uniqueID_Type" - }, - "userName": { - "description": "Unique application user name of the owner.", - "type": "string", - "maxLength": 40, - "minLength": 0 - } - } - }, - "ownersType": { - "description": "Generic type for a list of owners.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/ownerType" - } - }, - "payDayType": { "description": "Contains Common Master configuration detail.", - "type": "object", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -37615,368 +33322,308 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" - }, - "inactive": { - "description": "To configure the different pay days.", - "type": "boolean" } } }, - "payDaysCriteria": { - "description": "Request object for creating Pay Days.", + "ownerTeamsCriteria": { "type": "object", + "description": "Request object for creating Owner Teams.", "properties": { + "ownerTeams": { + "description": "Owner Teamsto be created.", + "$ref": "#/definitions/ownerTeamsType" + }, "links": { "$ref": "#/definitions/links" }, - "payDays": { - "description": "Pay Daysto be created.", - "$ref": "#/definitions/payDaysType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "payDaysDetails": { - "description": "Response object for fetching Pay Days.", + "ownerTeamsToBeChanged": { "type": "object", + "description": "Request object for changing Owner Teams.", "properties": { + "ownerTeams": { + "description": "Owner Teamsto be changed.", + "$ref": "#/definitions/ownerTeamsType" + }, "links": { "$ref": "#/definitions/links" }, - "payDays": { - "description": "Collection of Pay Days.", - "$ref": "#/definitions/payDaysType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "payDaysToBeChanged": { - "description": "Request object for changing Pay Days.", + "payDaysDetails": { "type": "object", + "description": "Response object for fetching Pay Days.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "payDays": { - "description": "Pay Daysto be changed.", + "description": "Collection of Pay Days.", "$ref": "#/definitions/payDaysType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "payDaysType": { - "description": "List of Pay Days.", "type": "array", + "description": "List of Pay Days.", "maxItems": 4000, "items": { "$ref": "#/definitions/payDayType" } }, - "personNameType": { - "description": "This provides name information for a person.", + "payDayType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "envelopeGreeting": { - "description": "Envelope Greeting of the profile", - "type": "string" - }, - "externalSystem": { - "description": "When name type is external, indicates the external system the name belongs to.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "givenName": { - "description": "Given name, first name or names.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "middleName": { - "description": "The middle name of the person name.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "namePrefix": { - "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "nameSuffix": { - "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "nameTitle": { - "description": "Degree or honors (e.g., Ph.D., M.D.)", - "type": "string", - "maxLength": 80, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "nameTitleSuffix": { - "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on.", - "type": "integer" + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" }, - "nameType": { - "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", - "$ref": "#/definitions/personNameTypeType" + "inactive": { + "description": "To configure the different pay days.", + "type": "boolean" + } + } + }, + "payDaysCriteria": { + "type": "object", + "description": "Request object for creating Pay Days.", + "properties": { + "payDays": { + "description": "Pay Daysto be created.", + "$ref": "#/definitions/payDaysType" }, - "salutation": { - "description": "Salutation of the profile", - "type": "string" + "links": { + "$ref": "#/definitions/links" }, - "surname": { - "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "personNameTypeType": { - "description": "Person's name in an external system.", - "type": "string", - "enum": [ - "Primary", - "Alternate", - "Incognito", - "External", - "Phonetic" - ] - }, - "pointsCalculationDateType": { - "description": "Tier Management based on date of transaction", - "type": "string", - "enum": [ - "ArrivalDate", - "DepartureDate", - "PostingDate", - "TransactionDate" - ] + "payDaysToBeChanged": { + "type": "object", + "description": "Request object for changing Pay Days.", + "properties": { + "payDays": { + "description": "Pay Daysto be changed.", + "$ref": "#/definitions/payDaysType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } }, - "pointsRoundingFlagType": { - "description": "This flag tells if the total amount computed will be rounded, rounded up or rounded down.", - "type": "string", - "enum": [ - "Round", - "Ceil", - "Floor" - ] + "preferenceGroups": { + "type": "object", + "description": "Response object for fetching preference groups.", + "properties": { + "preferenceGroups": { + "description": "Collection of preference groups matching the search criteria.", + "$ref": "#/definitions/preferenceGroupsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } }, - "preferenceCodesType": { - "description": "Specifies the preference code and its description mapped to the exclusive preference.", + "preferenceGroupsType": { "type": "array", + "description": "Collection of preference groups.", "maxItems": 4000, "items": { - "$ref": "#/definitions/codeDescriptionType" + "$ref": "#/definitions/preferenceGroupType" } }, "preferenceGroupType": { - "description": "Preference group identification details.", "type": "object", + "description": "Preference group identification details.", "properties": { - "allowSubTypes": { - "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", - "type": "boolean" - }, "code": { "description": "Code identifying the preference group.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { "description": "Description of the preference group.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "mandatoryReservation": { "description": "When this mandatory reservation is true then user cannot set or change reservation preference flag and also this is a non editable field. SPECIALS AND ROOM FEATURES preference groups will have true for this field", "type": "boolean" }, - "maxQuantity": { - "description": "Maximum number of preferences which can be created in this preference group.", - "type": "integer" - }, "reservationPreference": { "description": "Indicates if the preference group can be used in reservations.", "type": "boolean" }, + "maxQuantity": { + "description": "Maximum number of preferences which can be created in this preference group.", + "type": "integer" + }, "sequence": { "description": "Display sequence for the preference group.", "type": "integer" + }, + "allowSubTypes": { + "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", + "type": "boolean" } } }, - "preferenceGroups": { - "description": "Response object for fetching preference groups.", + "templatePreferences": { "type": "object", + "description": "Response object for fetching preferences at the template level.", "properties": { + "templatePreferences": { + "description": "Collection of preferences specified at the template level.", + "$ref": "#/definitions/configTemplatePreferencesType" + }, "links": { "$ref": "#/definitions/links" }, - "preferenceGroups": { - "description": "Collection of preference groups matching the search criteria.", - "$ref": "#/definitions/preferenceGroupsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "preferenceGroupsType": { - "description": "Collection of preference groups.", + "configTemplatePreferencesType": { "type": "array", + "description": "This type holds a collection of preferences at the template level.", "maxItems": 4000, "items": { - "$ref": "#/definitions/preferenceGroupType" + "$ref": "#/definitions/configTemplatePreferenceType" } }, - "preferenceType": { - "description": "Guest Preference details for the profile.", + "configTemplatePreferenceType": { "type": "object", + "description": "Base details common between both template and property level preferences.", "properties": { - "copyToProfile": { - "description": "Specifies whether to copy the reservation preference to the profile or not.", - "type": "boolean" - }, "description": { - "description": "Preference Description for display purposes.", + "description": "The description about the preference.", "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "excludedPreferencesCount": { - "description": "Specifies the count of preferences excluded for the attached reservation preference.", - "type": "integer" - }, - "global": { - "description": "Whether this preference is property specific or not.", - "type": "boolean" - }, - "hotels": { - "description": "If specified preference belongs to the Hotels listed, otherwise it is a global preference.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 - } + "minLength": 0, + "maxLength": 2000 }, - "preferenceId": { + "code": { + "description": "Specifies the preference code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "preferenceValue": { - "description": "Preference value for display purposes.", + "preferenceGroup": { + "description": "Specifies the preference group the preference belongs to.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "source": { - "description": "Source of the preference.", + "preferenceSubGroup": { + "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "housekeeping": { + "description": "Flag to indicate if this preference should be available on the Task Sheet Workflow configuration. It is only applicable for preference types FLOOR and SPECIALS.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + }, + "global": { + "description": "Specifies whether the preference is to be available for selection at all properties .", + "type": "boolean" } } }, - "preferenceTypeType": { - "description": "Preference details for the profile.", + "preferencesCopy": { "type": "object", + "description": "Request object for copying template preferences to hotel(s).", "properties": { - "availableQuantity": { - "description": "Available quantity of preferences (maximum quantity - Existing preferences)per preference group.", - "type": "integer" - }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "copyInstructions": { + "description": "List of the template preferences to be copied to hotel(s).", + "$ref": "#/definitions/configCopyPreferencesType" }, - "maxQuantity": { - "description": "Maximum quantity of preferences allowed per preference group.", - "type": "integer" + "links": { + "$ref": "#/definitions/links" }, - "maxResortUsedQuantity": { - "description": "Maximum quantity of preferences used by any resort per preference group.", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "configCopyPreferencesType": { + "type": "object", + "description": "Copy instructions for copying template preferences to hotel(s)", + "properties": { + "hotelCodes": { + "description": "Hotel codes to copy the template preferences to.", + "$ref": "#/definitions/codeListType" }, - "preference": { - "description": "Collection of Preferences for the profile.", + "templatePreferences": { + "description": "Template preference to be copied to the hotel(s).", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/preferenceType" + "$ref": "#/definitions/configTemplatePreferenceIDType" } - }, - "preferenceType": { - "description": "Preference group code.", + } + } + }, + "configTemplatePreferenceIDType": { + "type": "object", + "description": "Base details common between both template and property level preference ids.", + "properties": { + "code": { + "description": "Specifies the preference code.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "preferenceTypeDescription": { - "description": "Preference group description.", - "type": "string" + "minLength": 0, + "maxLength": 20 }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "preferenceGroup": { + "description": "Specifies the preference group the preference belongs to.", "type": "string", - "format": "date", - "maxLength": 8 - }, - "reservationPreference": { - "description": "Whether this preference is reservation preference or not.", - "type": "boolean" - }, - "sequence": { - "description": "Preference Sequence.", - "type": "string" + "minLength": 0, + "maxLength": 20 } } }, - "preferencesCopy": { - "description": "Request object for copying template preferences to hotel(s).", + "profileInactiveReasonsDetails": { "type": "object", - "properties": { - "copyInstructions": { - "description": "List of the template preferences to be copied to hotel(s).", - "$ref": "#/definitions/configCopyPreferencesType" + "description": "Response object for fetching Profile Inactive Reasons.", + "properties": { + "profileInactiveReasons": { + "description": "Collection of Profile Inactive Reasons.", + "$ref": "#/definitions/profileInactiveReasonsType" }, "links": { "$ref": "#/definitions/links" @@ -37986,53 +33633,23 @@ } } }, - "profileId": { - "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).", - "type": "object", - "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", - "maxLength": 80, - "minLength": 0 - }, - "idContext": { - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "idExtension": { - "description": "Additional identifying value assigned by the creating system.", - "type": "integer" - }, - "instance": { - "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "url": { - "description": "URL that identifies the location associated with the record identified by the UniqueID.", - "type": "string" - } + "profileInactiveReasonsType": { + "type": "array", + "description": "List of Profile Inactive Reasons.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileInactiveReasonType" } }, "profileInactiveReasonType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -38045,342 +33662,155 @@ } }, "profileInactiveReasonsCriteria": { - "description": "Request object for creating Profile Inactive Reasons.", "type": "object", + "description": "Request object for creating Profile Inactive Reasons.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "profileInactiveReasons": { "description": "Profile Inactive Reasonsto be created.", "$ref": "#/definitions/profileInactiveReasonsType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "profileInactiveReasonsDetails": { - "description": "Response object for fetching Profile Inactive Reasons.", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "profileInactiveReasons": { - "description": "Collection of Profile Inactive Reasons.", - "$ref": "#/definitions/profileInactiveReasonsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileInactiveReasonsToBeChanged": { - "description": "Request object for changing Profile Inactive Reasons.", "type": "object", + "description": "Request object for changing Profile Inactive Reasons.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "profileInactiveReasons": { "description": "Profile Inactive Reasonsto be changed.", "$ref": "#/definitions/profileInactiveReasonsType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "profileInactiveReasonsType": { - "description": "List of Profile Inactive Reasons.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileInactiveReasonType" - } - }, - "profileLinkInheritRates": { - "description": "Simple type for inherit rates", - "type": "string", - "enum": [ - "From", - "To" - ] - }, - "profileLinkType": { - "description": "ProfileLinksType for create, change and delete", + "profileNameValidations": { "type": "object", + "description": "Response for fetching Profile names.", "properties": { - "defaultProfileLink": { - "description": "Relationship is default relationship or not", - "type": "boolean" - }, - "fromCode": { - "description": "From code to process", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "fromDescription": { - "description": "The description about from relation", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "fromType": { - "description": "From type to process", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "globalProfileLink": { - "description": "Relationship is global relationship or not", - "type": "boolean" - }, - "hasHierarchy": { - "description": "Determines whether this relationship is hierarchichal or not.", - "type": "boolean" - }, - "inheritRates": { - "description": "Inherit rates will take either to or from", - "$ref": "#/definitions/profileLinkInheritRates" - }, - "protected": { - "description": "Determines whether this code is protected from deleting. This is a read-only element and is only populated during the fetch operation.", - "type": "boolean" - }, - "toCode": { - "description": "To code to process", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "toDescription": { - "description": "The description about to relation", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "profileNames": { + "description": "Collection of Profile names.", + "$ref": "#/definitions/profileNameValidationsType" }, - "toType": { - "description": "To type to process", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "profileLinks": { - "description": "Response object for fetch profile links", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "profileLinks": { - "$ref": "#/definitions/profileLinksType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "profileLinksType": { - "description": "Holds the collection of profile link objects", + "profileNameValidationsType": { "type": "array", + "description": "List of the Profile name to be configured or fetched.", "maxItems": 4000, "items": { - "$ref": "#/definitions/profileLinkType" + "$ref": "#/definitions/profileNameValidationType" } }, - "profileNameValidationEditType": { - "description": "Provides information about the Profile Names.", + "profileNameValidationType": { "type": "object", + "description": "Provides information about the Profile Names.", "properties": { - "name": { - "description": "Name of the Profile.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "newProfileName": { - "description": "List of new values for Profile Name and Type .", - "$ref": "#/definitions/profileNameValidationType" - }, "type": { "description": "Type of the Profile.", "$ref": "#/definitions/profileNameValidationTypeType" - } - } - }, - "profileNameValidationType": { - "description": "Provides information about the Profile Names.", - "type": "object", - "properties": { + }, "name": { "description": "Name of the Profile.", "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "type": { - "description": "Type of the Profile.", - "$ref": "#/definitions/profileNameValidationTypeType" + "minLength": 0, + "maxLength": 80 } } }, "profileNameValidationTypeType": { - "description": "Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source.", "type": "string", + "description": "Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source.", "enum": [ "Company", "TravelAgent", "Source" ] }, - "profileNameValidations": { - "description": "Response for fetching Profile names.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "profileNames": { - "description": "Collection of Profile names.", - "$ref": "#/definitions/profileNameValidationsType" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, "profileNameValidationsToChange": { - "description": "Request object to edit Profile names.", "type": "object", + "description": "Request object to edit Profile names.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "profileNames": { "description": "Details of the Profile names to edit.", "$ref": "#/definitions/profileNameValidationEditType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "profileNameValidationsType": { - "description": "List of the Profile name to be configured or fetched.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileNameValidationType" - } - }, - "profileRestrictionReasonType": { - "description": "Contains Common Master configuration detail.", - "type": "object", - "properties": { - "code": { - "description": "Common Master unique code.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" - }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "profileRestrictionReasonsCriteria": { - "description": "Request object for creating Profile Restriction Reasons.", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "profileRestrictionReasons": { - "description": "Profile Restriction Reasonsto be created.", - "$ref": "#/definitions/profileRestrictionReasonsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "profileRestrictionReasonsDetails": { - "description": "Response object for fetching Profile Restriction Reasons.", + "profileNameValidationEditType": { "type": "object", + "description": "Provides information about the Profile Names.", "properties": { - "links": { - "$ref": "#/definitions/links" + "type": { + "description": "Type of the Profile.", + "$ref": "#/definitions/profileNameValidationTypeType" }, - "profileRestrictionReasons": { - "description": "Collection of Profile Restriction Reasons.", - "$ref": "#/definitions/profileRestrictionReasonsType" + "name": { + "description": "Name of the Profile.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "newProfileName": { + "description": "List of new values for Profile Name and Type .", + "$ref": "#/definitions/profileNameValidationType" } } }, - "profileRestrictionReasonsToBeChanged": { - "description": "Request object for changing Profile Restriction Reasons.", + "profileRestrictionReasonsDetails": { "type": "object", + "description": "Response object for fetching Profile Restriction Reasons.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "profileRestrictionReasons": { - "description": "Profile Restriction Reasonsto be changed.", + "description": "Collection of Profile Restriction Reasons.", "$ref": "#/definitions/profileRestrictionReasonsType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileRestrictionReasonsType": { - "description": "List of Profile Restriction Reasons.", "type": "array", + "description": "List of Profile Restriction Reasons.", "maxItems": 4000, "items": { "$ref": "#/definitions/profileRestrictionReasonType" } }, - "ruleAppliesOnType": { - "description": "Applies on restricted dates.", - "type": "string", - "enum": [ - "Arrival", - "Departure", - "Any", - "Restricted" - ] - }, - "rulePointsTypeType": { - "description": "Possible membership points types.", - "type": "string", - "enum": [ - "Base", - "Bonus" - ] - }, - "sourceType": { - "description": "Contains Common Master configuration detail.", + "profileRestrictionReasonType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -38389,344 +33819,341 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" - }, - "inactive": { - "description": "Determines whether this code is inactive or not.", - "type": "boolean" } } }, - "sourcesCriteria": { - "description": "Request object for creating Sources.", + "profileRestrictionReasonsCriteria": { "type": "object", + "description": "Request object for creating Profile Restriction Reasons.", "properties": { + "profileRestrictionReasons": { + "description": "Profile Restriction Reasonsto be created.", + "$ref": "#/definitions/profileRestrictionReasonsType" + }, "links": { "$ref": "#/definitions/links" }, - "sources": { - "description": "Sourcesto be created.", - "$ref": "#/definitions/sourcesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "sourcesDetails": { - "description": "Response object for fetching Sources.", + "profileRestrictionReasonsToBeChanged": { "type": "object", + "description": "Request object for changing Profile Restriction Reasons.", "properties": { + "profileRestrictionReasons": { + "description": "Profile Restriction Reasonsto be changed.", + "$ref": "#/definitions/profileRestrictionReasonsType" + }, "links": { "$ref": "#/definitions/links" }, - "sources": { - "description": "Collection of Sources.", - "$ref": "#/definitions/sourcesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "sourcesToBeChanged": { - "description": "Request object for changing Sources.", + "profileLinks": { "type": "object", + "description": "Response object for fetch profile links", "properties": { + "profileLinks": { + "$ref": "#/definitions/profileLinksType" + }, "links": { "$ref": "#/definitions/links" }, - "sources": { - "description": "Sourcesto be changed.", - "$ref": "#/definitions/sourcesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "sourcesType": { - "description": "List of Sources.", + "profileLinksType": { "type": "array", + "description": "Holds the collection of profile link objects", "maxItems": 4000, "items": { - "$ref": "#/definitions/sourceType" + "$ref": "#/definitions/profileLinkType" } }, - "stateType": { - "description": "Information about the country state.", + "profileLinkType": { "type": "object", + "description": "ProfileLinksType for create, change and delete", "properties": { - "countryCode": { - "description": "The country which the state belongs to.", + "fromType": { + "description": "From type to process", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "The description of the state.", + "toType": { + "description": "To type to process", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "sequence": { - "description": "The sequence number of the state.", - "type": "number" + "fromCode": { + "description": "From code to process", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "stateCode": { - "description": "The code of the state.", + "toCode": { + "description": "To code to process", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "stateID": { - "description": "Unique identifier of the state.", - "type": "number" + "fromDescription": { + "description": "The description about from relation", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "toDescription": { + "description": "The description about to relation", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "defaultProfileLink": { + "description": "Relationship is default relationship or not", + "type": "boolean" + }, + "globalProfileLink": { + "description": "Relationship is global relationship or not", + "type": "boolean" + }, + "inheritRates": { + "description": "Inherit rates will take either to or from", + "$ref": "#/definitions/profileLinkInheritRates" + }, + "protected": { + "description": "Determines whether this code is protected from deleting. This is a read-only element and is only populated during the fetch operation.", + "type": "boolean" + }, + "hasHierarchy": { + "description": "Determines whether this relationship is hierarchichal or not.", + "type": "boolean" } } }, - "statesCriteria": { - "description": "Request object for creating new states.", + "profileLinkInheritRates": { + "type": "string", + "description": "Simple type for inherit rates", + "enum": [ + "From", + "To" + ] + }, + "operaVersion": { "type": "object", + "description": "Response for Ping operation.", "properties": { + "operaVersion": { + "description": "Opera version number.", + "$ref": "#/definitions/operaVersionNumberType" + }, "links": { "$ref": "#/definitions/links" }, - "states": { - "description": "Collection of states to be created.", - "$ref": "#/definitions/statesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "statesDetails": { - "description": "Response object for fetching states.", + "operaVersionNumberType": { + "type": "string", + "description": "Current Opera Version Number", + "minLength": 0, + "maxLength": 40 + }, + "sourcesDetails": { "type": "object", + "description": "Response object for fetching Sources.", "properties": { + "sources": { + "description": "Collection of Sources.", + "$ref": "#/definitions/sourcesType" + }, "links": { "$ref": "#/definitions/links" }, - "states": { - "description": "Collection of states fetched based on the search criteria.", - "$ref": "#/definitions/statesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "statesType": { - "description": "Lists of states.", + "sourcesType": { "type": "array", + "description": "List of Sources.", "maxItems": 4000, "items": { - "$ref": "#/definitions/stateType" - } - }, - "status": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "$ref": "#/definitions/sourceType" } }, - "telephoneInfoType": { - "description": "Information on a telephone number for the customer.", + "sourceType": { "type": "object", + "description": "Contains Common Master configuration detail.", "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.", + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "telephone": { - "description": "Phone details for the profile.", - "$ref": "#/definitions/telephoneType" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" + }, + "inactive": { + "description": "Determines whether this code is inactive or not.", + "type": "boolean" } } }, - "telephoneType": { - "description": "Information on a telephone number for the customer.", + "sourcesCriteria": { "type": "object", + "description": "Request object for creating Sources.", "properties": { - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "extension": { - "description": "Extension to reach a specific party at the phone number.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" - }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" - }, - "phoneNumber": { - "description": "Telephone number assigned to a single location.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "phoneTechType": { - "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "phoneUseType": { - "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "phoneUseTypeDescription": { - "description": "Description of the PhoneUseType code", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "sources": { + "description": "Sourcesto be created.", + "$ref": "#/definitions/sourcesType" }, - "primaryInd": { - "description": "When true, indicates a primary information.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "templateExclusivePreferences": { - "description": "Response object for fetching exclusive preferences at the template level.", + "sourcesToBeChanged": { "type": "object", + "description": "Request object for changing Sources.", "properties": { + "sources": { + "description": "Sourcesto be changed.", + "$ref": "#/definitions/sourcesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateExclusivePreferences": { - "description": "Collection of exclusive preferences specified at the template level.", - "$ref": "#/definitions/configTemplateExclusivePreferencesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templatePreferences": { - "description": "Response object for fetching preferences at the template level.", + "statesDetails": { "type": "object", + "description": "Response object for fetching states.", "properties": { + "states": { + "description": "Collection of states fetched based on the search criteria.", + "$ref": "#/definitions/statesType" + }, "links": { "$ref": "#/definitions/links" }, - "templatePreferences": { - "description": "Collection of preferences specified at the template level.", - "$ref": "#/definitions/configTemplatePreferencesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "territoriesCriteria": { - "description": "Request object for creating Territories.", + "statesType": { + "type": "array", + "description": "Lists of states.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stateType" + } + }, + "stateType": { "type": "object", + "description": "Information about the country state.", "properties": { - "links": { - "$ref": "#/definitions/links" + "countryCode": { + "description": "The country which the state belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "territories": { - "description": "Territoriesto be created.", - "$ref": "#/definitions/territoriesType" + "stateCode": { + "description": "The code of the state.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "description": { + "description": "The description of the state.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "sequence": { + "description": "The sequence number of the state.", + "type": "number" + }, + "stateID": { + "description": "Unique identifier of the state.", + "type": "number" } } }, - "territoriesDetails": { - "description": "Response object for fetching Territories.", + "statesCriteria": { "type": "object", + "description": "Request object for creating new states.", "properties": { + "states": { + "description": "Collection of states to be created.", + "$ref": "#/definitions/statesType" + }, "links": { "$ref": "#/definitions/links" }, - "territories": { - "description": "Collection of Territories.", - "$ref": "#/definitions/territoriesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "territoriesToBeChanged": { - "description": "Request object for changing Territories.", + "territoriesDetails": { "type": "object", + "description": "Response object for fetching Territories.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "territories": { - "description": "Territoriesto be changed.", + "description": "Collection of Territories.", "$ref": "#/definitions/territoriesType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "territoriesType": { - "description": "List of Territories.", "type": "array", + "description": "List of Territories.", "maxItems": 4000, "items": { "$ref": "#/definitions/territoryType" } }, "territoryType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -38742,63 +34169,71 @@ } } }, - "tierPointsType": { - "description": "Base parent type for membership points comprising common elements between award points and tier points.", + "territoriesCriteria": { "type": "object", + "description": "Request object for creating Territories.", "properties": { - "basedOn": { - "description": "Date on which the tier management is based.", - "$ref": "#/definitions/pointsCalculationDateType" - }, - "downgradePeriodCalendar": { - "description": "Downgrade period of points for Calendar period.", - "$ref": "#/definitions/upgradeDowngradeForCalendarPeriodType" - }, - "downgradePeriodRolling": { - "description": "Downgrade period of points for Rolling period.", - "$ref": "#/definitions/numberOfYearsType" - }, - "downgradeRenewalInAutoJob": { - "description": "Downgrade/Renew the membership level automatically.", - "type": "boolean" + "territories": { + "description": "Territoriesto be created.", + "$ref": "#/definitions/territoriesType" }, - "enableTierManagementReset": { - "description": "TMR (Tier Management Reset) Level Rules configuration enabled or not.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "nonMemberPoints": { - "description": "Indicates if points will be displayed for guests who are not members.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "territoriesToBeChanged": { + "type": "object", + "description": "Request object for changing Territories.", + "properties": { + "territories": { + "description": "Territoriesto be changed.", + "$ref": "#/definitions/territoriesType" }, - "requalifyOnUpgrade": { - "description": "Requalify on Upgrade", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "tierExpirationMonth": { - "description": "Month for Upgrade/Downgrade in a Calendar Period.", - "type": "string", - "maxLength": 10, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "titlesDetails": { + "type": "object", + "description": "Response object for fetching Titles.", + "properties": { + "titles": { + "description": "Collection of Titles.", + "$ref": "#/definitions/titlesType" }, - "upgradePeriodCalendar": { - "description": "Upgrade period of points for Calendar period.", - "$ref": "#/definitions/upgradeDowngradeForCalendarPeriodType" + "links": { + "$ref": "#/definitions/links" }, - "upgradePeriodRolling": { - "description": "Upgrade period of points for Rolling period.", - "$ref": "#/definitions/numberOfYearsType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, + "titlesType": { + "type": "array", + "description": "List of Titles.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/titleType" + } + }, "titleType": { - "description": "Contains Common Master configuration detail.", "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -38811,108 +34246,70 @@ } }, "titlesCriteria": { - "description": "Request object for creating Titles.", "type": "object", + "description": "Request object for creating Titles.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "titles": { "description": "Titlesto be created.", "$ref": "#/definitions/titlesType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "titlesDetails": { - "description": "Response object for fetching Titles.", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "titles": { - "description": "Collection of Titles.", - "$ref": "#/definitions/titlesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "titlesToBeChanged": { - "description": "Request object for changing Titles.", "type": "object", + "description": "Request object for changing Titles.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "titles": { "description": "Titlesto be changed.", "$ref": "#/definitions/titlesType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "titlesType": { - "description": "List of Titles.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/titleType" - } - }, - "translationTextType2000": { - "description": "Contains Multiple translated texts and language codes.", + "vIPLevelsDetails": { "type": "object", + "description": "Response object for fetching V I P Levels.", "properties": { - "defaultText": { - "description": "Default text with Character length from 0 to 2000.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "vIPLevels": { + "description": "Collection of V I P Levels.", + "$ref": "#/definitions/vIPLevelsType" }, - "translatedTexts": { - "description": "List of translated text and language codes.", - "$ref": "#/definitions/translationsTextType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "translationsTextType": { - "description": "Language code for the translation.", + "vIPLevelsType": { "type": "array", + "description": "List of V I P Levels.", "maxItems": 4000, "items": { - "description": "Language code for the translation.", - "type": "object", - "properties": { - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "value": { - "description": "Used for Character Strings, length 0 to 2000.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - } - } + "$ref": "#/definitions/vIPLevelType" } }, - "travelAgentTypeType": { - "description": "Contains Common Master configuration detail.", + "vIPLevelType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -38921,302 +34318,282 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "displayColor": { + "description": "Determines the color of this code.", + "$ref": "#/definitions/commonMasterColorType" + }, + "ranking": { + "description": "AI priority order of this code.", + "type": "integer" } } }, - "travelAgentTypesCriteria": { - "description": "Request object for creating Travel Agent Types.", + "commonMasterColorType": { + "type": "string", + "description": "Simple type enumeration for Common Master Colors.", + "enum": [ + "None", + "Blue", + "Red", + "Cyan", + "Green", + "Black", + "White", + "Yellow", + "Gray" + ] + }, + "vIPLevelsCriteria": { "type": "object", + "description": "Request object for creating V I P Levels.", "properties": { + "vIPLevels": { + "description": "V I P Levelsto be created.", + "$ref": "#/definitions/vIPLevelsType" + }, "links": { "$ref": "#/definitions/links" }, - "travelAgentTypes": { - "description": "Travel Agent Typesto be created.", - "$ref": "#/definitions/travelAgentTypesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "travelAgentTypesDetails": { - "description": "Response object for fetching Travel Agent Types.", + "vIPLevelsToBeChanged": { "type": "object", + "description": "Request object for changing V I P Levels.", "properties": { + "vIPLevels": { + "description": "V I P Levelsto be changed.", + "$ref": "#/definitions/vIPLevelsType" + }, "links": { "$ref": "#/definitions/links" }, - "travelAgentTypes": { - "description": "Collection of Travel Agent Types.", - "$ref": "#/definitions/travelAgentTypesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "travelAgentTypesToBeChanged": { - "description": "Request object for changing Travel Agent Types.", + "membershipRatesType": { + "type": "array", + "description": "Membership Rate summary information.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipRateType" + } + }, + "membershipRateType": { "type": "object", + "description": "Membership Rate summary information.", "properties": { - "links": { - "$ref": "#/definitions/links" + "hotelId": { + "description": "Membership Rate hotel code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "travelAgentTypes": { - "description": "Travel Agent Typesto be changed.", - "$ref": "#/definitions/travelAgentTypesType" + "ruleCode": { + "description": "Membership Rate rule code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "description": { + "description": "Description of the rule.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "beginDate": { + "description": "Date for which the rule will be affective.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "description": "Date for which the rule will end being affective.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "ratePlanCodes": { + "description": "List of Membership rate code rates.", + "$ref": "#/definitions/codeListType" + }, + "memberships": { + "description": "List of Membership rate code memberships.", + "$ref": "#/definitions/rateRuleMembershipsType" + }, + "latestTOB": { + "description": "Latest time of booking for guaranteed availability. Only Time part is used.", + "type": "string", + "format": "date-time" + }, + "daysToDOA": { + "description": "Number of days to day of arrival for guaranteed availability.", + "type": "integer" + }, + "inactive": { + "description": "Indicates whether the Membership Rate is Active/Inactive.", + "type": "boolean" + }, + "guaranteed": { + "description": "Indicates whether the rule is used for member guaranteed availability.", + "type": "boolean" } } }, - "travelAgentTypesType": { - "description": "List of Travel Agent Types.", + "rateRuleMembershipsType": { "type": "array", + "description": "Rate rule membership type details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/travelAgentTypeType" + "$ref": "#/definitions/rateRuleMembershipType" } }, - "uniqueID_Type": { - "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).", + "rateRuleMembershipType": { "type": "object", + "description": "Rate Rule Membership types.", "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.", + "membershipType": { + "description": "Rate rule membership type.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "membershipLevel": { + "description": "Rate rule membership levels.", + "$ref": "#/definitions/codeListType" } } }, - "upgradeDowngradeForCalendarPeriodType": { - "description": "Calculate points from five Years", - "type": "string", - "enum": [ - "ThisYear", - "LastYear", - "TwoYears", - "ThreeYears", - "FourYears", - "FiveYears" - ] - }, - "userDefinedEnrollmentFieldNameType": { - "description": "Date of birth field of Membership Type.", - "type": "string", - "enum": [ - "Communication", - "LastName", - "FirstName", - "Address", - "Fee", - "BirthDate" - ] - }, - "userDefinedEnrollmentFieldType": { - "description": "User Defined Enrollment Field/Attribute.", + "membershipRatesInfo": { "type": "object", + "description": "Response object for fetching membership rates.", "properties": { - "active": { - "description": "Indicates if the Field/Attribute is active for Membership Type.", - "type": "boolean" + "membershipRates": { + "description": "Collection of membership rates summary.", + "$ref": "#/definitions/membershipRatesType" }, - "fieldName": { - "description": "Name of the Field/Attribute such as comunication, birthdate etc.", - "$ref": "#/definitions/userDefinedEnrollmentFieldNameType" + "links": { + "$ref": "#/definitions/links" }, - "fieldType": { - "description": "Type of the Field/Attribute such as phone, fax, email etc.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipRates": { + "type": "object", + "description": "Request object for changing membership rate rules.", + "properties": { + "membershipRates": { + "description": "Collection of membership rate rules to be changed.", + "$ref": "#/definitions/membershipRatesType" }, - "requiredField": { - "description": "Indicates if the Field/Attribute is required for Membership Type.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "userDefinedEnrollmentFieldsType": { - "description": "Type that holds the User Defined Enrollment field/Attribute such as Communication, First Name , Last Name etc.", + "identificationCountriesType": { "type": "array", + "description": "List of Identification Countries.", "maxItems": 4000, "items": { - "$ref": "#/definitions/userDefinedEnrollmentFieldType" + "$ref": "#/definitions/identificationCountryType" } }, - "vIPLevelType": { - "description": "Contains Common Master configuration detail.", + "identificationCountryType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, - "displayColor": { - "description": "Determines the color of this code.", - "$ref": "#/definitions/commonMasterColorType" - }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" - }, - "ranking": { - "description": "AI priority order of this code.", - "type": "integer" } } }, - "vIPLevelsCriteria": { - "description": "Request object for creating V I P Levels.", + "identificationCountriesDetails": { "type": "object", + "description": "Response object for fetching Identification Countries.", "properties": { + "identificationCountries": { + "description": "Collection of Identification Countries.", + "$ref": "#/definitions/identificationCountriesType" + }, "links": { "$ref": "#/definitions/links" }, - "vIPLevels": { - "description": "V I P Levelsto be created.", - "$ref": "#/definitions/vIPLevelsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "vIPLevelsDetails": { - "description": "Response object for fetching V I P Levels.", + "identificationCountriesCriteria": { "type": "object", + "description": "Request object for creating Identification Countries.", "properties": { + "identificationCountries": { + "description": "Identification Countriesto be created.", + "$ref": "#/definitions/identificationCountriesType" + }, "links": { "$ref": "#/definitions/links" }, - "vIPLevels": { - "description": "Collection of V I P Levels.", - "$ref": "#/definitions/vIPLevelsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "vIPLevelsToBeChanged": { - "description": "Request object for changing V I P Levels.", + "identificationCountriesToBeChanged": { "type": "object", + "description": "Request object for changing Identification Countries.", "properties": { + "identificationCountries": { + "description": "Identification Countriesto be changed.", + "$ref": "#/definitions/identificationCountriesType" + }, "links": { "$ref": "#/definitions/links" }, - "vIPLevels": { - "description": "V I P Levelsto be changed.", - "$ref": "#/definitions/vIPLevelsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } - }, - "vIPLevelsType": { - "description": "List of V I P Levels.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/vIPLevelType" - } - }, - "warningType": { - "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", - "type": "object", - "properties": { - "code": { - "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "docURL": { - "description": "If present, this URL refers to an online description of the error that occurred.", - "type": "string", - "maxLength": 2000 - }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "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 - }, - "rph": { - "description": "Reference Place Holder used as an index for this warning.", - "type": "string", - "maxLength": 8, - "minLength": 1 - }, - "shortText": { - "description": "An abbreviated version of the error in textual format.", - "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 - }, - "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", - "maxLength": 20, - "minLength": 0 - }, - "value": { - "description": "Property Value", - "type": "string" - } - } - }, - "warningsType": { - "description": "Used in conjunction with the Success element to define a business error.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/warningType" - } } }, "tags": [ { - "description": "These APIs will allow you to configure membership configuration such as membership rates, levels, groups, benefit programs and membership awards.", - "name": "MembershipConfig" + "name": "ProfileConfiguration", + "description": "APIs for Customer Relationship Management (profile) configuration including preference groups and preferences." + }, + { + "name": "MembershipConfig", + "description": "These APIs will allow you to configure membership configuration such as membership rates, levels, groups, benefit programs and membership awards." }, { - "description": "These APIs will allow you to configure profile related configuration related to Administration.", - "name": "ChainConfig" + "name": "ChainConfig", + "description": "These APIs will allow you to configure profile related configuration related to Administration." }, { - "description": "These APIs will allow you to configure profile related configuration related to Administration.", - "name": "HotelConfig" + "name": "HotelConfig", + "description": "These APIs will allow you to configure profile related configuration related to Administration." } ], "externalDocs": { diff --git a/rest-api-specs/property/entcfg.json b/rest-api-specs/property/entcfg.json index 4fc9926..cd36648 100644 --- a/rest-api-specs/property/entcfg.json +++ b/rest-api-specs/property/entcfg.json @@ -1,15 +1,9 @@ { - "produces": [ - "application/json" - ], - "schemes": [ - "https" - ], "swagger": "2.0", "info": { - "description": "APIs to cater for Enterprise Configuration functionality in OPERA Cloud.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, 2023 Oracle and/or its affiliates.
", "title": "OPERA Cloud Enterprise Configuration API", - "version": "23.2", + "description": "APIs to cater for Enterprise Configuration functionality in OPERA Cloud.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, 2023 Oracle and/or its affiliates.
", + "version": "23.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality-integrations_ww@oracle.com" @@ -19,137 +13,103 @@ "url": "https://opensource.org/licenses/upl" } }, + "schemes": [ + "https" + ], "basePath": "/ent/config/v1", + "produces": [ + "application/json" + ], "paths": { "/airports": { "get": { - "description": "Use this API to get template airports.OperationId:getTemplateAirports
", - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "HotelConfig" - ], "summary": "Get template airports", + "description": "Use this API to get template airports.OperationId:getTemplateAirports
", "operationId": "getTemplateAirports", "parameters": [ { + "name": "airportCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Airport code identifying the airport.", - "name": "airportCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching template airports.", - "schema": { - "$ref": "#/definitions/templateAirportsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 airports.", + "schema": { + "$ref": "#/definitions/templateAirportsDetails" } }, "204": { "description": "TemplateAirports not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create new template airports.OperationId:postTemplateAirports
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -158,15 +118,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create new template airports", + "description": "Use this API to create new template airports.OperationId:postTemplateAirports
", "operationId": "postTemplateAirports", "parameters": [ { - "description": "Request object for creating new template airports.", "name": "templateAirportsCriteria", "in": "body", "required": true, + "description": "Request object for creating new template airports.", "schema": { "allOf": [ { @@ -176,111 +139,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/airports/{airportCode}": { - "put": { - "description": "Use this API to update airport templates based on airportCode, templateAirportsToBeChanged.OperationId:changeTemplateAirports
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -289,24 +218,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/airports/{airportCode}": { + "put": { "summary": "Change template airports", + "description": "Use this API to update template airports.OperationId:changeTemplateAirports
", "operationId": "changeTemplateAirports", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of airport.", "name": "airportCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of airport." }, { - "description": "Request object for modifying template airports.", "name": "templateAirportsToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying template airports.", "schema": { "allOf": [ { @@ -316,109 +250,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete airport templates based on airportCode.OperationId:removeTemplateAirports
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -427,125 +329,94 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete template airports", + "description": "Use this API to delete template airports.OperationId:removeTemplateAirports
", "operationId": "removeTemplateAirports", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of airport.", "name": "airportCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of airport." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/amenities": { - "get": { - "description": " Use this API to get template amenities.OperationId:getTemplateAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -554,135 +425,111 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/amenities": { + "get": { "summary": " Get template amenities", + "description": " Use this API to get template amenities.OperationId:getTemplateAmenities
", "operationId": "getTemplateAmenities", "parameters": [ { - "type": "boolean", - "description": "Is it a General amenity type.", "name": "general", - "in": "query" + "in": "query", + "required": false, + "description": "Is it a General amenity type.", + "type": "boolean" }, { - "type": "boolean", - "description": "Is it a Meeting amenity type.", "name": "meeting", - "in": "query" + "in": "query", + "required": false, + "description": "Is it a Meeting amenity type.", + "type": "boolean" }, { + "name": "amenityCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "amenityCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching amenities at the template level.", - "schema": { - "$ref": "#/definitions/templateAmenitiesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching amenities at the template level.", + "schema": { + "$ref": "#/definitions/templateAmenitiesDetails" } }, "204": { "description": "TemplateAmenities not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create template amenities.OperationId:postTemplateAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -691,15 +538,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create template amenities", + "description": "Use this API to create template amenities.OperationId:postTemplateAmenities
", "operationId": "postTemplateAmenities", "parameters": [ { - "description": "Request object for creating amenities at the template level.", "name": "templateAmenitiesCriteria", "in": "body", "required": true, + "description": "Request object for creating amenities at the template level.", "schema": { "allOf": [ { @@ -709,111 +559,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/amenities/{featureCode}": { - "put": { - "description": "Use this API to update amenity templates based on featureCode, templateAmenitiesToBeChanged.OperationId:changeTemplateAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -822,24 +638,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/amenities/{featureCode}": { + "put": { "summary": "Change template amenities", + "description": "Use this API to update template amenities.OperationId:changeTemplateAmenities
", "operationId": "changeTemplateAmenities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of feature.", "name": "featureCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of feature." }, { - "description": "Request object for changing amenities at the template level.", "name": "templateAmenitiesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing amenities at the template level.", "schema": { "allOf": [ { @@ -849,109 +670,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete amenity templates based on featureCode.OperationId:removeTemplateAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -960,125 +749,94 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete template amenities", + "description": "Use this API to delete template amenities.OperationId:removeTemplateAmenities
", "operationId": "removeTemplateAmenities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of feature.", "name": "featureCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of feature." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/attractionClasses": { - "get": { - "description": "Use this API to get Attraction Classes.OperationId:getAttractionClasses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1086,143 +844,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/attractionClasses": { + "get": { "summary": "Get Attraction Classes", + "description": "Use this API to get Attraction Classes.OperationId:getAttractionClasses
", "operationId": "getAttractionClasses", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Attraction Classes.", - "schema": { - "$ref": "#/definitions/attractionClassesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Attraction Classes.", + "schema": { + "$ref": "#/definitions/attractionClassesDetails" } }, "204": { "description": "AttractionClasses not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Attraction Classes.OperationId:postAttractionClasses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1231,15 +966,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Attraction Classes", + "description": "Use this API to create Attraction Classes.OperationId:postAttractionClasses
", "operationId": "postAttractionClasses", "parameters": [ { - "description": "Request object for creating Attraction Classes.", "name": "attractionClassesCriteria", "in": "body", "required": true, + "description": "Request object for creating Attraction Classes.", "schema": { "allOf": [ { @@ -1249,111 +987,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/attractionClasses/{attractionClassCode}": { - "put": { - "description": "Use this API to update Attraction Classes.OperationId:putAttractionClasses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1362,24 +1066,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/attractionClasses/{attractionClassCode}": { + "put": { "summary": "Change Attraction Classes", + "description": "Use this API to update Attraction Classes.OperationId:putAttractionClasses
", "operationId": "putAttractionClasses", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Attraction Classes.", "name": "attractionClassCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Attraction Classes." }, { - "description": "Request object for changing Attraction Classes.", "name": "attractionClassesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Attraction Classes.", "schema": { "allOf": [ { @@ -1389,109 +1098,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Attraction Classes.OperationId:deleteAttractionClasses
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1500,125 +1177,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Attraction Classes", + "description": "Use this API to delete Attraction Classes.OperationId:deleteAttractionClasses
", "operationId": "deleteAttractionClasses", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Attraction Classes.", "name": "attractionClassCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Attraction Classes." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/attractions": { - "get": { - "description": "This API accepts the attraction template request search criteria and fetches the attraction templates that match the criteria.OperationId:getAttractionTemplates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1626,141 +1272,117 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/attractions": { + "get": { "summary": "Get Attraction Template", + "description": "This API accepts the attraction template request search criteria and fetches the attraction templates that match the criteria.OperationId:getAttractionTemplates
", "operationId": "getAttractionTemplates", "parameters": [ { + "name": "attractionCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "attractionCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { + "name": "classCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "classCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for information regarding attraction templates.", - "schema": { - "$ref": "#/definitions/attractionTemplatesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 attraction templates.", + "schema": { + "$ref": "#/definitions/attractionTemplatesDetails" } }, "204": { "description": "AttractionTemplates not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "This API is used to create a new attraction template based on the request. .OperationId:postAttractionTemplates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1769,15 +1391,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Attraction Template", + "description": "This API is used to create a new attraction template based on the request. .OperationId:postAttractionTemplates
", "operationId": "postAttractionTemplates", "parameters": [ { - "description": "Request object for creating a new attraction code template.", "name": "attractionTemplatesCriteria", "in": "body", "required": true, + "description": "Request object for creating a new attraction code template.", "schema": { "allOf": [ { @@ -1787,111 +1412,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/attractions/{attractionCode}": { - "put": { - "description": "Use this API to update attraction templates based on attractionCode, attractionTemplatesToBeChanged.OperationId:changeAttractionTemplates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1900,24 +1491,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/attractions/{attractionCode}": { + "put": { "summary": "Change Attraction Template", + "description": "This API is used to update an existing attraction template.OperationId:changeAttractionTemplates
", "operationId": "changeAttractionTemplates", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of attraction template.", "name": "attractionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of attraction template." }, { - "description": "Request object for modifying the existing attraction attraction templates.", "name": "attractionTemplatesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying the existing attraction attraction templates.", "schema": { "allOf": [ { @@ -1927,109 +1523,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete attraction templates based on attractionCode.OperationId:removeAttractionTemplates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2038,125 +1602,94 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete an existing attraction template", + "description": "Use this API to delete an existing attraction template.OperationId:removeAttractionTemplates
", "operationId": "removeAttractionTemplates", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of attraction template.", "name": "attractionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of attraction template." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/brandCodes": { - "get": { - "description": "Use this API to return brand codes based on search criteria such as codes, wildCard, description. Brand codes are used for different hotel brands within a hotel corporation.OperationId:getBrandCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2164,143 +1697,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/brandCodes": { + "get": { "summary": "Get brand codes", + "description": "Use this API to return brand codes based on search criteria such as codes, wildCard, description. Brand codes are used for different hotel brands within a hotel corporation.OperationId:getBrandCodes
", "operationId": "getBrandCodes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Brand Codes.", - "schema": { - "$ref": "#/definitions/brandCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Brand Codes.", + "schema": { + "$ref": "#/definitions/brandCodesDetails" } }, "204": { "description": "BrandCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Brand Codes.OperationId:postBrandCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2309,15 +1819,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Brand Codes", + "description": "Use this API to create Brand Codes.OperationId:postBrandCodes
", "operationId": "postBrandCodes", "parameters": [ { - "description": "Request object for creating Brand Codes.", "name": "brandCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating Brand Codes.", "schema": { "allOf": [ { @@ -2327,111 +1840,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/brandCodes/{brandCode}": { - "put": { - "description": "Use this API to update brand codes based on brandCode, brandCodesToBeChanged. Brand codes are used for different hotel brands within a hotel corporation.OperationId:changeBrandCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2440,24 +1919,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/brandCodes/{brandCode}": { + "put": { "summary": "Change Brand Code", + "description": "Use this API to update Brand Code.OperationId:changeBrandCodes
", "operationId": "changeBrandCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Brand.", "name": "brandCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Brand." }, { - "description": "Request object for changing Brand Codes.", "name": "brandCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Brand Codes.", "schema": { "allOf": [ { @@ -2467,109 +1951,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete brand codes based on brandCode, brandCodesCodes. Brand codes are used for different hotel brands within a hotel corporation.OperationId:removeBrandCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2578,135 +2030,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Brand Code", + "description": "Use this API to delete Brand Code.OperationId:removeBrandCodes
", "operationId": "removeBrandCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Brand.", "name": "brandCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Brand." }, { + "name": "brandCodesCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "brandCodesCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/calendar": { - "get": { - "description": "Use this API to get detailed information of calendar entries for a date range.OperationId:getPropertyCalendar
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2714,152 +2136,124 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/calendar": { + "get": { "summary": "Get Hotel Calendar", + "description": "Use this API to get detailed information of calendar entries for a date range.OperationId:getPropertyCalendar
", "operationId": "getPropertyCalendar", "parameters": [ { - "type": "string", - "format": "date", "name": "startDate", "in": "query", - "required": true + "required": true, + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", "name": "endDate", "in": "query", - "required": true + "required": true, + "type": "string", + "format": "date" }, { - "uniqueItems": true, + "name": "fetchInstructions", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Indicates entries for a day in calendar. Entries can vary between day types, events, etc.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "DayType", "Event" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Indicates entries for a day in calendar. Entries can vary between day types, events, etc.", - "name": "fetchInstructions", - "in": "query", "required": true }, { - "type": "string", - "description": "Hotel for which calendar is being represented.", "name": "hotelId", - "in": "query" + "in": "query", + "required": false, + "description": "Hotel for which calendar is being represented.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching calendar entries for a hotel.", - "schema": { - "$ref": "#/definitions/hotelCalendarDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching calendar entries for a hotel.", + "schema": { + "$ref": "#/definitions/hotelCalendarDetails" } }, "204": { "description": "PropertyCalendar not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/chain": { - "get": { - "description": "Use this API to get Chains.OperationId:getChain
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2867,152 +2261,129 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/chain": { + "get": { "summary": "Get Chains", + "description": "Use this API to get Chains.OperationId:getChain
", "operationId": "getChain", "parameters": [ { - "type": "boolean", "name": "enforceSecurity", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "includeActive", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "includeInactive", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { + "name": "chainCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "chainCodes", - "in": "query" + "required": false }, { - "type": "string", "name": "chainName", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Chain.", - "schema": { - "$ref": "#/definitions/chainDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Chain.", + "schema": { + "$ref": "#/definitions/chainDetails" } }, "204": { "description": "Chain not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/chain/{chainCode}": { - "put": { - "description": "Use this API to update Chain.OperationId:putChain
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3021,24 +2392,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/chain/{chainCode}": { + "put": { "summary": "Change Chain", + "description": "Use this API to update Chain.OperationId:putChain
", "operationId": "putChain", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Chain.", "name": "chainCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Chain." }, { - "description": "Request object for changing Chain.", "name": "chainToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Chain.", "schema": { "allOf": [ { @@ -3048,111 +2424,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/communicationMethodsEntDetails": { - "get": { - "description": "Use this API to get Communication Methods Ent Details.OperationId:getCommunicationMethodsEntDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3161,142 +2503,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/communicationMethodsEntDetails": { + "get": { "summary": "Get Communication Methods Ent Details", + "description": "Use this API to get Communication Methods Ent Details.OperationId:getCommunicationMethodsEntDetails
", "operationId": "getCommunicationMethodsEntDetails", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Communication Methods Ent Details.", - "schema": { - "$ref": "#/definitions/communicationMethodsEntDetailsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Communication Methods Ent Details.", + "schema": { + "$ref": "#/definitions/communicationMethodsEntDetailsDetails" } }, "204": { "description": "CommunicationMethodsEntDetails not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Communication Methods Ent Details.OperationId:postCommunicationMethodsEntDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3305,15 +2624,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Communication Methods Ent Details", + "description": "Use this API to create Communication Methods Ent Details.OperationId:postCommunicationMethodsEntDetails
", "operationId": "postCommunicationMethodsEntDetails", "parameters": [ { - "description": "Request object for creating Communication Methods Ent Details.", "name": "communicationMethodsEntDetailsCriteria", "in": "body", "required": true, + "description": "Request object for creating Communication Methods Ent Details.", "schema": { "allOf": [ { @@ -3323,111 +2645,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/communicationMethodsEntDetails/{communicationMethodsEntDetailsId}": { - "put": { - "description": "Use this API to update Communication Methods Ent Details.OperationId:putCommunicationMethodsEntDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3436,24 +2724,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/communicationMethodsEntDetails/{communicationMethodsEntDetailsId}": { + "put": { "summary": "Change Communication Methods Ent Details", + "description": "Use this API to update Communication Methods Ent Details.OperationId:putCommunicationMethodsEntDetails
", "operationId": "putCommunicationMethodsEntDetails", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Communication Methods Ent Details.", "name": "communicationMethodsEntDetailsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Communication Methods Ent Details." }, { - "description": "Request object for changing Communication Methods Ent Details.", "name": "communicationMethodsEntDetailsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Communication Methods Ent Details.", "schema": { "allOf": [ { @@ -3463,109 +2756,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Communication Methods Ent Details.OperationId:deleteCommunicationMethodsEntDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3574,135 +2835,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Communication Methods Ent Details", + "description": "Use this API to delete Communication Methods Ent Details.OperationId:deleteCommunicationMethodsEntDetails
", "operationId": "deleteCommunicationMethodsEntDetails", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Communication Methods Ent Details.", "name": "communicationMethodsEntDetailsId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Communication Methods Ent Details." }, { + "name": "communicationMethodsEntDetailsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "communicationMethodsEntDetailsCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/configurations/activityLogs": { - "get": { - "description": "Use this API to Fetch Configuration Activity logs from Activity Group or Type.OperationId:getConfigActivityLog
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3710,30 +2941,43 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/configurations/activityLogs": { + "get": { "summary": "Get Configuration Activity Logs", + "description": "Use this API to Fetch Configuration Activity logs from Activity Group or Type.OperationId:getConfigActivityLog
", "operationId": "getConfigActivityLog", "parameters": [ { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "type": "integer", - "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.", "name": "pageNumber", - "in": "query" + "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" }, { - "type": "string", - "description": "Hotel code.", "name": "hotelId", - "in": "query" + "in": "query", + "required": false, + "description": "Hotel code.", + "type": "string" }, { + "name": "module", + "in": "query", + "required": false, + "type": "string", + "description": "Activity module.", "uniqueItems": true, "enum": [ "Reservation", @@ -3746,185 +2990,158 @@ "RateCode", "Billing", "Activity" - ], - "type": "string", - "description": "Activity module.", - "name": "module", - "in": "query" + ] }, { + "name": "parameterName", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Name of the parameter.", - "name": "parameterName", - "in": "query" + "required": false }, { + "name": "parameterValue", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Value of the parameter.", - "name": "parameterValue", - "in": "query" + "required": false }, { - "type": "string", "name": "activityGroup", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", "name": "activityType", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "format": "date", - "description": "Search from date for the user activity log.", "name": "fromDate", - "in": "query" + "in": "query", + "required": false, + "description": "Search from date for the user activity log.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "Search to date for the user activity log.", "name": "toDate", - "in": "query" + "in": "query", + "required": false, + "description": "Search to date for the user activity log.", + "type": "string", + "format": "date" }, { - "type": "string", - "description": "Search text for the user activity log.", "name": "searchText", - "in": "query" + "in": "query", + "required": false, + "description": "Search text for the user activity log.", + "type": "string" }, { + "name": "userByIds", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "integer" + "type": "integer", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "userByIds", - "in": "query" + "required": false }, { + "name": "userForIds", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "integer" + "type": "integer", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "userForIds", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching configuration activity log.", - "schema": { - "$ref": "#/definitions/configActivityLogDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching configuration activity log.", + "schema": { + "$ref": "#/definitions/configActivityLogDetails" } }, "204": { "description": "ConfigActivityLog not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create a new Activity Log.OperationId:postConfigActivityLog
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3933,15 +3150,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create a new Config Activity Log", + "description": "Use this API to create a new Activity Log.OperationId:postConfigActivityLog
", "operationId": "postConfigActivityLog", "parameters": [ { - "description": "Request object for creating Config Activity Logs.", "name": "createConfigActivityLogCriteria", "in": "body", "required": true, + "description": "Request object for creating Config Activity Logs.", "schema": { "allOf": [ { @@ -3951,111 +3171,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/corporateBusinessUnits": { - "get": { - "description": "Use this API to get Corporate Business Units.OperationId:getCorporateBusinessUnits
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4063,143 +3249,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/corporateBusinessUnits": { + "get": { "summary": "Get Corporate Business Units", + "description": "Use this API to get Corporate Business Units.OperationId:getCorporateBusinessUnits
", "operationId": "getCorporateBusinessUnits", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Corporate Business Units.", - "schema": { - "$ref": "#/definitions/corporateBusinessUnitsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Corporate Business Units.", + "schema": { + "$ref": "#/definitions/corporateBusinessUnitsDetails" } }, "204": { "description": "CorporateBusinessUnits not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Corporate Business Units.OperationId:postCorporateBusinessUnits
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4208,15 +3371,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Corporate Business Units", + "description": "Use this API to create Corporate Business Units.OperationId:postCorporateBusinessUnits
", "operationId": "postCorporateBusinessUnits", "parameters": [ { - "description": "Request object for creating Corporate Business Units.", "name": "corporateBusinessUnitsCriteria", "in": "body", "required": true, + "description": "Request object for creating Corporate Business Units.", "schema": { "allOf": [ { @@ -4226,111 +3392,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/corporateBusinessUnits/{businessUnitCode}": { - "put": { - "description": "Use this API to update Corporate Business Units based on businessUnitCode, corporateBusinessUnitsToBeChanged.OperationId:changeCorporateBusinessUnits
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4339,24 +3471,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/corporateBusinessUnits/{businessUnitCode}": { + "put": { "summary": "Change Corporate Business Units", + "description": "Use this API to update Corporate Business Units.OperationId:changeCorporateBusinessUnits
", "operationId": "changeCorporateBusinessUnits", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Business Units.", "name": "businessUnitCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Business Units." }, { - "description": "Request object for changing Corporate Business Units.", "name": "corporateBusinessUnitsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Corporate Business Units.", "schema": { "allOf": [ { @@ -4366,109 +3503,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Corporate Business Units.OperationId:removeCorporateBusinessUnits
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4477,135 +3582,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Corporate Business Units", + "description": "Use this API to delete Corporate Business Units.OperationId:removeCorporateBusinessUnits
", "operationId": "removeCorporateBusinessUnits", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Business Units.", "name": "businessUnitCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Business Units." }, { + "name": "corporateBusinessUnitsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "corporateBusinessUnitsCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/corporateDepartmentCodes": { - "get": { - "description": "Use this API to get Corporate Department Codes.OperationId:getCorporateDepartmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4614,142 +3689,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/corporateDepartmentCodes": { + "get": { "summary": "Get Corporate Department Codes", + "description": "Use this API to get Corporate Department Codes.OperationId:getCorporateDepartmentCodes
", "operationId": "getCorporateDepartmentCodes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Corporate Department Codes.", - "schema": { - "$ref": "#/definitions/corporateDepartmentCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Corporate Department Codes.", + "schema": { + "$ref": "#/definitions/corporateDepartmentCodesDetails" } }, "204": { "description": "CorporateDepartmentCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Corporate Department Codes.OperationId:postCorporateDepartmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4758,15 +3810,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Corporate Department Codes", + "description": "Use this API to create Corporate Department Codes.OperationId:postCorporateDepartmentCodes
", "operationId": "postCorporateDepartmentCodes", "parameters": [ { - "description": "Request object for creating Corporate Department Codes.", "name": "corporateDepartmentCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating Corporate Department Codes.", "schema": { "allOf": [ { @@ -4776,111 +3831,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/corporateDepartmentCodes/{departmentCode}": { - "put": { - "description": "Use this API to update corporate department codes based on departmentCode, corporateDepartmentCodesToBeChanged.OperationId:changeCorporateDepartmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4889,24 +3910,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/corporateDepartmentCodes/{departmentCode}": { + "put": { "summary": "Change Corporate Department Codes", + "description": "Use this API to update Corporate Department Codes.OperationId:changeCorporateDepartmentCodes
", "operationId": "changeCorporateDepartmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Department.", "name": "departmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Department." }, { - "description": "Request object for changing Corporate Department Codes.", "name": "corporateDepartmentCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Corporate Department Codes.", "schema": { "allOf": [ { @@ -4916,109 +3942,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete corporate department codes based on departmentCode.OperationId:removeCorporateDepartmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5027,125 +4021,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Corporate Department Codes", + "description": "Use this API to delete Corporate Department Codes.OperationId:removeCorporateDepartmentCodes
", "operationId": "removeCorporateDepartmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Department.", "name": "departmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Department." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/corporateDivisions": { - "get": { - "description": "Use this API to get Corporate Divisions.OperationId:getCorporateDivisions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5154,142 +4117,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/corporateDivisions": { + "get": { "summary": "Get Corporate Divisions", + "description": "Use this API to get Corporate Divisions.OperationId:getCorporateDivisions
", "operationId": "getCorporateDivisions", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Corporate Divisions.", - "schema": { - "$ref": "#/definitions/corporateDivisionsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Corporate Divisions.", + "schema": { + "$ref": "#/definitions/corporateDivisionsDetails" } }, "204": { "description": "CorporateDivisions not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Corporate Divisions.OperationId:postCorporateDivisions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5298,15 +4238,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Corporate Divisions", + "description": "Use this API to create Corporate Divisions.OperationId:postCorporateDivisions
", "operationId": "postCorporateDivisions", "parameters": [ { - "description": "Request object for creating Corporate Divisions.", "name": "corporateDivisionsCriteria", "in": "body", "required": true, + "description": "Request object for creating Corporate Divisions.", "schema": { "allOf": [ { @@ -5316,111 +4259,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/corporateDivisions/{divisionCode}": { - "put": { - "description": "Use this API to update corporate divisions based on divisionCode, corporateDivisionsToBeChanged.OperationId:changeCorporateDivisions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5429,24 +4338,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/corporateDivisions/{divisionCode}": { + "put": { "summary": "Change Corporate Divisions", + "description": "Use this API to update Corporate Divisions.OperationId:changeCorporateDivisions
", "operationId": "changeCorporateDivisions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Corporate Divisions.", "name": "divisionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Corporate Divisions." }, { - "description": "Request object for changing Corporate Divisions.", "name": "corporateDivisionsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Corporate Divisions.", "schema": { "allOf": [ { @@ -5456,109 +4370,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete corporate divisions based on divisionCode, corporateDivisionsCodes.OperationId:removeCorporateDivisions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5567,135 +4449,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Corporate Divisions", + "description": "Use this API to delete Corporate Divisions.OperationId:removeCorporateDivisions
", "operationId": "removeCorporateDivisions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Corporate Divisions.", "name": "divisionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Corporate Divisions." }, { + "name": "corporateDivisionsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "corporateDivisionsCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/corporateOperatingUnits": { - "get": { - "description": "Use this API to get Corporate Operating Units.OperationId:getCorporateOperatingUnits
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5704,142 +4556,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/corporateOperatingUnits": { + "get": { "summary": "Get Corporate Operating Units", + "description": "Use this API to get Corporate Operating Units.OperationId:getCorporateOperatingUnits
", "operationId": "getCorporateOperatingUnits", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Corporate Operating Units.", - "schema": { - "$ref": "#/definitions/corporateOperatingUnitsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Corporate Operating Units.", + "schema": { + "$ref": "#/definitions/corporateOperatingUnitsDetails" } }, "204": { "description": "CorporateOperatingUnits not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Corporate Operating Units.OperationId:postCorporateOperatingUnits
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5848,15 +4677,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Corporate Operating Units", + "description": "Use this API to create Corporate Operating Units.OperationId:postCorporateOperatingUnits
", "operationId": "postCorporateOperatingUnits", "parameters": [ { - "description": "Request object for creating Corporate Operating Units.", "name": "corporateOperatingUnitsCriteria", "in": "body", "required": true, + "description": "Request object for creating Corporate Operating Units.", "schema": { "allOf": [ { @@ -5866,111 +4698,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/corporateOperatingUnits/{operatingUnitCode}": { - "put": { - "description": "Use this API to update corporate operating units based on operatingUnitCode, corporateOperatingUnitsToBeChanged.OperationId:changeCorporateOperatingUnits
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5979,24 +4777,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/corporateOperatingUnits/{operatingUnitCode}": { + "put": { "summary": "Change Corporate Operating Units", + "description": "Use this API to update Corporate Operating Units.OperationId:changeCorporateOperatingUnits
", "operationId": "changeCorporateOperatingUnits", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Corporate Operating Units.", "name": "operatingUnitCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Corporate Operating Units." }, { - "description": "Request object for changing Corporate Operating Units.", "name": "corporateOperatingUnitsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Corporate Operating Units.", "schema": { "allOf": [ { @@ -6006,109 +4809,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete corporate operating units based on operatingUnitCode, corporateOperatingUnitsCodes.OperationId:removeCorporateOperatingUnits
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6117,135 +4888,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Corporate Operating Units", + "description": "Use this API to delete Corporate Operating Units.OperationId:removeCorporateOperatingUnits
", "operationId": "removeCorporateOperatingUnits", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Corporate Operating Units.", "name": "operatingUnitCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Corporate Operating Units." }, { + "name": "corporateOperatingUnitsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "corporateOperatingUnitsCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/countries": { - "get": { - "description": "Use this API to get template Countries.OperationId:getTemplateCountries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6253,131 +4994,106 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/countries": { + "get": { "summary": "Get template Countries", + "description": "Use this API to get template Countries.OperationId:getTemplateCountries
", "operationId": "getTemplateCountries", "parameters": [ { + "name": "countriesCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "countriesCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching template Countries.", - "schema": { - "$ref": "#/definitions/templateCountriesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 Countries.", + "schema": { + "$ref": "#/definitions/templateCountriesDetails" } }, "204": { "description": "TemplateCountries not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create template Countries.OperationId:postTemplateCountries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6386,15 +5102,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create template Countries", + "description": "Use this API to create template Countries.OperationId:postTemplateCountries
", "operationId": "postTemplateCountries", "parameters": [ { - "description": "Request object for creating new template Countries.", "name": "templateCountriesCriteria", "in": "body", "required": true, + "description": "Request object for creating new template Countries.", "schema": { "allOf": [ { @@ -6404,111 +5123,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/countries/guestTypes": { - "get": { - "description": "Use this API to get Country Guest Types.OperationId:getCountryGuestTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6516,143 +5201,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/countries/guestTypes": { + "get": { "summary": "Get Country Guest Types", + "description": "Use this API to get Country Guest Types.OperationId:getCountryGuestTypes
", "operationId": "getCountryGuestTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Philippines Country Guest Types.", - "schema": { - "$ref": "#/definitions/countryGuestTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Philippines Country Guest Types.", + "schema": { + "$ref": "#/definitions/countryGuestTypesDetails" } }, "204": { "description": "CountryGuestTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Country Guest Types.OperationId:postCountryGuestTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6661,15 +5323,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Country Guest Types", + "description": "Use this API to create Country Guest Types.OperationId:postCountryGuestTypes
", "operationId": "postCountryGuestTypes", "parameters": [ { - "description": "Request object for creating Country Guest Types.", "name": "countryGuestTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Country Guest Types.", "schema": { "allOf": [ { @@ -6679,111 +5344,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/countries/guestTypes/{guestTypeCode}": { - "put": { - "description": "Use this API to update country guest types based on guestTypeCode, countryGuestTypesToBeChanged.OperationId:changeCountryGuestTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6792,24 +5423,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/countries/guestTypes/{guestTypeCode}": { + "put": { "summary": "Change Country Guest Types", + "description": "Use this API to update Country Guest Types.OperationId:changeCountryGuestTypes
", "operationId": "changeCountryGuestTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of guest type.", "name": "guestTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of guest type." }, { - "description": "Request object for changing Philippines Country Guest Types.", "name": "countryGuestTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Philippines Country Guest Types.", "schema": { "allOf": [ { @@ -6819,109 +5455,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete country guest types based on guestTypeCode, countryGuestTypesCodes.OperationId:removeCountryGuestTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6930,135 +5534,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Country Guest Types", + "description": "Use this API to delete Country Guest Types.OperationId:removeCountryGuestTypes
", "operationId": "removeCountryGuestTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of guest type.", "name": "guestTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of guest type." }, { + "name": "countryGuestTypesCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "countryGuestTypesCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/countries/{countryCode}": { - "put": { - "description": "Use this API to update country templates based on countryCode, templateCountriesToBeChanged.OperationId:changeTemplateCountries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7066,25 +5640,30 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/countries/{countryCode}": { + "put": { "summary": "Change template Countries", + "description": "Use this API to update template Countries.OperationId:changeTemplateCountries
", "operationId": "changeTemplateCountries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of country.", "name": "countryCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of country." }, { - "description": "Request object for modifying template Countries.", "name": "templateCountriesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying template Countries.", "schema": { "allOf": [ { @@ -7094,109 +5673,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete country templates based on countryCode.OperationId:removeTemplateCountries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7205,125 +5752,94 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete template Countries", + "description": "Use this API to delete template Countries.OperationId:removeTemplateCountries
", "operationId": "removeTemplateCountries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of country.", "name": "countryCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of country." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/countryMainGroups": { - "get": { - "description": "Use this API to get Country Main Groups.OperationId:getCountryMainGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7331,143 +5847,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/countryMainGroups": { + "get": { "summary": "Get Country Main Groups", + "description": "Use this API to get Country Main Groups.OperationId:getCountryMainGroups
", "operationId": "getCountryMainGroups", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Country Main Groups.", - "schema": { - "$ref": "#/definitions/countryMainGroupsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Country Main Groups.", + "schema": { + "$ref": "#/definitions/countryMainGroupsDetails" } }, "204": { "description": "CountryMainGroups not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Country Main Groups.OperationId:postCountryMainGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7476,15 +5969,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Country Main Groups", + "description": "Use this API to create Country Main Groups.OperationId:postCountryMainGroups
", "operationId": "postCountryMainGroups", "parameters": [ { - "description": "Request object for creating Country Main Groups.", "name": "countryMainGroupsCriteria", "in": "body", "required": true, + "description": "Request object for creating Country Main Groups.", "schema": { "allOf": [ { @@ -7494,111 +5990,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/countryMainGroups/{groupCode}": { - "put": { - "description": "Use this API to update country main groups based on groupCode, countryMainGroupsToBeChanged.OperationId:changeCountryMainGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7607,24 +6069,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/countryMainGroups/{groupCode}": { + "put": { "summary": "Change Country Main Groups", + "description": "Use this API to update Country Main Groups.OperationId:changeCountryMainGroups
", "operationId": "changeCountryMainGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Groups.", "name": "groupCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Groups." }, { - "description": "Request object for changing Country Main Groups.", "name": "countryMainGroupsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Country Main Groups.", "schema": { "allOf": [ { @@ -7634,109 +6101,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete country main groups based on groupCode, countryMainGroupsCodes.OperationId:removeCountryMainGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7745,135 +6180,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Country Main Groups", + "description": "Use this API to delete Country Main Groups.OperationId:removeCountryMainGroups
", "operationId": "removeCountryMainGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Groups.", "name": "groupCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Groups." }, { + "name": "countryMainGroupsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "countryMainGroupsCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/currencyExchangeRates": { - "get": { - "description": "Fetch the currency exchange rates when using this API.OperationId:getCurrencyExchangeRates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -7881,12 +6286,22 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/currencyExchangeRates": { + "get": { "summary": "Get Currency Exchange Rates", + "description": "Fetch the currency exchange rates when using this API.OperationId:getCurrencyExchangeRates
", "operationId": "getCurrencyExchangeRates", "parameters": [ { + "name": "exchangeType", + "in": "query", + "required": false, + "type": "string", + "description": "Exchange Rate Types", "uniqueItems": true, "enum": [ "Posting", @@ -7897,144 +6312,109 @@ "Membership", "Exchangecheck", "Certificate" - ], - "type": "string", - "description": "Exchange Rate Types", - "name": "exchangeType", - "in": "query" + ] }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "List of Hotels for which the currency exchange rate information is required.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Currency Code for which the exchange rate is requested. Sending no currency code will return values for all available currency codes.", "name": "currencyCode", - "in": "query" + "in": "query", + "required": false, + "description": "Currency Code for which the exchange rate is requested. Sending no currency code will return values for all available currency codes.", + "type": "string" }, { + "name": "currencyCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "currencyCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "List of currency codes with their exchange rates.", - "schema": { - "$ref": "#/definitions/currencyExchangeRatesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "List of currency codes with their exchange rates.", + "schema": { + "$ref": "#/definitions/currencyExchangeRatesDetails" } }, "204": { "description": "CurrencyExchangeRates not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/dayTypeCodes": { - "get": { - "description": "Use this API to get Template Day Type Codes.OperationId:getTemplateDayTypeCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8043,130 +6423,105 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/dayTypeCodes": { + "get": { "summary": "Get Template Day Type Codes", + "description": "Use this API to get Template Day Type Codes.OperationId:getTemplateDayTypeCodes
", "operationId": "getTemplateDayTypeCodes", "parameters": [ { + "name": "dayTypesCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "dayTypesCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching template day type codes.", - "schema": { - "$ref": "#/definitions/templateDayTypeCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 day type codes.", + "schema": { + "$ref": "#/definitions/templateDayTypeCodesDetails" } }, "204": { "description": "TemplateDayTypeCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to update day type code templates based on templateDayTypeCodesToBeChanged.OperationId:changeTemplateDayTypeCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8175,15 +6530,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "put": { "summary": "Change Template Day Type Codes", + "description": "Use this API to update Template Day Type Codes.OperationId:changeTemplateDayTypeCodes
", "operationId": "changeTemplateDayTypeCodes", "parameters": [ { - "description": "Request object for modifying template day type codes.", "name": "templateDayTypeCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying template day type codes.", "schema": { "allOf": [ { @@ -8193,109 +6551,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Template Day Type Codes.OperationId:postTemplateDayTypeCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8304,127 +6630,96 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Create Template Day Type Codes", - "operationId": "postTemplateDayTypeCodes", + ] + }, + "delete": { + "summary": "Delete Template Day Type Codes", + "description": "Use this API to delete Template Day Type Codes.OperationId:removeTemplateDayTypeCodes
", + "operationId": "removeTemplateDayTypeCodes", "parameters": [ { - "description": "Request object for creating new template day type codes.", - "name": "templateDayTypeCodesCriteria", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/templateDayTypeCodesCriteria" - } - ] - } + "name": "templateDayTypeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete day type code templates based on templateDayTypeCodes.OperationId:removeTemplateDayTypeCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8433,126 +6728,98 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Delete Template Day Type Codes", - "operationId": "removeTemplateDayTypeCodes", + ] + }, + "post": { + "summary": "Create Template Day Type Codes", + "description": "Use this API to create Template Day Type Codes.OperationId:postTemplateDayTypeCodes
", + "operationId": "postTemplateDayTypeCodes", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "templateDayTypeCodes", - "in": "query" + "name": "templateDayTypeCodesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating new template day type codes.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/templateDayTypeCodesCriteria" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/dayTypes": { - "put": { - "description": "Use this API to update day types for a date range based on setDayTypes.OperationId:setDayTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8561,15 +6828,20 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/dayTypes": { + "put": { "summary": "Set day type for a date range", + "description": "You can use this API to set day type for a date range.OperationId:setDayTypes
", "operationId": "setDayTypes", "parameters": [ { - "description": "Request object for setting day type for specified date range.", "name": "setDayTypes", "in": "body", "required": true, + "description": "Request object for setting day type for specified date range.", "schema": { "allOf": [ { @@ -8579,111 +6851,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/dayTypes/{dayType}": { - "delete": { - "description": "Use this API to delete day types for a date range based on criteria such as dayType, hotelId, startDate, endDate, duration.OperationId:removeDayTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8692,187 +6930,169 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/dayTypes/{dayType}": { + "delete": { "summary": "Delete day type for a date range", + "description": "Use this API to delete day type for a date range.OperationId:removeDayTypes
", "operationId": "removeDayTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of day type.", "name": "dayType", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of day type." }, { + "name": "hotelId", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Day type code selected.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Day type code selected.", - "name": "hotelId", - "in": "query" + "required": false }, { - "type": "boolean", "name": "friday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "monday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "saturday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "sunday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "thursday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "tuesday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "wednesday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "string", - "format": "date", "name": "startDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", "name": "endDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", "name": "duration", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/defaultNote": { - "get": { - "description": "Use this API to get Default Note text.OperationId:getDefaultNote
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8880,134 +7100,108 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/defaultNote": { + "get": { "summary": "Get Default Note text", + "description": "Use this API to get Default Note text.OperationId:getDefaultNote
", "operationId": "getDefaultNote", "parameters": [ { - "type": "string", - "description": "Default Hotel Code for users", "name": "hotelId", - "in": "query" + "in": "query", + "required": false, + "description": "Default Hotel Code for users", + "type": "string" }, { - "type": "string", - "description": "Notes Group added to Search criteria", "name": "noteType", - "in": "query" + "in": "query", + "required": false, + "description": "Notes Group added to Search criteria", + "type": "string" }, { - "type": "string", - "description": "Code of the Note Type added to the Search criteria", "name": "noteCode", - "in": "query" + "in": "query", + "required": false, + "description": "Code of the Note Type added to the Search criteria", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Default Application Note text.", - "schema": { - "$ref": "#/definitions/defaultNoteDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Default Application Note text.", + "schema": { + "$ref": "#/definitions/defaultNoteDetails" } }, "204": { "description": "DefaultNote not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/departments": { - "get": { - "description": "Use this API to get Departments.OperationId:getDepartments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9015,141 +7209,117 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/departments": { + "get": { "summary": "Get Departments", + "description": "Use this API to get Departments.OperationId:getDepartments
", "operationId": "getDepartments", "parameters": [ { + "name": "hotelIds", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "hotelIds", - "in": "query" + "required": false }, { + "name": "departmentCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "departmentCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "departmentWildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching departments.", - "schema": { - "$ref": "#/definitions/departmentsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching departments.", + "schema": { + "$ref": "#/definitions/departmentsDetails" } }, "204": { "description": "Departments not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Departments.OperationId:postDepartments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9158,15 +7328,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Departments", + "description": "Use this API to create Departments.OperationId:postDepartments
", "operationId": "postDepartments", "parameters": [ { - "description": "Request object for creating new departments.", "name": "departmentsCriteria", "in": "body", "required": true, + "description": "Request object for creating new departments.", "schema": { "allOf": [ { @@ -9176,111 +7349,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/departments/{departmentCode}": { - "put": { - "description": "Use this API to update departments based on departmentCode, departmentsToBeChanged.OperationId:changeDepartments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9289,136 +7428,103 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Change Departments", - "operationId": "changeDepartments", + ] + } + }, + "/departments/{departmentCode}": { + "delete": { + "summary": "Delete Departments", + "description": "Use this API to delete Departments.OperationId:removeDepartments
", + "operationId": "removeDepartments", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of department.", "name": "departmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of department." }, { - "description": "Request object for updating departments.", - "name": "departmentsToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/departmentsToBeChanged" - } - ] - } + "name": "hotelId", + "in": "query", + "required": false, + "description": "Hotel where the code is configured.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete departments based on departmentCode, hotelId.OperationId:removeDepartments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9427,131 +7533,107 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Delete Departments", - "operationId": "removeDepartments", + ] + }, + "put": { + "summary": "Change Departments", + "description": "Use this API to update Departments.OperationId:changeDepartments
", + "operationId": "changeDepartments", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of department.", "name": "departmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of department." }, { - "type": "string", - "description": "Hotel where the code is configured.", - "name": "hotelId", - "in": "query" + "name": "departmentsToBeChanged", + "in": "body", + "required": true, + "description": "Request object for updating departments.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/departmentsToBeChanged" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotelCategories": { - "get": { - "description": ".OperationId:getHotelCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9559,143 +7641,144 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get Hotel Categories", - "operationId": "getHotelCategories", + "HotelConfig" + ] + } + }, + "/flexFields": { + "get": { + "summary": "Operation to fetch flex fields.", + "description": "API to fetch flex fields.OperationId:getFlexFields
", + "operationId": "getFlexFields", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" - }, - { + "name": "hotelIds", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Hotel code", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 50 }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "name": "flexFieldId", + "in": "query", + "type": "number", + "description": "Flex field ID", + "required": false }, { + "name": "code", + "in": "query", "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "description": "Flex field code", + "required": false }, { + "name": "module", + "in": "query", "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "description": "Flex field module", + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines whether to fetch inactive records or not", + "type": "boolean" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "name": "limit", + "in": "query", + "required": false, + "default": 50, + "maximum": 100, + "description": "Indicates maximum number of records a Web Service should return. Default is 50", + "type": "integer" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "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" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Hotel Categories.", - "schema": { - "$ref": "#/definitions/hotelCategoriesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching flex fields.", + "schema": { + "$ref": "#/definitions/flexFieldsResponse" } }, "204": { - "description": "HotelCategories not found." + "description": "Flex field details not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": ".OperationId:postHotelCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9704,129 +7787,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create Hotel Categories", - "operationId": "postHotelCategories", + ] + }, + "post": { + "summary": "Operation to create a flex field.", + "description": "Operation to create a flex field.OperationId:postFlexField
", + "operationId": "postFlexField", "parameters": [ { - "description": "Request object for creating Hotel Categories.", - "name": "hotelCategoriesCriteria", + "name": "flexFieldDetail", "in": "body", "required": true, + "description": "Request object to create a new flex field", "schema": { "allOf": [ { - "$ref": "#/definitions/hotelCategoriesCriteria" + "$ref": "#/definitions/flexFieldCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotelCategories/{categoryCode}": { - "put": { - "description": "Use this API to update hotel categories based on categoryCode, hotelCategoriesToBeChanged.OperationId:changeHotelCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9835,136 +7887,119 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change Hotel Categories", - "operationId": "changeHotelCategories", + ] + } + }, + "/hotelCategories": { + "get": { + "summary": "Get Hotel Categories", + "description": ".OperationId:getHotelCategories
", + "operationId": "getHotelCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Categories.", - "name": "categoryCode", - "in": "path", - "required": true + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { - "description": "Request object for changing Hotel Categories.", - "name": "hotelCategoriesToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/hotelCategoriesToBeChanged" - } - ] - } + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "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 Categories.", + "schema": { + "$ref": "#/definitions/hotelCategoriesDetails" } }, + "204": { + "description": "HotelCategories not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete hotel categories based on categoryCode.OperationId:removeHotelCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9973,125 +8008,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete Hotel Categories", - "operationId": "removeHotelCategories", + ] + }, + "post": { + "summary": "Create Hotel Categories", + "description": ".OperationId:postHotelCategories
", + "operationId": "postHotelCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Categories.", - "name": "categoryCode", - "in": "path", - "required": true + "name": "hotelCategoriesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Hotel Categories.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/hotelCategoriesCriteria" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotelDetails": { - "get": { - "description": "Use this API to get hotel details specified at the template level.OperationId:getTemplateHotelDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10099,134 +8107,316 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], - "summary": "Get hotel details specified at the template level", - "operationId": "getTemplateHotelDetails", + "ChainConfig" + ] + } + }, + "/hotelCategories/{categoryCode}": { + "put": { + "summary": "Change Hotel Categories", + "description": ".OperationId:changeHotelCategories
", + "operationId": "changeHotelCategories", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "hotelDetailCodes", - "in": "query" + "name": "categoryCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Categories." }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" + "name": "hotelCategoriesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing Hotel Categories.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/hotelCategoriesToBeChanged" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + } }, - "collectionFormat": "multi", - "name": "hotelDetailCategoriesCodes", - "in": "query" + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "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 Hotel Categories", + "description": ".OperationId:removeHotelCategories
", + "operationId": "removeHotelCategories", + "parameters": [ { + "name": "categoryCode", + "in": "path", + "required": true, "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Categories." }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching hotel details at the template level.", + "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/templateHotelDetailsDetails" + "$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" + ] + } + }, + "/hotelDetails": { + "get": { + "summary": "Get hotel details specified at the template level", + "description": "Use this API to get hotel details specified at the template level.OperationId:getTemplateHotelDetails
", + "operationId": "getTemplateHotelDetails", + "parameters": [ + { + "name": "hotelDetailCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "hotelDetailCategoriesCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 details at the template level.", + "schema": { + "$ref": "#/definitions/templateHotelDetailsDetails" } }, "204": { "description": "TemplateHotelDetails not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to update template hotel details based on templateHotelDetailsToBeChanged.OperationId:changeTemplateHotelDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10235,127 +8425,98 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Change hotel details specified at the template level", - "operationId": "changeTemplateHotelDetails", + ] + }, + "post": { + "summary": "Create hotel details at the template level", + "description": "Use this API to create hotel details at the template level.OperationId:postTemplateHotelDetails
", + "operationId": "postTemplateHotelDetails", "parameters": [ { - "description": "Request object for changing hotel details at the template level.", - "name": "templateHotelDetailsToBeChanged", + "name": "templateHotelDetailsCriteria", "in": "body", "required": true, + "description": "Request object for creating hotel details at the template level.", "schema": { "allOf": [ { - "$ref": "#/definitions/templateHotelDetailsToBeChanged" + "$ref": "#/definitions/templateHotelDetailsCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create hotel details at the template level.OperationId:postTemplateHotelDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10364,127 +8525,98 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Create hotel details at the template level", - "operationId": "postTemplateHotelDetails", + ] + }, + "put": { + "summary": "Change hotel details specified at the template level", + "description": "Use this API to update hotel details specified at the template level.OperationId:changeTemplateHotelDetails
", + "operationId": "changeTemplateHotelDetails", "parameters": [ { - "description": "Request object for creating hotel details at the template level.", - "name": "templateHotelDetailsCriteria", + "name": "templateHotelDetailsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing hotel details at the template level.", "schema": { "allOf": [ { - "$ref": "#/definitions/templateHotelDetailsCriteria" + "$ref": "#/definitions/templateHotelDetailsToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete template hotel details based on templateHotelDetailCode, templateHotelDetailCategory.OperationId:removeTemplateHotelDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10493,136 +8625,107 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete hotel details specified at the template level", + "description": "Use this API to delete hotel details specified at the template level.OperationId:removeTemplateHotelDetails
", "operationId": "removeTemplateHotelDetails", "parameters": [ { + "name": "templateHotelDetailCode", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Specifies the hotel detail code.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Specifies the hotel detail code.", - "name": "templateHotelDetailCode", - "in": "query" + "required": false }, { + "name": "templateHotelDetailCategory", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Specifies the hotel detail category.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Specifies the hotel detail category.", - "name": "templateHotelDetailCategory", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotelDetails/copy": { - "put": { - "description": "Use this API to copy template hotel details to other properties.OperationId:copyHotelDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10631,15 +8734,20 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotelDetails/copy": { + "put": { "summary": "Copy template hotel details to other properties", + "description": "Use this API to copy template hotel details to other properties.OperationId:copyHotelDetails
", "operationId": "copyHotelDetails", "parameters": [ { - "description": "Request object for copying template hotel details to hotel(s).", "name": "copyHotelDetails", "in": "body", "required": true, + "description": "Request object for copying template hotel details to hotel(s).", "schema": { "allOf": [ { @@ -10649,111 +8757,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels": { - "get": { - "description": "Use this API to return hotel configuration information based on search criteria such as hotelId, name.OperationId:getHotels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10762,127 +8836,154 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels": { + "get": { "summary": "Get property configuration", + "description": "Use this API to return hotel configuration information based on search criteria such as hotelId, name.OperationId:getHotels
", "operationId": "getHotels", "parameters": [ { - "type": "string", - "description": "Code identifying the hotel.", "name": "hotelId", - "in": "query" + "in": "query", + "required": false, + "description": "Code identifying the hotel.", + "type": "string" }, { - "type": "string", - "description": "Hotel name to be searched.", "name": "name", - "in": "query" + "in": "query", + "required": false, + "description": "Hotel name to be searched.", + "type": "string" }, { + "name": "countryCode", + "description": "Code for a country or a nationality (e.g. SW, USA, IN). This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/Countries", + "in": "query", + "required": false, "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "minLength": 0, + "maxLength": 10 }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", + "name": "marketingRegionCode", + "description": "Marketing Region Code where the given cities are located. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/MarketingRegions", + "in": "query", + "required": false, "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "minLength": 0, + "maxLength": 40 }, { + "name": "marketingCity", + "description": "Marketing City where the properties are located. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/MarketingCityTemplates", + "in": "query", + "required": false, "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "minLength": 0, + "maxLength": 40 }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "name": "propertyTypeCode", + "in": "query", + "required": false, + "type": "array", + "description": "Property Type to filter the search result. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/HotelTypes", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + } }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Indicates the search mode to further filter the properties, ex: when it is marked as CateringEvent, it should fetch the CATERING_EVENTS active properties", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "CateringEvent" + ] + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching lists of Property summary information.", - "schema": { - "$ref": "#/definitions/hotelsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching lists of Property summary information.", + "schema": { + "$ref": "#/definitions/hotelsDetails" } }, "204": { "description": "Hotels not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/attractions/{attractionCode}": { - "delete": { - "description": "Use this API to delete attractions by code based on attractionCode.OperationId:removeAttractionsByCode
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10891,135 +8992,107 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/attractions/{attractionCode}": { + "delete": { "summary": "Delete Attractions", + "description": " Use this API to remove an existing attraction.OperationId:removeAttractionsByCode
", "operationId": "removeAttractionsByCode", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of attraction.", "name": "attractionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of attraction." }, { + "name": "hotelId", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Hotel where the code is configured.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Hotel where the code is configured.", - "name": "hotelId", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}": { - "get": { - "description": "Use this API to return hotel configuration information details for a specific property. Specific areas of configuration can be returned based on the fetchInstructions query parameter such as General, Attraction, Airports, Alternatehotels, Raterange, etc.OperationId:getHotel
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11028,23 +9101,33 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}": { + "get": { "summary": "Get hotel property configuration details", + "description": "Use this API to return hotel configuration information details for a specific property. Specific areas of configuration can be returned based on the fetchInstructions query parameter such as General, Attraction, Airports, Alternatehotels, Raterange, etc.OperationId:getHotel
", "operationId": "getHotel", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "uniqueItems": true, + "name": "fetchInstructions", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for hotel fetch instruction.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "General", "Attraction", @@ -11063,604 +9146,714 @@ "Notes", "Corporateinformation", "Meetingrooms" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for hotel fetch instruction.", - "name": "fetchInstructions", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Property configuration information.", - "schema": { - "$ref": "#/definitions/hotelDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, + "description": "Response object for fetching Property configuration information.", + "schema": { + "$ref": "#/definitions/hotelDetails" + }, "examples": { "application/json": { "hotelConfigInfo": { + "primaryDetails": { + "legalOwner": "string" + }, + "generalInformation": { + "hotelType": "string", + "roomCount": 0, + "bedCount": 0, + "floorCount": 0, + "checkInTime": "2020-08-26T15:00:10.503Z", + "checkOutTime": "2020-08-26T15:00:10.503Z", + "hotelInfoWebsite": { + "value": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 + }, + "longitude": 0, + "latitude": 0, + "baseLanguage": "string" + }, "accommodationDetails": { - "accessibleRooms": 0, - "connectingRooms": 0, + "singleRooms": 0, "doubleRooms": 0, - "executiveFloorNo": "string", + "twinRooms": 0, "familyRooms": 0, - "guestRoomElevators": 0, - "guestRoomFloors": 0, + "connectingRooms": 0, + "accessibleRooms": 0, + "nonSmokingRooms": 0, "maxAdultsInFamilyRoom": 0, "maxChildrenInFamilyRoom": 0, - "nonSmokingRooms": 0, - "roomAmenties": "string", - "shopDescription": "string", - "singleRooms": 0, + "guestRoomFloors": 0, + "guestRoomElevators": 0, "suites": 0, - "twinRooms": 0 + "executiveFloorNo": "string", + "roomAmenties": "string", + "shopDescription": "string" + }, + "propertyControls": { + "sellControls": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "hotelId": "string" + }, + "currencyFormatting": { + "currencyCode": "string", + "currencyFormat": "string", + "currencySymbol": "string", + "decimalPositions": 0 + }, + "cateringCurrencyFormatting": { + "currencyCode": "string", + "currencyFormat": "string" + }, + "dateTimeFormatting": { + "longDateFormat": "string", + "shortDateFormat": "string", + "timeFormat": "string", + "timeZoneRegion": "string" + }, + "applicationMode": { + "configurationMode": "string", + "countryMode": "string", + "expHotelCode": "string", + "touristNumber": "string", + "mbsSupported": true + } + }, + "communication": { + "phoneNumber": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.503Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.503Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "tollFreeNumber": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.503Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.503Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "faxNumber": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.503Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.503Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "emailAddress": "string", + "webPage": { + "value": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 + } }, "address": { "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", "createDateTime": "2020-08-26T15:00:10.503Z", "creatorId": "string", - "language": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:00:10.503Z", - "postalCode": "string", - "primaryInd": true, + "lastModifierId": "string", "purgeDate": "2020-08-26", - "regionCode": "string", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true + "regionCode": "string" }, + "hotelRestaurants": [ + { + "restaurantName": "string", + "restaurantType": "string", + "hours": "string", + "priceRange": "string", + "comments": "string", + "category": "Restaurant", + "timeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "newRestaurantCode": "string", + "restaurantCode": "string", + "orderBy": 0, + "hotelId": "string" + } + ], + "hotelRateRanges": [ + { + "timeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "minRate": 0, + "maxRate": 0, + "currencyCode": "string", + "hotelId": "string" + } + ], "alternateHotels": [ { "address": { "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", - "createDateTime": "2020-08-26T15:00:10.504Z", - "creatorId": "string", "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.504Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", "type": "string", "typeDescription": "string", - "updateReservations": true - }, - "alternate": true, - "alternateHotelCode": "string", - "availableRooms": 0, - "chainCode": "string", - "chainName": "string", - "channelSummaryInfo": { - "bookingChannel": { - "channelCode": "string", - "channelName": "string", - "channelType": "string" - }, - "messageId": "string", - "summaryOnly": true + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:00:10.504Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.504Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, - "comments": "string", "contactNumbers": [ { - "createDateTime": "2020-08-26T15:00:10.504Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.504Z", - "orderSequence": 0, - "phoneNumber": "string", "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.504Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.504Z", + "lastModifierId": "string", "purgeDate": "2020-08-26" } ], - "currencyExchangeRates": [ - { - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "exchangeRate": { - "amount": 0, - "currencyCode": "string" - } - } - ], - "direction": "string", - "displayOrder": 0, - "event": true, - "hotelAmenities": [ - { - "code": "string", - "description": "string", - "displayOrder": 0, - "type": "string" - } - ], - "hotelCityCode": "string", - "hotelCodeContext": "string", - "hotelId": "string", - "hotelName": "string", - "hotelType": "string", - "inventoryRooms": 0, - "maxRate": { + "minRate": { "amount": 0, "currencyCode": "string" }, - "minRate": { + "maxRate": { "amount": 0, "currencyCode": "string" }, - "negotiated": true, - "newAlternateHotelCode": "string", + "relativePosition": { + "distance": 0, + "distanceType": "string", + "drivingTime": "string" + }, + "hotelAmenities": [ + { + "description": "string", + "code": "string", + "type": "string", + "displayOrder": 0 + } + ], + "event": true, "rateRoomDetails": { "memberships": [ { - "associatedReservationsOnly": true, "membershipId": "string", "membershipLevel": [ "string" ], "membershipType": [ "string" - ] + ], + "associatedReservationsOnly": true } ], "restrictionType": "Closed", "roomStays": [ { - "arrivalDate": "2020-08-26", - "bookingMedium": "string", - "bookingMediumDescription": "string", - "departureDate": "2020-08-26", - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-08-26T15:00:10.520Z", - "reservationExpectedDepartureTime": "2020-08-26T15:00:10.520Z" - }, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestCounts": { - "adults": 0, - "childAges": [ - { - "age": 0 - } - ], - "childBuckets": { - "bucket1Count": 0, - "bucket2Count": 0, - "bucket3Count": 0, - "bucket4Count": 0, - "bucket5Count": 0 - }, - "children": 0 - }, - "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", - "keyReady": "Pending", - "requiresAction": true, - "roomReady": "Pending" - }, - "multiValueAttrs": [ - "string" - ], - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" - }, - "primaryShareType": "Primary", - "printRate": true, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "remoteCheckInAllowed": true, - "roomNumberLocked": true, "roomRates": [ { - "availability": "Available", - "awards": { - "awardVouchers": [ - { - "awardCode": "string", - "voucherNo": "string" - } - ], - "membershipNo": { - "id": "string", - "type": "string" + "total": { + "taxes": { + "tax": [ + { + "description": "string", + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" + } + ], + "amount": 0, + "currencyCode": "string" }, - "originalRoomType": "string", - "upgradeRoomType": "string" - }, - "barRanking": 0, - "bogoDiscount": true, - "commissionAmount": 0, - "commissionCode": "string", - "commissionPercentage": 0, - "commissionable": true, - "complimentary": true, - "credentialsRequired": true, - "discountAllowed": true, - "end": "2020-08-26", - "fixedRate": true, - "foreignExchange": { - "effectiveDate": "2020-08-26", - "type": "string" - }, - "guestCounts": { - "adults": 0, - "childAges": [ - { - "age": 0 - } - ], - "childBuckets": { - "bucket1Count": 0, - "bucket2Count": 0, - "bucket3Count": 0, - "bucket4Count": 0, - "bucket5Count": 0 + "fees": { + "fee": [ + { + "description": "string", + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" + } + ], + "amount": 0, + "currencyCode": "string" }, - "children": 0 + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true + }, + "totalPoints": { + "awardsType": "string", + "points": 0 }, - "houseUseOnly": true, - "inventoryLender": "string", - "marketCode": "string", - "marketCodeDescription": "string", - "mealPlans": [ - { - "breakfastIncluded": true, - "code": "string", - "dinnerIncluded": true, - "included": true, - "lunchIncluded": true - } - ], - "numberOfUnits": 0, - "packages": [ - { - "addRateCombinedLine": true, - "addRateSeprateLine": true, - "allowance": { - "amount": 0, - "currencyCode": "string" - }, - "amount": { - "amount": 0, - "currencyCode": "string" - }, - "calculationRule": "string", - "description": [ - "string" - ], - "endDate": "2020-08-26", - "endTime": "string", - "includedInRate": true, - "packageCode": "string", - "postingRhythm": "string", - "quantity": 0, - "sellSeparate": true, - "startDate": "2020-08-26", - "startTime": "string" - } - ], - "promotionCode": "string", - "pseudoRoom": true, - "rateDescription": "string", - "rateGroup": "string", - "rateLevel": "string", - "ratePlanCode": "string", "rates": { "rate": [ { + "base": { + "taxes": { + "tax": [ + { + "description": "string", + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" + } + ], + "amount": 0, + "currencyCode": "string" + }, + "fees": { + "fee": [ + { + "description": "string", + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" + } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true + }, "additionalGuestAmounts": [ { - "ageQualifyingCode": "ADULT", "amount": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ + "taxes": { + "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - }, - "rateOverride": true, - "taxes": { + ], "amount": 0, - "currencyCode": "string", - "tax": [ + "currencyCode": "string" + }, + "fees": { + "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true + }, + "ageQualifyingCode": "ADULT" } ], - "base": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", + "discount": { + "discountReason": "string", + "percent": 0, + "amount": 0, "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ - { - "amount": 0, - "code": "string", - "currencyCode": "string", - "description": "string", - "type": "Inclusive" - } - ] - }, - "rateOverride": true, + "discountCode": "string" + }, + "shareRatePercentage": 0, + "shareDistributionInstruction": "Full", + "total": { "taxes": { - "amount": 0, - "currencyCode": "string", "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } - }, - "discount": { - "amount": 0, - "currencyCode": "string", - "discountCode": "string", - "discountReason": "string", - "percent": 0 - }, - "effectiveRate": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { + ], "amount": 0, - "currencyCode": "string", + "currencyCode": "string" + }, + "fees": { "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" - } - ] - }, - "rateOverride": true, - "taxes": { - "amount": 0, - "currencyCode": "string", - "tax": [ - { - "amount": 0, + "type": "Inclusive", "code": "string", - "currencyCode": "string", - "description": "string", - "type": "Inclusive" + "amount": 0, + "currencyCode": "string" } - ] - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true }, - "end": "2020-08-26", "requiredPoints": { "awardsType": "string", "points": 0 }, - "shareDistributionInstruction": "Full", - "shareRatePercentage": 0, - "start": "2020-08-26", - "total": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ + "effectiveRate": { + "taxes": { + "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - }, - "rateOverride": true, - "taxes": { + ], "amount": 0, - "currencyCode": "string", - "tax": [ + "currencyCode": "string" + }, + "fees": { + "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true + }, + "start": "2020-08-26", + "end": "2020-08-26" } ], "rateRange": [ { "base": [ { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ + "taxes": { + "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - }, - "rateOverride": true, - "taxes": { + ], "amount": 0, - "currencyCode": "string", - "tax": [ + "currencyCode": "string" + }, + "fees": { + "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true } ], "rateChange": true } ] }, - "reservationBlock": { - "blockIdList": [ - { - "id": "string", - "type": "string" - } - ], - "blockName": "string", - "hotelId": "string" - }, - "roomId": "string", - "roomRateInfo": "string", - "roomType": "string", - "roomTypeCharged": "string", - "sourceCode": "string", - "sourceCodeDescription": "string", - "start": "2020-08-26", + "packages": [ + { + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "allowance": { + "amount": 0, + "currencyCode": "string" + }, + "description": [ + "string" + ], + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "packageCode": "string", + "calculationRule": "string", + "postingRhythm": "string", + "quantity": 0, + "includedInRate": true, + "addRateSeprateLine": true, + "addRateCombinedLine": true, + "startTime": "string", + "endTime": "string", + "sellSeparate": true + } + ], "stayProfiles": [ { + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ], "profile": { + "customer": { + "personName": [ + { + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "surname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameTitleSuffix": 0, + "envelopeGreeting": "string", + "salutation": "string", + "nameType": "Primary", + "language": "string", + "externalSystem": "string" + } + ], + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-08-26T15:00:10.506Z" + }, + "citizenCountry": { + "value": "string", + "code": "string" + }, + "identifications": { + "identificationInfo": [ + { + "identification": { + "idType": "string", + "idNumber": "string", + "idNumberMasked": "string", + "issuedCountry": "string", + "issuedDate": "2020-08-26", + "issuedPlace": "string", + "expirationDate": "2020-08-26", + "registeredProperty": "string", + "primaryInd": true, + "orderSequence": 0 + }, + "id": "string", + "type": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "profession": "string", + "alienInfo": { + "alienRegistrationNo": "string", + "immigrationStatus": "string", + "visaValidityType": "string" + }, + "birthCountry": { + "value": "string", + "code": "string" + }, + "legalCompany": "string", + "companyInfo": { + "legalCompany": "string", + "department": "string", + "position": "string" + }, + "businessTitle": "string", + "gender": "Male", + "birthDate": "2020-08-26", + "birthDateMasked": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "language": "string", + "nationality": "string", + "nationalityDescription": "string", + "customerValue": "string", + "creditRating": "string", + "vipStatus": "string", + "vipDescription": "string", + "birthPlace": "string", + "privateProfile": true, + "blacklist": true + }, + "company": { + "companyName": "string", + "companyName2": "string", + "companyName3": "string", + "alternateName": "string", + "alternateLanguage": "string", + "businessLocale": "string", + "iATAInfo": { + "iATACompany": "string", + "iATAConsortia": "string", + "iATAValidationResult": true + }, + "businessTitle": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "language": "string", + "nationality": "string", + "nationalityDescription": "string", + "commissionCode": "string", + "creditRating": "string", + "corporateIdType": "string", + "vipStatus": "string", + "vipDescription": "string", + "blacklist": true + }, + "profileImage": { + "language": "string", + "imageSet": "string", + "sequenceId": 0, + "imageStyle": "Full", + "imageType": "string", + "hotelId": "string", + "chainCode": "string", + "imageURL": "string", + "description": "string", + "imageOrder": 0, + "website": "string" + }, "addresses": { "addressInfo": [ { @@ -11668,600 +9861,328 @@ "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", - "createDateTime": "2020-08-26T15:00:10.507Z", - "creatorId": "string", "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.507Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", "type": "string", "typeDescription": "string", - "updateReservations": true + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:00:10.507Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.507Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, "id": "string", "type": "string" } ], - "count": 0, "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, "businessSegments": [ "string" ], - "cashiering": { - "arNoCentral": "string", - "autoFolioSettlementType": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "directBillingList": [ + "territory": "string", + "traceCode": "string", + "ownerCode": "string", + "influenceCode": "string", + "telephones": { + "telephoneInfo": [ + { + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.507Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.507Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "emails": { + "emailInfo": [ { - "aRNumber": "string", - "hotelId": "string" + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.507Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.507Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" } ], - "paymentDueDays": 0, - "referenceCurrency": "string", - "taxPercent1": 0, - "taxPercent2": 0, - "taxPercent3": 0, - "taxPercent4": 0, - "taxPercent5": 0, - "vATOffsetYN": "string" + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "uRLs": { + "uRLInfo": [ + { + "url": { + "value": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 + }, + "id": "string", + "type": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 }, "comments": { "commentInfo": [ { "comment": { - "actionDate": "2020-08-26", - "actionType": "string", + "text": { + "value": "string", + "language": "string" + }, + "image": "string", + "url": "string", "commentTitle": "string", + "notificationLocation": "string", + "type": "string", + "typeDescription": "string", + "internal": true, "confidential": true, + "overrideInternal": true, + "protectDescription": true, + "hotelId": "string", + "actionType": "string", + "actionDate": "2020-08-26", "createDateTime": "2020-08-26T15:00:10.507Z", "creatorId": "string", - "hotelId": "string", - "image": "string", - "internal": true, - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:00:10.507Z", - "notificationLocation": "string", - "overrideInternal": true, - "protectDescription": true, - "purgeDate": "2020-08-26", - "text": { - "language": "string", - "value": "string" - }, - "type": "string", - "typeDescription": "string", - "url": "string" + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, "createDateTime": "2020-08-26T15:00:10.507Z", "creatorId": "string", - "id": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:00:10.507Z", + "lastModifierId": "string", "purgeDate": "2020-08-26", + "id": "string", "type": "string" } ], - "count": 0, "hasMore": true, - "totalResults": 0 - }, - "commissionInfoList": [ - { - "bankAccount": "string", - "commissionCode": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "hotelId": "string", - "paymentMethod": "Cent" - } - ], - "company": { - "alternateLanguage": "string", - "alternateName": "string", - "blacklist": true, - "businessLocale": "string", - "businessTitle": "string", - "commissionCode": "string", - "companyName": "string", - "companyName2": "string", - "companyName3": "string", - "corporateIdType": "string", - "creditRating": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "iATAInfo": { - "iATACompany": "string", - "iATAConsortia": "string", - "iATAValidationResult": true - }, - "language": "string", - "nationality": "string", - "nationalityDescription": "string", - "vipDescription": "string", - "vipStatus": "string" + "totalResults": 0, + "count": 0 }, - "createDateTime": "2020-08-26T15:00:10.519Z", - "creatorId": "string", - "customer": { - "alienInfo": { - "alienRegistrationNo": "string", - "immigrationStatus": "string", - "visaValidityType": "string" - }, - "anonymization": { - "anonymizationDate": "2020-08-26T15:00:10.506Z", - "anonymizationStatus": "Requested" - }, - "birthCountry": { - "code": "string", - "value": "string" - }, - "birthDate": "2020-08-26", - "birthDateMasked": "string", - "birthPlace": "string", - "blacklist": true, - "businessTitle": "string", - "citizenCountry": { - "code": "string", - "value": "string" - }, - "companyInfo": { - "department": "string", - "legalCompany": "string", - "position": "string" - }, - "creditRating": "string", - "currencyCode": "string", - "currencySymbol": "string", - "customerValue": "string", - "decimalPlaces": 0, - "gender": "Male", - "identifications": { - "count": 0, - "hasMore": true, - "identificationInfo": [ - { + "profileDeliveryMethods": { + "profileDeliveryMethod": [ + { + "deliveryId": { "id": "string", - "identification": { - "expirationDate": "2020-08-26", - "idNumber": "string", - "idNumberMasked": "string", - "idType": "string", - "issuedCountry": "string", - "issuedDate": "2020-08-26", - "issuedPlace": "string", - "orderSequence": 0, - "primaryInd": true, - "registeredProperty": "string" - }, "type": "string" - } - ], - "totalResults": 0 - }, - "language": "string", - "legalCompany": "string", - "nationality": "string", - "nationalityDescription": "string", - "personName": [ - { - "envelopeGreeting": "string", - "externalSystem": "string", - "givenName": "string", - "language": "string", - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameTitleSuffix": 0, - "nameType": "Primary", - "salutation": "string", - "surname": "string" + }, + "deliveryType": "string", + "deliveryValue": "string", + "hotelId": "string", + "deliveryModule": "EfolioExport", + "primaryInd": true, + "orderSequence": 0 } ], - "privateProfile": true, - "profession": "string", - "vipDescription": "string", - "vipStatus": "string" + "hasMore": true, + "totalResults": 0, + "count": 0 }, - "eCertificates": [ - { - "awardId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - }, - "awardPoints": 0, - "cancelRequestDate": "2020-08-26", - "certificateId": 0, - "certificateNo": "string", - "consumptionDetail": { - "authorizationCode": "string", - "date": "2020-08-26", - "email": "string", - "firstName": "string", - "hotelId": "string", - "locationType": "string", - "middleName": "string", - "referenceId": { - "id": "string", - "type": "string" - }, - "serviceDate": "2020-08-26", - "source": "Central", - "surname": "string", - "userName": "string", - "userNotes": "string" - }, - "databaseId": "string", - "eCertificateInfo": { - "awardCode": "string", - "benefitSummary": "string", - "certificateType": "string", - "cost": { - "amount": 0, - "currencyCode": "string" - }, - "description": "string", - "hotels": { - "code": [ - "string" - ], - "scope": "Global" - }, - "label": "string", - "longDescription": "string", - "maxExtensionAllowed": 0, - "membershipType": "string", - "promotionCode": "string", - "usageCriteria": { - "benefit": true, - "cancelAllowed": true, - "generateInLieuCertificate": true, - "hotel": true, - "reservation": true, - "verifyCertificateNo": true, - "web": true, - "webAllowed": true - }, - "value": { - "amount": 0, - "currencyCode": "string" - }, - "voucherBenefitCode": "string" - }, - "expiryDate": "2020-08-26", - "extensionCount": 0, - "generationDetail": { - "generationDetail": "string", - "referenceValue": "string", - "ruleId": { - "id": "string", - "type": "string" - } - }, - "inLieuSequence": 0, - "inactiveDate": "2020-08-26", - "issueDate": "2020-08-26", - "issueType": "Assigned", - "newExpiryDate": "2020-08-26", - "originalCertificateNo": "string", - "originalVoucherNo": "string", - "printed": true, - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - }, - "source": "Opera", - "status": "Cancelled", - "voucherNo": "string" - } - ], - "eligibleForFiscalFolio": "string", - "emails": { - "count": 0, - "emailInfo": [ + "profileMemberships": { + "profileMembership": [ { - "email": { - "createDateTime": "2020-08-26T15:00:10.507Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.507Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" + "comment": { + "text": { + "value": "string", + "language": "string" + }, + "image": "string", + "url": "string" }, - "id": "string", - "type": "string" + "newMembershipNumber": "string", + "nameOnCard": "string", + "programDescription": "string", + "membershipLevel": "string", + "membershipLevelDescription": "string", + "membershipClass": "string", + "earningPreference": "Points", + "inactive": true, + "benefits": [ + { + "code": "string", + "message": "string", + "inactive": true + } + ], + "tierAdministration": "Disabled", + "downgrade": "Grace", + "reIssueNewCard": "Pending", + "excludeFromBatch": true, + "upgradeDescription": "string", + "downgradeDescription": "string", + "rating": "string", + "membershipEnrollmentCode": "string", + "memberStatus": "string", + "currentPoints": 0, + "pointsLabel": "string", + "enrollmentSource": "string", + "enrollmentResort": "string", + "preferredCard": true, + "membershipId": "string", + "membershipType": "string", + "primaryMembershipYn": "string", + "primaryMembership": true, + "membershipIdNo": 0, + "playerRanking": 0, + "centralSetup": true, + "signupDate": "2020-08-26", + "effectiveDate": "2020-08-26", + "expireDate": "2020-08-26", + "expireDateExclusiveIndicator": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.508Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.508Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "gdsNegotiatedRates": { - "count": 0, - "gdsNegotiatedRate": [ + "preferenceCollection": { + "preferenceType": [ { - "bookingChannelCode": "string", - "channelRatePlanCode": "string", - "gdsNegotiatedInfoList": [ + "preference": [ { - "accessCode": "string", - "end": "2020-08-26", - "inactive": true, - "order": 0, - "start": "2020-08-26" + "preferenceValue": "string", + "description": "string", + "global": true, + "source": "string", + "hotels": [ + "string" + ], + "preferenceId": "string", + "excludedPreferencesCount": 0 } ], - "hotelId": "string" + "preferenceType": "string", + "preferenceTypeDescription": "string", + "sequence": "string", + "maxQuantity": 0, + "availableQuantity": 0, + "maxResortUsedQuantity": 0, + "reservationPreference": true, + "createDateTime": "2020-08-26T15:00:10.508Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.508Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "hasCommission": true, - "influenceCode": "string", - "inheritedNegRates": true, "keywords": { - "count": 0, - "hasMore": true, "keyword": [ { - "keyword": "string", "keywordDetail": { "newKeyword": "string" }, - "type": "string" + "type": "string", + "keyword": "string" } ], - "totalResults": 0 - }, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.519Z", - "lastStayInfo": { - "lastRate": { - "amount": 0, - "currencyCode": "string" - }, - "lastRoom": "string", - "lastVisit": "2020-08-26", - "totalStay": 0 - }, - "localizationGuestType": "string", - "mailingActions": { - "active": true, - "count": 0, "hasMore": true, - "mailingAction": [ - { - "code": "string", - "description": "string" - } - ], - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "markAsRecentlyAccessed": true, - "markForHistory": true, "negotiatedRates": { - "count": 0, - "hasMore": true, "negotiatedRate": [ { - "hotelId": "string", "negotiatedInfoList": [ { - "comissionCode": "string", "corporateAgreementId": "string", - "end": "2020-08-26", - "inactive": true, + "comissionCode": "string", "order": 0, - "start": "2020-08-26" + "inactive": true, + "start": "2020-08-26", + "end": "2020-08-26" } ], + "hotelId": "string", "rateCode": "string" } ], - "totalResults": 0 - }, - "ownerCode": "string", - "preferenceCollection": { - "count": 0, "hasMore": true, - "preferenceType": [ + "totalResults": 0, + "count": 0 + }, + "gdsNegotiatedRates": { + "gdsNegotiatedRate": [ { - "availableQuantity": 0, - "createDateTime": "2020-08-26T15:00:10.508Z", - "creatorId": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.508Z", - "maxQuantity": 0, - "maxResortUsedQuantity": 0, - "preference": [ + "gdsNegotiatedInfoList": [ { - "description": "string", - "excludedPreferencesCount": 0, - "global": true, - "hotels": [ - "string" - ], - "preferenceId": "string", - "preferenceValue": "string", - "source": "string" + "accessCode": "string", + "order": 0, + "inactive": true, + "start": "2020-08-26", + "end": "2020-08-26" } ], - "preferenceType": "string", - "preferenceTypeDescription": "string", - "purgeDate": "2020-08-26", - "reservationPreference": true, - "sequence": "string" - } - ], - "totalResults": 0 - }, - "privacyInfo": { - "allowEmail": true, - "allowPhone": true, - "allowSMS": true, - "autoEnrollLoyaltyProgram": true, - "infoFromThirdParty": true, - "lastPrivacyPromptDate": "2020-08-26", - "marketResearchParticipation": true, - "optInAutoEnrollmentMember": true, - "optInEmail": true, - "optInMailingList": true, - "optInMarketResearch": true, - "optInPhone": true, - "optInSms": true, - "optInThirdParty": true - }, - "profileAccessType": { - "chainCode": "string", - "croCode": "string", - "hotelId": "string", - "sharedLevel": "Global" - }, - "profileDeliveryMethods": { - "count": 0, - "hasMore": true, - "profileDeliveryMethod": [ - { - "deliveryId": { - "id": "string", - "type": "string" - }, - "deliveryModule": "EfolioExport", - "deliveryType": "string", - "deliveryValue": "string", + "bookingChannelCode": "string", "hotelId": "string", - "orderSequence": 0, - "primaryInd": true + "channelRatePlanCode": "string" } ], - "totalResults": 0 - }, - "profileImage": { - "chainCode": "string", - "description": "string", - "hotelId": "string", - "imageOrder": 0, - "imageSet": "string", - "imageStyle": "Full", - "imageType": "string", - "imageURL": "string", - "language": "string", - "sequenceId": 0, - "website": "string" + "hasMore": true, + "totalResults": 0, + "count": 0 }, "profileIndicators": [ { - "count": 0, - "indicatorName": "string" + "indicatorName": "string", + "count": 0 } ], - "profileMemberships": { - "count": 0, - "hasMore": true, - "profileMembership": [ - { - "benefits": [ - { - "code": "string", - "inactive": true, - "message": "string" - } - ], - "centralSetup": true, - "comment": { - "image": "string", - "text": { - "language": "string", - "value": "string" - }, - "url": "string" - }, - "createDateTime": "2020-08-26T15:00:10.508Z", - "creatorId": "string", - "currentPoints": 0, - "downgrade": "Grace", - "downgradeDescription": "string", - "earningPreference": "Points", - "effectiveDate": "2020-08-26", - "enrollmentResort": "string", - "enrollmentSource": "string", - "excludeFromBatch": true, - "expireDate": "2020-08-26", - "expireDateExclusiveIndicator": true, - "inactive": true, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.508Z", - "memberStatus": "string", - "membershipClass": "string", - "membershipEnrollmentCode": "string", - "membershipId": "string", - "membershipIdNo": 0, - "membershipLevel": "string", - "membershipLevelDescription": "string", - "membershipType": "string", - "nameOnCard": "string", - "newMembershipNumber": "string", - "orderSequence": 0, - "playerRanking": 0, - "pointsLabel": "string", - "preferredCard": true, - "primaryMembership": true, - "primaryMembershipYn": "string", - "programDescription": "string", - "purgeDate": "2020-08-26", - "rating": "string", - "reIssueNewCard": "Pending", - "signupDate": "2020-08-26", - "tierAdministration": "Disabled", - "upgradeDescription": "string" - } - ], - "totalResults": 0 - }, - "profileRestrictions": { - "reason": "string", - "reasonDescription": "string", - "restricted": true - }, - "profileType": "Guest", - "protectedBy": "string", - "purgeDate": "2020-08-26", - "registeredProperty": "string", "relationships": { - "count": 0, - "hasMore": true, "relationship": [ { "changeRelationship": { @@ -12271,256 +10192,267 @@ "targetRelation": "string", "targetRelationDescription": "string" }, - "id": "string", - "masterAccountInfo": { - "masterAccountId": { - "id": "string", - "type": "string" - }, - "masterAccountName": "string" - }, - "relation": "string", - "relationDescription": "string", "relationshipProfile": { - "address": { - "address": { - "addressLine": [ - "string" + "customer": { + "personName": [ + { + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "surname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameTitleSuffix": 0, + "envelopeGreeting": "string", + "salutation": "string", + "nameType": "Primary", + "language": "string", + "externalSystem": "string" + } + ], + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-08-26T15:00:10.508Z" + }, + "citizenCountry": { + "value": "string", + "code": "string" + }, + "identifications": { + "identificationInfo": [ + { + "identification": { + "idType": "string", + "idNumber": "string", + "idNumberMasked": "string", + "issuedCountry": "string", + "issuedDate": "2020-08-26", + "issuedPlace": "string", + "expirationDate": "2020-08-26", + "registeredProperty": "string", + "primaryInd": true, + "orderSequence": 0 + }, + "id": "string", + "type": "string" + } ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:00:10.513Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.513Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true + "hasMore": true, + "totalResults": 0, + "count": 0 }, - "id": "string", - "type": "string" - }, - "changeProfileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "company": { - "alternateLanguage": "string", - "alternateName": "string", - "blacklist": true, - "businessLocale": "string", - "businessTitle": "string", - "commissionCode": "string", - "companyName": "string", - "companyName2": "string", - "companyName3": "string", - "corporateIdType": "string", - "creditRating": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "iATAInfo": { - "iATACompany": "string", - "iATAConsortia": "string", - "iATAValidationResult": true - }, - "language": "string", - "nationality": "string", - "nationalityDescription": "string", - "vipDescription": "string", - "vipStatus": "string" - }, - "customer": { + "profession": "string", "alienInfo": { "alienRegistrationNo": "string", "immigrationStatus": "string", "visaValidityType": "string" }, - "anonymization": { - "anonymizationDate": "2020-08-26T15:00:10.508Z", - "anonymizationStatus": "Requested" - }, "birthCountry": { - "code": "string", - "value": "string" - }, - "birthDate": "2020-08-26", - "birthDateMasked": "string", - "birthPlace": "string", - "blacklist": true, - "businessTitle": "string", - "citizenCountry": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, + "legalCompany": "string", "companyInfo": { - "department": "string", "legalCompany": "string", + "department": "string", "position": "string" }, - "creditRating": "string", + "businessTitle": "string", + "gender": "Male", + "birthDate": "2020-08-26", + "birthDateMasked": "string", "currencyCode": "string", "currencySymbol": "string", - "customerValue": "string", "decimalPlaces": 0, - "gender": "Male", - "identifications": { - "count": 0, - "hasMore": true, - "identificationInfo": [ - { - "id": "string", - "identification": { - "expirationDate": "2020-08-26", - "idNumber": "string", - "idNumberMasked": "string", - "idType": "string", - "issuedCountry": "string", - "issuedDate": "2020-08-26", - "issuedPlace": "string", - "orderSequence": 0, - "primaryInd": true, - "registeredProperty": "string" - }, - "type": "string" - } - ], - "totalResults": 0 - }, "language": "string", - "legalCompany": "string", "nationality": "string", "nationalityDescription": "string", - "personName": [ - { - "envelopeGreeting": "string", - "externalSystem": "string", - "givenName": "string", - "language": "string", - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameTitleSuffix": 0, - "nameType": "Primary", - "salutation": "string", - "surname": "string" - } - ], + "customerValue": "string", + "creditRating": "string", + "vipStatus": "string", + "vipDescription": "string", + "birthPlace": "string", "privateProfile": true, - "profession": "string", + "blacklist": true + }, + "company": { + "companyName": "string", + "companyName2": "string", + "companyName3": "string", + "alternateName": "string", + "alternateLanguage": "string", + "businessLocale": "string", + "iATAInfo": { + "iATACompany": "string", + "iATAConsortia": "string", + "iATAValidationResult": true + }, + "businessTitle": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "language": "string", + "nationality": "string", + "nationalityDescription": "string", + "commissionCode": "string", + "creditRating": "string", + "corporateIdType": "string", + "vipStatus": "string", "vipDescription": "string", - "vipStatus": "string" + "blacklist": true }, - "email": { - "email": { + "telephone": { + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, "createDateTime": "2020-08-26T15:00:10.513Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", + "lastModifyDateTime": "2020-08-26T15:00:10.513Z", "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "address": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:00:10.513Z", + "creatorId": "string", "lastModifyDateTime": "2020-08-26T15:00:10.513Z", - "orderSequence": 0, + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "email": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", "primaryInd": true, - "purgeDate": "2020-08-26", + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.513Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.513Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "uRLs": { + "url": { + "value": "string", "type": "string", - "typeDescription": "string" + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 }, "id": "string", "type": "string" }, - "id": "string", - "primary": "string", "primaryOwner": { - "department": { + "hotel": { "code": "string", "description": "string" }, - "email": { - "email": { - "createDateTime": "2020-08-26T15:00:10.513Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.513Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" - }, + "userId": { "id": "string", "type": "string" }, - "hotel": { - "code": "string", - "description": "string" + "userName": "string", + "ownerCode": "string", + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 }, "name": { - "envelopeGreeting": "string", - "externalSystem": "string", + "namePrefix": "string", "givenName": "string", - "language": "string", "middleName": "string", - "namePrefix": "string", + "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, - "nameType": "Primary", + "envelopeGreeting": "string", "salutation": "string", - "surname": "string" + "nameType": "Primary", + "language": "string", + "externalSystem": "string" }, - "ownerCode": "string", - "phone": { - "id": "string", - "telephone": { + "department": { + "code": "string", + "description": "string" + }, + "email": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, "createDateTime": "2020-08-26T15:00:10.513Z", "creatorId": "string", - "extension": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:00:10.513Z", - "orderSequence": 0, - "phoneNumber": "string", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "phone": { + "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.513Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.513Z", + "lastModifierId": "string", "purgeDate": "2020-08-26" }, - "type": "string" - }, - "primary": true, - "profileId": { "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" + "type": "string" }, "relationship": { "code": "string", "description": "string" }, - "userId": { - "id": "string", - "type": "string" - }, - "userName": "string" + "primary": true }, "profileIdList": [ { @@ -12528,157 +10460,429 @@ "type": "string" } ], - "profileType": "Guest", + "changeProfileIdList": [ + { + "id": "string", + "type": "string" + } + ], + "primary": "string", + "id": "string", "statusCode": "Active", - "telephone": { + "profileType": "Guest" + }, + "masterAccountInfo": { + "masterAccountId": { "id": "string", - "telephone": { - "createDateTime": "2020-08-26T15:00:10.513Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.513Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, "type": "string" }, - "uRLs": { - "id": "string", - "type": "string", - "url": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - } - } + "masterAccountName": "string" }, + "id": "string", + "relation": "string", + "relationDescription": "string", "targetRelation": "string", "targetRelationDescription": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 }, - "requestForHotel": "string", "reservationInfoList": { - "futureList": { - "count": 0, - "hasMore": true, + "historyList": { "reservationInfo": [ { - "accessRestriction": "Change", - "advanceCheckIn": { - "advanceCheckedIn": true, - "eTRComments": "string", - "expectedReturnTime": "2020-08-26T15:00:10.518Z" - }, - "allowMobileCheckout": true, - "allowMobileViewFolio": true, - "allowedActions": [ - "Cancel" - ], - "attachedProfiles": [ + "reservationIdList": [ { - "name": "string", - "profileIdList": [ + "id": "string", + "type": "string" + } + ], + "roomStay": { + "arrivalDate": "2020-08-26", + "departureDate": "2020-08-26", + "originalTimeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-08-26T15:00:10.514Z", + "reservationExpectedDepartureTime": "2020-08-26T15:00:10.514Z" + }, + "adultCount": 0, + "childCount": 0, + "roomClass": "string", + "roomType": "string", + "numberOfRooms": 0, + "roomNumber": "string", + "ratePlanCode": "string", + "rateAmount": { + "amount": 0, + "currencyCode": "string" + }, + "points": { + "awardsType": "string", + "points": 0 + }, + "rateSuppressed": true, + "reservationBlock": { + "blockIdList": [ { "id": "string", "type": "string" } ], - "reservationProfileType": "Company" - } - ], - "cancellationInfo": { - "code": "string", - "date": "2020-08-26", - "description": "string" + "blockName": "string", + "hotelId": "string" + }, + "bookingChannelCode": "string", + "partyCode": "string", + "fixedRate": true, + "totalAmount": { + "amount": 0, + "currencyCode": "string" + }, + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { + "promotionCode": "string", + "promotionName": "string", + "couponCode": "string" + }, + "marketCode": "string", + "sourceOfBusiness": "string", + "sourceOfBusinessDescription": "string", + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "compBalance": { + "amount": 0, + "currencyCode": "string" + }, + "roomTypeCharged": "string", + "depositPayments": { + "amount": 0, + "currencyCode": "string" + }, + "guestServiceStatus": "DoNotDisturb", + "scheduledCheckoutTime": "2020-08-26", + "roomNumberLocked": true, + "pseudoRoom": true }, - "cashiering": { - "bedTaxReporting": { - "taxRegistrationNo": 0, - "taxableDays": 0, - "visaExpiryDate": "2020-08-26", - "visaIssueDate": "2020-08-26", - "visaNumber": "string" + "reservationGuest": { + "membership": { + "membershipId": 0, + "programCode": "string", + "bonusCode": "string", + "membershipTypeDesc": "string", + "membershipLevelDesc": "string", + "accountId": "string", + "membershipLevel": "string", + "playerRanking": 0 }, - "billingPrivileges": { - "allowAutoCheckin": true, - "autoSettlement": true, - "autoSettlementFreq": 0, - "autoSettlementType": "string", - "creditLimitAutoPay": true, - "directBillAuthorized": true, - "folioCloseDate": "2020-08-26", - "postStayCharging": true, - "postingRestriction": true, - "preStayCharging": true, - "scheduledCheckout": true, - "scheduledCheckoutTime": "2020-08-26", - "videoCheckout": true + "namePrefix": "string", + "givenName": "string", + "alternateGivenName": "string", + "middleName": "string", + "surnamePrefix": "string", + "surname": "string", + "alternateSurname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "fullName": "string", + "alternateFullName": "string", + "phoneNumber": "string", + "email": "string", + "birthDate": "2020-08-26", + "language": "string", + "nationality": { + "value": "string", + "code": "string" }, - "compAccounting": { - "authorizer": "string", - "compPostings": "string", - "compType": "string" + "vip": { + "vipCode": "string", + "vipDescription": "string" }, - "financiallyResponsible": true, - "folioTexts": [ + "address": { + "cityName": "string", + "postalCode": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "streetAddress": "string", + "excludeNoCity": true + }, + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-08-26T15:00:10.514Z" + }, + "accompanyGuests": [ { - "row": 0, - "text": "string" + "firstName": "string", + "lastName": "string", + "fullName": "string", + "registrationCardNo": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ] } ], - "lastRoomAndTaxPostedDate": "2020-08-26", - "periodicFolio": { - "frequency": 0, - "lastFolioDate": "2020-08-26", - "lastSettlementDate": "2020-08-26" - }, - "proratedBilling": true, - "reservationPreConfiguredRoutingInstruction": { - "authorizerInfo": { - "authorizerId": { - "id": "string", - "type": "string" - }, - "authorizerName": "string", - "authorizerRateCode": "string", - "authorizerUserName": "string", - "inheritAuthorizerRateCode": true - }, - "profileType": "Company", - "promotionCode": "string", - "ratePlanCode": "string" + "externalInfo": { + "givenName": "string", + "surname": "string" }, - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { + "guestLastStayInfo": { + "lastStayDate": "2020-08-26", + "lastStayRoom": "string", + "lastStayRate": { "amount": 0, "currencyCode": "string" }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" + "totalStay": 0 + }, + "guestRestrictedCode": "string", + "guestRestrictedReasonDesc": "string", + "guestRestricted": true, + "registrationCardNo": "string", + "nameType": "Guest", + "id": "string", + "type": "string" + }, + "sharedGuests": [ + { + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 }, - "otherRevenue": { + "firstName": "string", + "lastName": "string", + "fullName": "string" + } + ], + "attachedProfiles": [ + { + "name": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ], + "reservationProfileType": "Company" + } + ], + "reservationPaymentMethod": { + "paymentCard": { + "cardId": { + "id": "string", + "type": "string" + }, + "currentAuthorizedAmount": { "amount": 0, "currencyCode": "string" }, - "roomRevenue": { + "approvalAmountNeeded": { + "amount": 0, + "currencyCode": "string" + }, + "cardType": "Ab", + "userDefinedCardType": "string", + "cardNumber": "string", + "cardNumberMasked": "string", + "cardNumberLast4Digits": "string", + "expirationDate": "2020-08-26", + "expirationDateMasked": "string", + "expirationDateExpired": true, + "cardHolderName": "string", + "attachCreditCardToProfile": true, + "processing": "Eft", + "swiped": true, + "cardOrToken": "CardNumber" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "authorizationRule": { + "code": 0, + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "percent": 0 + }, + "emailFolioInfo": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.514Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.514Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "emailFolio": true, + "id": "string", + "type": "string" + }, + "paymentMethod": "string", + "description": "string", + "folioView": 0 + }, + "reservationFolioWindows": [ + { + "payeeInfo": { + "payeeId": { + "id": "string", + "type": "string" + }, + "payeeName": "string", + "payeeAddress": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:00:10.515Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.515Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "payeeAddressCount": 0, + "payeeReferenceCurrency": "string", + "payeeAccountInfo": { + "accountName": "string", + "accountId": { + "id": "string", + "type": "string" + }, + "accountNo": "string", + "status": { + "restriction": "string", + "description": "string", + "restricted": true + } + }, + "payeeTaxNumber": "string" + }, + "balance": { "amount": 0, "currencyCode": "string" }, + "paymentMethod": "string", + "folioWindowNo": 0 + } + ], + "specials": "string", + "lastPrivacyPromptDate": "2020-08-26", + "displayColor": "string", + "reservationIndicators": [ + { + "indicatorName": "string", + "count": 0 + } + ], + "roomStatus": "Clean", + "searchMatches": [ + { + "attribute": "string", + "value": "string" + } + ], + "sourceOfSale": { + "sourceType": "string", + "sourceCode": "string" + }, + "waitlist": { + "reasonDescription": "string", + "priorityDescription": "string", + "description": "string", + "reasonCode": "string", + "priorityCode": "string", + "telephone": "string" + }, + "queue": { + "timeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string", + "durationInSeconds": 0 + }, + "guestTextInfo": { + "sentTime": "2020-08-26T15:00:10.515Z", + "sentBy": "string" + }, + "priority": 0, + "averageQueueTimeToCheckIn": 0, + "averageQueueTimeCurrentReservations": 0, + "queueDate": "2020-08-26" + }, + "housekeeping": { + "instructions": "string", + "facilityTaskInfo": { + "task": { + "description": "string", + "instructions": "string", + "facilityDepartureTask": true, + "linenChange": true, + "hotelId": "string", + "code": "string", + "sequence": 0 + }, + "supplies": [ + { + "description": "string", + "quantity": 0, + "code": "string" + } + ], + "date": "2020-08-26" + }, + "linenChange": true, + "turndownRequested": true, + "serviceTime": "2020-08-26", + "expectedServiceTime": "string", + "roomStatus": "Clean" + }, + "cashiering": { + "revenuesAndBalances": { "totalFixedCharge": { "amount": 0, "currencyCode": "string" @@ -12687,1414 +10891,1274 @@ "amount": 0, "currencyCode": "string" }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, "totalRevenue": { "amount": 0, "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" } }, - "reverseAdvanceCheckInAllowed": true, - "reverseCheckInAllowed": true, + "billingPrivileges": { + "postingRestriction": true, + "preStayCharging": true, + "postStayCharging": true, + "folioCloseDate": "2020-08-26", + "scheduledCheckout": true, + "scheduledCheckoutTime": "2020-08-26", + "directBillAuthorized": true, + "videoCheckout": true, + "allowAutoCheckin": true, + "autoSettlement": true, + "autoSettlementType": "string", + "autoSettlementFreq": 0, + "creditLimitAutoPay": true + }, "taxType": { + "hotelId": "string", "code": "string", - "collectingAgentTax": true, "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, + "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, + "minimumLengthOfStay": 0, "taxExemptNo": "string" }, + "bedTaxReporting": { + "taxRegistrationNo": 0, + "visaNumber": "string", + "visaIssueDate": "2020-08-26", + "visaExpiryDate": "2020-08-26", + "taxableDays": 0 + }, + "folioTexts": [ + { + "text": "string", + "row": 0 + } + ], + "periodicFolio": { + "lastSettlementDate": "2020-08-26", + "lastFolioDate": "2020-08-26", + "frequency": 0 + }, + "compAccounting": { + "compType": "string", + "authorizer": "string", + "compPostings": "string" + }, + "reservationPreConfiguredRoutingInstruction": { + "authorizerInfo": { + "authorizerId": { + "id": "string", + "type": "string" + }, + "authorizerUserName": "string", + "authorizerName": "string", + "authorizerRateCode": "string", + "inheritAuthorizerRateCode": true + }, + "ratePlanCode": "string", + "profileType": "Company", + "promotionCode": "string" + }, + "financiallyResponsible": true, + "proratedBilling": true, + "lastRoomAndTaxPostedDate": "2020-08-26", + "reverseCheckInAllowed": true, + "reverseAdvanceCheckInAllowed": true, "transactionsPosted": true }, - "commissionPayoutTo": "TravelAgent", - "computedReservationStatus": "Reserved", - "createDateTime": "2020-08-26T15:00:10.518Z", - "creatorId": "string", + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0 + }, "deposit": { - "amountOwed": 0, - "amountPaid": 0, "amountRequired": 0, + "amountPaid": 0, + "amountOwed": 0, "dueDate": "2020-08-26", - "hasOutstanding": true, + "postingDate": "2020-08-26", "hasPaid": true, - "postingDate": "2020-08-26" + "hasOutstanding": true + }, + "allowedActions": [ + "Cancel" + ], + "revenuesAndBalances": { + "totalFixedCharge": { + "amount": 0, + "currencyCode": "string" + }, + "totalPayment": { + "amount": 0, + "currencyCode": "string" + }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } }, - "displayColor": "string", - "expectedServiceTime": "string", - "guestPreferredCurrency": "string", - "hotelId": "string", "hotelInterfaceStatusList": [ { + "roomExtension": "string", "hotelInterface": { - "activeFlag": true, - "hotelId": "string", "interfaceId": { "id": "string", "type": "string" }, + "hotelId": "string", "interfaceName": "string", "interfaceType": "Bms", "logo": "string", "machineName": "string", - "status": "Stopped" + "status": "Stopped", + "activeFlag": true }, "interfaceRights": [ { - "category": "string", - "description": "string", "right": 0, - "statusCode": "string" + "statusCode": "string", + "description": "string", + "category": "string" } - ], - "roomExtension": "string" + ] } ], - "hotelName": "string", - "housekeeping": { - "expectedServiceTime": "string", - "facilityTaskInfo": { - "date": "2020-08-26", - "supplies": [ - { - "code": "string", - "description": "string", - "quantity": 0 - } - ], - "task": { - "code": "string", - "description": "string", - "facilityDepartureTask": true, - "hotelId": "string", - "instructions": "string", - "linenChange": true, - "sequence": 0 - } - }, - "instructions": "string", - "linenChange": true, - "roomStatus": "Clean", - "serviceTime": "2020-08-26", - "turndownRequested": true + "guestPreferredCurrency": "string", + "turndownInfo": { + "allowed": true, + "status": "Required" }, - "keyCount": 0, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.518Z", - "lastPrivacyPromptDate": "2020-08-26", "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", + "roomReady": "Pending", "keyReady": "Pending", + "checkoutMessageReceived": true, "requiresAction": true, - "roomReady": "Pending" - }, - "openFolio": true, - "optedForCommunication": true, - "paymentMethod": "string", - "preRegistered": true, - "purgeDate": "2020-08-26", - "queue": { - "averageQueueTimeCurrentReservations": 0, - "averageQueueTimeToCheckIn": 0, - "guestTextInfo": { - "sentBy": "string", - "sentTime": "2020-08-26T15:00:10.517Z" - }, - "priority": 0, - "queueDate": "2020-08-26", - "timeSpan": { - "duration": "string", - "durationInSeconds": 0, - "endDate": "2020-08-26", - "startDate": "2020-08-26" - } + "errorMessage": "string" }, "reservationCommunication": { - "emails": { - "count": 0, - "emailInfo": [ + "telephones": { + "telephoneInfo": [ { - "email": { - "createDateTime": "2020-08-26T15:00:10.518Z", + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.516Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", + "lastModifyDateTime": "2020-08-26T15:00:10.516Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.518Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" + "purgeDate": "2020-08-26" }, "id": "string", "type": "string" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ + "emails": { + "emailInfo": [ { - "id": "string", - "telephone": { - "createDateTime": "2020-08-26T15:00:10.518Z", + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.516Z", "creatorId": "string", - "extension": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.516Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.518Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, "purgeDate": "2020-08-26" }, + "id": "string", "type": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 } }, - "reservationFolioWindows": [ + "advanceCheckIn": { + "advanceCheckedIn": true, + "expectedReturnTime": "2020-08-26T15:00:10.516Z", + "eTRComments": "string" + }, + "welcomeOffer": true, + "cancellationInfo": { + "description": "string", + "code": "string", + "date": "2020-08-26" + }, + "keyCount": 0, + "hotelId": "string", + "hotelName": "string", + "expectedServiceTime": "string", + "roomStayReservation": true, + "createDateTime": "2020-08-26T15:00:10.516Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.516Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "reservationStatus": "Reserved", + "computedReservationStatus": "Reserved", + "walkInIndicator": true, + "accessRestriction": "Change", + "commissionPayoutTo": "TravelAgent", + "paymentMethod": "string", + "preRegistered": true, + "openFolio": true, + "allowMobileCheckout": true, + "allowMobileViewFolio": true, + "optedForCommunication": true + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "futureList": { + "reservationInfo": [ + { + "reservationIdList": [ { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "folioWindowNo": 0, - "payeeInfo": { - "payeeAccountInfo": { - "accountId": { - "id": "string", - "type": "string" - }, - "accountName": "string", - "accountNo": "string", - "status": { - "description": "string", - "restricted": true, - "restriction": "string" - } - }, - "payeeAddress": { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:00:10.517Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.517Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" - }, - "payeeAddressCount": 0, - "payeeId": { - "id": "string", - "type": "string" - }, - "payeeName": "string", - "payeeReferenceCurrency": "string", - "payeeTaxNumber": "string" - }, - "paymentMethod": "string" + "id": "string", + "type": "string" } ], - "reservationGuest": { - "accompanyGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "registrationCardNo": "string" - } - ], + "roomStay": { + "arrivalDate": "2020-08-26", + "departureDate": "2020-08-26", + "originalTimeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-08-26T15:00:10.516Z", + "reservationExpectedDepartureTime": "2020-08-26T15:00:10.516Z" + }, + "adultCount": 0, + "childCount": 0, + "roomClass": "string", + "roomType": "string", + "numberOfRooms": 0, + "roomNumber": "string", + "ratePlanCode": "string", + "rateAmount": { + "amount": 0, + "currencyCode": "string" + }, + "points": { + "awardsType": "string", + "points": 0 + }, + "rateSuppressed": true, + "reservationBlock": { + "blockIdList": [ + { + "id": "string", + "type": "string" + } + ], + "blockName": "string", + "hotelId": "string" + }, + "bookingChannelCode": "string", + "partyCode": "string", + "fixedRate": true, + "totalAmount": { + "amount": 0, + "currencyCode": "string" + }, + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { + "promotionCode": "string", + "promotionName": "string", + "couponCode": "string" + }, + "marketCode": "string", + "sourceOfBusiness": "string", + "sourceOfBusinessDescription": "string", + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "compBalance": { + "amount": 0, + "currencyCode": "string" + }, + "roomTypeCharged": "string", + "depositPayments": { + "amount": 0, + "currencyCode": "string" + }, + "guestServiceStatus": "DoNotDisturb", + "scheduledCheckoutTime": "2020-08-26", + "roomNumberLocked": true, + "pseudoRoom": true + }, + "reservationGuest": { + "membership": { + "membershipId": 0, + "programCode": "string", + "bonusCode": "string", + "membershipTypeDesc": "string", + "membershipLevelDesc": "string", + "accountId": "string", + "membershipLevel": "string", + "playerRanking": 0 + }, + "namePrefix": "string", + "givenName": "string", + "alternateGivenName": "string", + "middleName": "string", + "surnamePrefix": "string", + "surname": "string", + "alternateSurname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "fullName": "string", + "alternateFullName": "string", + "phoneNumber": "string", + "email": "string", + "birthDate": "2020-08-26", + "language": "string", + "nationality": { + "value": "string", + "code": "string" + }, + "vip": { + "vipCode": "string", + "vipDescription": "string" + }, "address": { "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "excludeNoCity": true, "postalCode": "string", "state": "string", - "streetAddress": "string" + "country": { + "value": "string", + "code": "string" + }, + "streetAddress": "string", + "excludeNoCity": true }, - "alternateFullName": "string", - "alternateGivenName": "string", - "alternateSurname": "string", "anonymization": { - "anonymizationDate": "2020-08-26T15:00:10.517Z", - "anonymizationStatus": "Requested" + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-08-26T15:00:10.517Z" }, - "birthDate": "2020-08-26", - "email": "string", + "accompanyGuests": [ + { + "firstName": "string", + "lastName": "string", + "fullName": "string", + "registrationCardNo": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ] + } + ], "externalInfo": { "givenName": "string", "surname": "string" }, - "fullName": "string", - "givenName": "string", "guestLastStayInfo": { "lastStayDate": "2020-08-26", + "lastStayRoom": "string", "lastStayRate": { "amount": 0, "currencyCode": "string" }, - "lastStayRoom": "string", "totalStay": 0 }, - "guestRestricted": true, "guestRestrictedCode": "string", "guestRestrictedReasonDesc": "string", - "id": "string", - "language": "string", - "membership": { - "accountId": "string", - "bonusCode": "string", - "membershipId": 0, - "membershipLevel": "string", - "membershipLevelDesc": "string", - "membershipTypeDesc": "string", - "playerRanking": 0, - "programCode": "string" - }, - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Guest", - "nationality": { - "code": "string", - "value": "string" - }, - "phoneNumber": "string", + "guestRestricted": true, "registrationCardNo": "string", - "surname": "string", - "surnamePrefix": "string", - "type": "string", - "vip": { - "vipCode": "string", - "vipDescription": "string" - } + "nameType": "Guest", + "id": "string", + "type": "string" }, - "reservationIdList": [ + "sharedGuests": [ { - "id": "string", - "type": "string" + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "firstName": "string", + "lastName": "string", + "fullName": "string" } ], - "reservationIndicators": [ + "attachedProfiles": [ { - "count": 0, - "indicatorName": "string" + "name": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ], + "reservationProfileType": "Company" } ], "reservationPaymentMethod": { - "authorizationRule": { - "amount": { + "paymentCard": { + "cardId": { + "id": "string", + "type": "string" + }, + "currentAuthorizedAmount": { "amount": 0, "currencyCode": "string" }, - "code": 0, - "percent": 0 + "approvalAmountNeeded": { + "amount": 0, + "currencyCode": "string" + }, + "cardType": "Ab", + "userDefinedCardType": "string", + "cardNumber": "string", + "cardNumberMasked": "string", + "cardNumberLast4Digits": "string", + "expirationDate": "2020-08-26", + "expirationDateMasked": "string", + "expirationDateExpired": true, + "cardHolderName": "string", + "attachCreditCardToProfile": true, + "processing": "Eft", + "swiped": true, + "cardOrToken": "CardNumber" }, "balance": { "amount": 0, "currencyCode": "string" }, - "description": "string", + "authorizationRule": { + "code": 0, + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "percent": 0 + }, "emailFolioInfo": { "email": { - "createDateTime": "2020-08-26T15:00:10.517Z", - "creatorId": "string", "emailAddress": "string", + "type": "string", + "typeDescription": "string", "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.517Z", - "orderSequence": 0, "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.517Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.517Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, "emailFolio": true, "id": "string", "type": "string" }, - "folioView": 0, - "paymentCard": { - "approvalAmountNeeded": { + "paymentMethod": "string", + "description": "string", + "folioView": 0 + }, + "reservationFolioWindows": [ + { + "payeeInfo": { + "payeeId": { + "id": "string", + "type": "string" + }, + "payeeName": "string", + "payeeAddress": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:00:10.517Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.517Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "payeeAddressCount": 0, + "payeeReferenceCurrency": "string", + "payeeAccountInfo": { + "accountName": "string", + "accountId": { + "id": "string", + "type": "string" + }, + "accountNo": "string", + "status": { + "restriction": "string", + "description": "string", + "restricted": true + } + }, + "payeeTaxNumber": "string" + }, + "balance": { "amount": 0, "currencyCode": "string" }, - "attachCreditCardToProfile": true, - "cardHolderName": "string", - "cardId": { - "id": "string", - "type": "string" + "paymentMethod": "string", + "folioWindowNo": 0 + } + ], + "specials": "string", + "lastPrivacyPromptDate": "2020-08-26", + "displayColor": "string", + "reservationIndicators": [ + { + "indicatorName": "string", + "count": 0 + } + ], + "roomStatus": "Clean", + "searchMatches": [ + { + "attribute": "string", + "value": "string" + } + ], + "sourceOfSale": { + "sourceType": "string", + "sourceCode": "string" + }, + "waitlist": { + "reasonDescription": "string", + "priorityDescription": "string", + "description": "string", + "reasonCode": "string", + "priorityCode": "string", + "telephone": "string" + }, + "queue": { + "timeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string", + "durationInSeconds": 0 + }, + "guestTextInfo": { + "sentTime": "2020-08-26T15:00:10.517Z", + "sentBy": "string" + }, + "priority": 0, + "averageQueueTimeToCheckIn": 0, + "averageQueueTimeCurrentReservations": 0, + "queueDate": "2020-08-26" + }, + "housekeeping": { + "instructions": "string", + "facilityTaskInfo": { + "task": { + "description": "string", + "instructions": "string", + "facilityDepartureTask": true, + "linenChange": true, + "hotelId": "string", + "code": "string", + "sequence": 0 }, - "cardNumber": "string", - "cardNumberLast4Digits": "string", - "cardNumberMasked": "string", - "cardOrToken": "CardNumber", - "cardType": "Ab", - "currentAuthorizedAmount": { + "supplies": [ + { + "description": "string", + "quantity": 0, + "code": "string" + } + ], + "date": "2020-08-26" + }, + "linenChange": true, + "turndownRequested": true, + "serviceTime": "2020-08-26", + "expectedServiceTime": "string", + "roomStatus": "Clean" + }, + "cashiering": { + "revenuesAndBalances": { + "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, - "expirationDate": "2020-08-26", - "expirationDateExpired": true, - "expirationDateMasked": "string", - "processing": "Eft", - "swiped": true, - "userDefinedCardType": "string" + "totalPayment": { + "amount": 0, + "currencyCode": "string" + }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } + }, + "billingPrivileges": { + "postingRestriction": true, + "preStayCharging": true, + "postStayCharging": true, + "folioCloseDate": "2020-08-26", + "scheduledCheckout": true, + "scheduledCheckoutTime": "2020-08-26", + "directBillAuthorized": true, + "videoCheckout": true, + "allowAutoCheckin": true, + "autoSettlement": true, + "autoSettlementType": "string", + "autoSettlementFreq": 0, + "creditLimitAutoPay": true + }, + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0, + "taxExemptNo": "string" + }, + "bedTaxReporting": { + "taxRegistrationNo": 0, + "visaNumber": "string", + "visaIssueDate": "2020-08-26", + "visaExpiryDate": "2020-08-26", + "taxableDays": 0 }, - "paymentMethod": "string" + "folioTexts": [ + { + "text": "string", + "row": 0 + } + ], + "periodicFolio": { + "lastSettlementDate": "2020-08-26", + "lastFolioDate": "2020-08-26", + "frequency": 0 + }, + "compAccounting": { + "compType": "string", + "authorizer": "string", + "compPostings": "string" + }, + "reservationPreConfiguredRoutingInstruction": { + "authorizerInfo": { + "authorizerId": { + "id": "string", + "type": "string" + }, + "authorizerUserName": "string", + "authorizerName": "string", + "authorizerRateCode": "string", + "inheritAuthorizerRateCode": true + }, + "ratePlanCode": "string", + "profileType": "Company", + "promotionCode": "string" + }, + "financiallyResponsible": true, + "proratedBilling": true, + "lastRoomAndTaxPostedDate": "2020-08-26", + "reverseCheckInAllowed": true, + "reverseAdvanceCheckInAllowed": true, + "transactionsPosted": true }, - "reservationStatus": "Reserved", + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0 + }, + "deposit": { + "amountRequired": 0, + "amountPaid": 0, + "amountOwed": 0, + "dueDate": "2020-08-26", + "postingDate": "2020-08-26", + "hasPaid": true, + "hasOutstanding": true + }, + "allowedActions": [ + "Cancel" + ], "revenuesAndBalances": { - "balance": { + "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, - "foodAndBevRevenue": { + "totalPayment": { "amount": 0, "currencyCode": "string" }, - "nonRevenue": { + "roomRevenue": { "amount": 0, "currencyCode": "string" }, - "otherRevenue": { + "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, - "roomRevenue": { + "otherRevenue": { "amount": 0, "currencyCode": "string" }, - "totalFixedCharge": { + "nonRevenue": { "amount": 0, "currencyCode": "string" }, - "totalPayment": { + "totalRevenue": { "amount": 0, "currencyCode": "string" }, - "totalRevenue": { + "balance": { "amount": 0, "currencyCode": "string" } }, - "roomStatus": "Clean", - "roomStay": { - "adultCount": 0, - "arrivalDate": "2020-08-26", - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "bookingChannelCode": "string", - "childCount": 0, - "compBalance": { - "amount": 0, - "currencyCode": "string" - }, - "departureDate": "2020-08-26", - "depositPayments": { - "amount": 0, - "currencyCode": "string" - }, - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-08-26T15:00:10.516Z", - "reservationExpectedDepartureTime": "2020-08-26T15:00:10.516Z" - }, - "fixedRate": true, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestServiceStatus": "DoNotDisturb", - "marketCode": "string", - "numberOfRooms": 0, - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" - }, - "partyCode": "string", - "points": { - "awardsType": "string", - "points": 0 - }, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "pseudoRoom": true, - "rateAmount": { - "amount": 0, - "currencyCode": "string" - }, - "ratePlanCode": "string", - "rateSuppressed": true, - "reservationBlock": { - "blockIdList": [ - { - "id": "string", - "type": "string" - } - ], - "blockName": "string", - "hotelId": "string" - }, - "roomClass": "string", - "roomNumber": "string", - "roomNumberLocked": true, - "roomType": "string", - "roomTypeCharged": "string", - "scheduledCheckoutTime": "2020-08-26", - "sourceOfBusiness": "string", - "sourceOfBusinessDescription": "string", - "totalAmount": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStayReservation": true, - "searchMatches": [ - { - "attribute": "string", - "value": "string" - } - ], - "sharedGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - } - } - ], - "sourceOfSale": { - "sourceCode": "string", - "sourceType": "string" - }, - "specials": "string", - "taxType": { - "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0 - }, - "turndownInfo": { - "allowed": true, - "status": "Required" - }, - "waitlist": { - "description": "string", - "priorityCode": "string", - "priorityDescription": "string", - "reasonCode": "string", - "reasonDescription": "string", - "telephone": "string" - }, - "walkInIndicator": true, - "welcomeOffer": true - } - ], - "totalResults": 0 - }, - "historyList": { - "count": 0, - "hasMore": true, - "reservationInfo": [ - { - "accessRestriction": "Change", - "advanceCheckIn": { - "advanceCheckedIn": true, - "eTRComments": "string", - "expectedReturnTime": "2020-08-26T15:00:10.516Z" - }, - "allowMobileCheckout": true, - "allowMobileViewFolio": true, - "allowedActions": [ - "Cancel" - ], - "attachedProfiles": [ - { - "name": "string", - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "reservationProfileType": "Company" - } - ], - "cancellationInfo": { - "code": "string", - "date": "2020-08-26", - "description": "string" - }, - "cashiering": { - "bedTaxReporting": { - "taxRegistrationNo": 0, - "taxableDays": 0, - "visaExpiryDate": "2020-08-26", - "visaIssueDate": "2020-08-26", - "visaNumber": "string" - }, - "billingPrivileges": { - "allowAutoCheckin": true, - "autoSettlement": true, - "autoSettlementFreq": 0, - "autoSettlementType": "string", - "creditLimitAutoPay": true, - "directBillAuthorized": true, - "folioCloseDate": "2020-08-26", - "postStayCharging": true, - "postingRestriction": true, - "preStayCharging": true, - "scheduledCheckout": true, - "scheduledCheckoutTime": "2020-08-26", - "videoCheckout": true - }, - "compAccounting": { - "authorizer": "string", - "compPostings": "string", - "compType": "string" - }, - "financiallyResponsible": true, - "folioTexts": [ - { - "row": 0, - "text": "string" - } - ], - "lastRoomAndTaxPostedDate": "2020-08-26", - "periodicFolio": { - "frequency": 0, - "lastFolioDate": "2020-08-26", - "lastSettlementDate": "2020-08-26" - }, - "proratedBilling": true, - "reservationPreConfiguredRoutingInstruction": { - "authorizerInfo": { - "authorizerId": { - "id": "string", - "type": "string" - }, - "authorizerName": "string", - "authorizerRateCode": "string", - "authorizerUserName": "string", - "inheritAuthorizerRateCode": true - }, - "profileType": "Company", - "promotionCode": "string", - "ratePlanCode": "string" - }, - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "totalFixedCharge": { - "amount": 0, - "currencyCode": "string" - }, - "totalPayment": { - "amount": 0, - "currencyCode": "string" - }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" - } - }, - "reverseAdvanceCheckInAllowed": true, - "reverseCheckInAllowed": true, - "taxType": { - "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0, - "taxExemptNo": "string" - }, - "transactionsPosted": true - }, - "commissionPayoutTo": "TravelAgent", - "computedReservationStatus": "Reserved", - "createDateTime": "2020-08-26T15:00:10.516Z", - "creatorId": "string", - "deposit": { - "amountOwed": 0, - "amountPaid": 0, - "amountRequired": 0, - "dueDate": "2020-08-26", - "hasOutstanding": true, - "hasPaid": true, - "postingDate": "2020-08-26" - }, - "displayColor": "string", - "expectedServiceTime": "string", - "guestPreferredCurrency": "string", - "hotelId": "string", "hotelInterfaceStatusList": [ { + "roomExtension": "string", "hotelInterface": { - "activeFlag": true, - "hotelId": "string", "interfaceId": { "id": "string", "type": "string" }, + "hotelId": "string", "interfaceName": "string", "interfaceType": "Bms", "logo": "string", "machineName": "string", - "status": "Stopped" + "status": "Stopped", + "activeFlag": true }, "interfaceRights": [ { - "category": "string", - "description": "string", "right": 0, - "statusCode": "string" + "statusCode": "string", + "description": "string", + "category": "string" } - ], - "roomExtension": "string" + ] } ], - "hotelName": "string", - "housekeeping": { - "expectedServiceTime": "string", - "facilityTaskInfo": { - "date": "2020-08-26", - "supplies": [ - { - "code": "string", - "description": "string", - "quantity": 0 - } - ], - "task": { - "code": "string", - "description": "string", - "facilityDepartureTask": true, - "hotelId": "string", - "instructions": "string", - "linenChange": true, - "sequence": 0 - } - }, - "instructions": "string", - "linenChange": true, - "roomStatus": "Clean", - "serviceTime": "2020-08-26", - "turndownRequested": true + "guestPreferredCurrency": "string", + "turndownInfo": { + "allowed": true, + "status": "Required" }, - "keyCount": 0, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.516Z", - "lastPrivacyPromptDate": "2020-08-26", "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", + "roomReady": "Pending", "keyReady": "Pending", + "checkoutMessageReceived": true, "requiresAction": true, - "roomReady": "Pending" - }, - "openFolio": true, - "optedForCommunication": true, - "paymentMethod": "string", - "preRegistered": true, - "purgeDate": "2020-08-26", - "queue": { - "averageQueueTimeCurrentReservations": 0, - "averageQueueTimeToCheckIn": 0, - "guestTextInfo": { - "sentBy": "string", - "sentTime": "2020-08-26T15:00:10.515Z" - }, - "priority": 0, - "queueDate": "2020-08-26", - "timeSpan": { - "duration": "string", - "durationInSeconds": 0, - "endDate": "2020-08-26", - "startDate": "2020-08-26" - } + "errorMessage": "string" }, "reservationCommunication": { - "emails": { - "count": 0, - "emailInfo": [ + "telephones": { + "telephoneInfo": [ { - "email": { - "createDateTime": "2020-08-26T15:00:10.516Z", + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.518Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", + "lastModifyDateTime": "2020-08-26T15:00:10.518Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.516Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" + "purgeDate": "2020-08-26" }, "id": "string", "type": "string" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ + "emails": { + "emailInfo": [ { - "id": "string", - "telephone": { - "createDateTime": "2020-08-26T15:00:10.516Z", + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:00:10.518Z", "creatorId": "string", - "extension": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.518Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.516Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, "purgeDate": "2020-08-26" }, + "id": "string", "type": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 } }, - "reservationFolioWindows": [ - { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "folioWindowNo": 0, - "payeeInfo": { - "payeeAccountInfo": { - "accountId": { - "id": "string", - "type": "string" - }, - "accountName": "string", - "accountNo": "string", - "status": { - "description": "string", - "restricted": true, - "restriction": "string" - } - }, - "payeeAddress": { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:00:10.515Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.515Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" - }, - "payeeAddressCount": 0, - "payeeId": { - "id": "string", - "type": "string" - }, - "payeeName": "string", - "payeeReferenceCurrency": "string", - "payeeTaxNumber": "string" - }, - "paymentMethod": "string" - } - ], - "reservationGuest": { - "accompanyGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "registrationCardNo": "string" - } - ], - "address": { - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "excludeNoCity": true, - "postalCode": "string", - "state": "string", - "streetAddress": "string" - }, - "alternateFullName": "string", - "alternateGivenName": "string", - "alternateSurname": "string", - "anonymization": { - "anonymizationDate": "2020-08-26T15:00:10.514Z", - "anonymizationStatus": "Requested" - }, - "birthDate": "2020-08-26", - "email": "string", - "externalInfo": { - "givenName": "string", - "surname": "string" - }, - "fullName": "string", - "givenName": "string", - "guestLastStayInfo": { - "lastStayDate": "2020-08-26", - "lastStayRate": { - "amount": 0, - "currencyCode": "string" - }, - "lastStayRoom": "string", - "totalStay": 0 - }, - "guestRestricted": true, - "guestRestrictedCode": "string", - "guestRestrictedReasonDesc": "string", - "id": "string", - "language": "string", - "membership": { - "accountId": "string", - "bonusCode": "string", - "membershipId": 0, - "membershipLevel": "string", - "membershipLevelDesc": "string", - "membershipTypeDesc": "string", - "playerRanking": 0, - "programCode": "string" - }, - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Guest", - "nationality": { - "code": "string", - "value": "string" - }, - "phoneNumber": "string", - "registrationCardNo": "string", - "surname": "string", - "surnamePrefix": "string", - "type": "string", - "vip": { - "vipCode": "string", - "vipDescription": "string" - } + "advanceCheckIn": { + "advanceCheckedIn": true, + "expectedReturnTime": "2020-08-26T15:00:10.518Z", + "eTRComments": "string" }, - "reservationIdList": [ - { - "id": "string", - "type": "string" - } - ], - "reservationIndicators": [ - { - "count": 0, - "indicatorName": "string" - } - ], - "reservationPaymentMethod": { - "authorizationRule": { - "amount": { - "amount": 0, - "currencyCode": "string" - }, - "code": 0, - "percent": 0 - }, - "balance": { - "amount": 0, - "currencyCode": "string" - }, + "welcomeOffer": true, + "cancellationInfo": { "description": "string", - "emailFolioInfo": { - "email": { - "createDateTime": "2020-08-26T15:00:10.514Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.514Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" - }, - "emailFolio": true, - "id": "string", - "type": "string" - }, - "folioView": 0, - "paymentCard": { - "approvalAmountNeeded": { - "amount": 0, - "currencyCode": "string" - }, - "attachCreditCardToProfile": true, - "cardHolderName": "string", - "cardId": { - "id": "string", - "type": "string" - }, - "cardNumber": "string", - "cardNumberLast4Digits": "string", - "cardNumberMasked": "string", - "cardOrToken": "CardNumber", - "cardType": "Ab", - "currentAuthorizedAmount": { - "amount": 0, - "currencyCode": "string" - }, - "expirationDate": "2020-08-26", - "expirationDateExpired": true, - "expirationDateMasked": "string", - "processing": "Eft", - "swiped": true, - "userDefinedCardType": "string" - }, - "paymentMethod": "string" - }, - "reservationStatus": "Reserved", - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "totalFixedCharge": { - "amount": 0, - "currencyCode": "string" - }, - "totalPayment": { - "amount": 0, - "currencyCode": "string" - }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStatus": "Clean", - "roomStay": { - "adultCount": 0, - "arrivalDate": "2020-08-26", - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "bookingChannelCode": "string", - "childCount": 0, - "compBalance": { - "amount": 0, - "currencyCode": "string" - }, - "departureDate": "2020-08-26", - "depositPayments": { - "amount": 0, - "currencyCode": "string" - }, - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-08-26T15:00:10.514Z", - "reservationExpectedDepartureTime": "2020-08-26T15:00:10.514Z" - }, - "fixedRate": true, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestServiceStatus": "DoNotDisturb", - "marketCode": "string", - "numberOfRooms": 0, - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" - }, - "partyCode": "string", - "points": { - "awardsType": "string", - "points": 0 - }, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "pseudoRoom": true, - "rateAmount": { - "amount": 0, - "currencyCode": "string" - }, - "ratePlanCode": "string", - "rateSuppressed": true, - "reservationBlock": { - "blockIdList": [ - { - "id": "string", - "type": "string" - } - ], - "blockName": "string", - "hotelId": "string" - }, - "roomClass": "string", - "roomNumber": "string", - "roomNumberLocked": true, - "roomType": "string", - "roomTypeCharged": "string", - "scheduledCheckoutTime": "2020-08-26", - "sourceOfBusiness": "string", - "sourceOfBusinessDescription": "string", - "totalAmount": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStayReservation": true, - "searchMatches": [ - { - "attribute": "string", - "value": "string" - } - ], - "sharedGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - } - } - ], - "sourceOfSale": { - "sourceCode": "string", - "sourceType": "string" - }, - "specials": "string", - "taxType": { "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0 - }, - "turndownInfo": { - "allowed": true, - "status": "Required" - }, - "waitlist": { - "description": "string", - "priorityCode": "string", - "priorityDescription": "string", - "reasonCode": "string", - "reasonDescription": "string", - "telephone": "string" + "date": "2020-08-26" }, + "keyCount": 0, + "hotelId": "string", + "hotelName": "string", + "expectedServiceTime": "string", + "roomStayReservation": true, + "createDateTime": "2020-08-26T15:00:10.518Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.518Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "reservationStatus": "Reserved", + "computedReservationStatus": "Reserved", "walkInIndicator": true, - "welcomeOffer": true + "accessRestriction": "Change", + "commissionPayoutTo": "TravelAgent", + "paymentMethod": "string", + "preRegistered": true, + "openFolio": true, + "allowMobileCheckout": true, + "allowMobileViewFolio": true, + "optedForCommunication": true } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 } }, - "salesInfo": { - "accountSource": "string", - "accountType": "string", - "actionCode": "string", - "businessSegments": "string", - "competitionCode": "string", + "lastStayInfo": { + "lastVisit": "2020-08-26", + "lastRoom": "string", + "lastRate": { + "amount": 0, + "currencyCode": "string" + }, + "totalStay": 0 + }, + "profileAccessType": { + "chainCode": "string", + "croCode": "string", "hotelId": "string", - "industryCode": "string", - "influence": "string", - "preferredRoom": "string", - "priority": "string", - "roomsPotential": "string", - "scope": "string", - "scopeCity": "string" + "sharedLevel": "Global" }, - "statusCode": "Active", - "subscriptions": [ - { - "distributed": true, - "externalProfileId": { - "id": "string", - "type": "string" - }, - "force": true, - "inactive": true, - "lastDistributionDate": "2020-08-26T15:00:10.519Z", - "lastExternalUpdateDate": "2020-08-26T15:00:10.519Z", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - }, - "profileInfo": { - "fullName": "string", - "givenName": "string", - "middleName": "string", - "name": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Primary", - "profileType": "Guest" - }, - "subscriptionDate": "2020-08-26T15:00:10.519Z" - } - ], - "taxInfo": { - "businessId": "string", - "businessRegistration": "string", - "tax1No": "string", - "tax2No": "string", - "taxCategory": "string", - "taxOffice": "string", - "taxType": "string" + "profileRestrictions": { + "reason": "string", + "reasonDescription": "string", + "restricted": true }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ + "mailingActions": { + "mailingAction": [ { - "id": "string", - "telephone": { - "createDateTime": "2020-08-26T15:00:10.507Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.507Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, - "type": "string" + "code": "string", + "description": "string" } ], - "totalResults": 0 - }, - "territory": "string", - "traceCode": "string", - "uRLs": { - "count": 0, + "active": true, "hasMore": true, "totalResults": 0, - "uRLInfo": [ + "count": 0 + }, + "privacyInfo": { + "marketResearchParticipation": true, + "lastPrivacyPromptDate": "2020-08-26", + "infoFromThirdParty": true, + "autoEnrollLoyaltyProgram": true, + "allowPhone": true, + "allowSMS": true, + "allowEmail": true, + "optInMailingList": true, + "optInMarketResearch": true, + "optInThirdParty": true, + "optInAutoEnrollmentMember": true, + "optInPhone": true, + "optInSms": true, + "optInEmail": true + }, + "cashiering": { + "directBillingList": [ { - "id": "string", - "type": "string", - "url": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - } + "hotelId": "string", + "aRNumber": "string" } - ] + ], + "autoFolioSettlementType": "string", + "paymentDueDays": 0, + "taxPercent1": 0, + "taxPercent2": 0, + "taxPercent3": 0, + "taxPercent4": 0, + "taxPercent5": 0, + "arNoCentral": "string", + "referenceCurrency": "string", + "vATOffsetYN": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0 }, + "commissionInfoList": [ + { + "hotelId": "string", + "commissionCode": "string", + "bankAccount": "string", + "paymentMethod": "Cent", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0 + } + ], "userDefinedFields": { "characterUDFs": [ { - "alternateName": "string", "name": "string", - "value": "string" + "value": "string", + "alternateName": "string" } ], - "dateUDFs": [ + "numericUDFs": [ { - "alternateName": "string", "name": "string", - "value": "2020-08-26" + "value": 0, + "alternateName": "string" } ], - "numericUDFs": [ + "dateUDFs": [ { - "alternateName": "string", "name": "string", - "value": 0 + "value": "2020-08-26", + "alternateName": "string" } ] }, "webUserAccounts": [ { - "autoGeneratePassword": true, + "securityQuestion": { + "code": "string", + "description": "string" + }, + "securityAnswer": "string", "comments": "string", - "domainCode": "string", "history": { "createDateTime": "2020-08-26T15:00:10.519Z", "creatorId": "string", - "inactiveDate": "2020-08-26", - "lastLogin": "2020-08-26", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:00:10.519Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "lastLogin": "2020-08-26", "lastPasswordChange": "2020-08-26", - "purgeDate": "2020-08-26" + "inactiveDate": "2020-08-26" }, - "inactive": true, - "locked": true, - "loginName": "string", "newLoginName": "string", "newPassword": "string", - "securityAnswer": "string", - "securityQuestion": { - "code": "string", - "description": "string" - } + "autoGeneratePassword": true, + "loginName": "string", + "domainCode": "string", + "locked": true, + "inactive": true + } + ], + "taxInfo": { + "tax1No": "string", + "tax2No": "string", + "taxCategory": "string", + "taxOffice": "string", + "taxType": "string", + "businessId": "string", + "businessRegistration": "string" + }, + "salesInfo": { + "scope": "string", + "scopeCity": "string", + "accountType": "string", + "accountSource": "string", + "industryCode": "string", + "businessSegments": "string", + "priority": "string", + "roomsPotential": "string", + "actionCode": "string", + "competitionCode": "string", + "influence": "string", + "preferredRoom": "string", + "hotelId": "string" + }, + "eCertificates": [ + { + "certificateId": 0, + "voucherNo": "string", + "certificateNo": "string", + "eCertificateInfo": { + "certificateType": "string", + "membershipType": "string", + "awardCode": "string", + "promotionCode": "string", + "voucherBenefitCode": "string", + "hotels": { + "code": [ + "string" + ], + "scope": "Global" + }, + "description": "string", + "longDescription": "string", + "label": "string", + "maxExtensionAllowed": 0, + "usageCriteria": { + "reservation": true, + "web": true, + "webAllowed": true, + "benefit": true, + "hotel": true, + "verifyCertificateNo": true, + "cancelAllowed": true, + "generateInLieuCertificate": true + }, + "value": { + "amount": 0, + "currencyCode": "string" + }, + "cost": { + "amount": 0, + "currencyCode": "string" + }, + "benefitSummary": "string" + }, + "expiryDate": "2020-08-26", + "newExpiryDate": "2020-08-26", + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "consumptionDetail": { + "hotelId": "string", + "source": "Central", + "surname": "string", + "firstName": "string", + "middleName": "string", + "email": "string", + "date": "2020-08-26", + "userName": "string", + "userNotes": "string", + "referenceId": { + "id": "string", + "type": "string" + }, + "locationType": "string", + "authorizationCode": "string", + "serviceDate": "2020-08-26" + }, + "status": "Cancelled", + "printed": true, + "inactiveDate": "2020-08-26", + "awardId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "databaseId": "string", + "source": "Opera", + "issueType": "Assigned", + "issueDate": "2020-08-26", + "awardPoints": 0, + "generationDetail": { + "ruleId": { + "id": "string", + "type": "string" + }, + "generationDetail": "string", + "referenceValue": "string" + }, + "originalVoucherNo": "string", + "originalCertificateNo": "string", + "inLieuSequence": 0, + "cancelRequestDate": "2020-08-26", + "extensionCount": 0 + } + ], + "subscriptions": [ + { + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "externalProfileId": { + "id": "string", + "type": "string" + }, + "profileInfo": { + "name": "string", + "fullName": "string", + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameType": "Primary", + "profileType": "Guest" + }, + "distributed": true, + "force": true, + "subscriptionDate": "2020-08-26T15:00:10.519Z", + "lastDistributionDate": "2020-08-26T15:00:10.519Z", + "lastExternalUpdateDate": "2020-08-26T15:00:10.519Z", + "inactive": true } - ] + ], + "localizationGuestType": "string", + "eligibleForFiscalFolio": "string", + "profileType": "Guest", + "statusCode": "Active", + "registeredProperty": "string", + "requestForHotel": "string", + "protectedBy": "string", + "createDateTime": "2020-08-26T15:00:10.519Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.519Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "markAsRecentlyAccessed": true, + "markForHistory": true, + "hasCommission": true, + "inheritedNegRates": true }, - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], "reservationProfileType": "Company" } ], - "suppressRate": true, - "taxFreeGuestCounts": { - "adults": 0, + "guestCounts": { "childAges": [ { "age": 0 @@ -14107,363 +12171,322 @@ "bucket4Count": 0, "bucket5Count": 0 }, + "adults": 0, "children": 0 }, - "taxIncluded": true, - "total": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ - { - "amount": 0, - "code": "string", - "currencyCode": "string", - "description": "string", - "type": "Inclusive" - } - ] + "taxFreeGuestCounts": { + "childAges": [ + { + "age": 0 + } + ], + "childBuckets": { + "bucket1Count": 0, + "bucket2Count": 0, + "bucket3Count": 0, + "bucket4Count": 0, + "bucket5Count": 0 }, - "rateOverride": true, - "taxes": { - "amount": 0, - "currencyCode": "string", - "tax": [ - { - "amount": 0, - "code": "string", - "currencyCode": "string", - "description": "string", - "type": "Inclusive" - } - ] - } + "adults": 0, + "children": 0 }, - "totalPoints": { - "awardsType": "string", - "points": 0 - } + "awards": { + "membershipNo": { + "id": "string", + "type": "string" + }, + "awardVouchers": [ + { + "awardCode": "string", + "voucherNo": "string" + } + ], + "originalRoomType": "string", + "upgradeRoomType": "string" + }, + "foreignExchange": { + "type": "string", + "effectiveDate": "2020-08-26" + }, + "reservationBlock": { + "blockIdList": [ + { + "id": "string", + "type": "string" + } + ], + "blockName": "string", + "hotelId": "string" + }, + "roomRateInfo": "string", + "mealPlans": [ + { + "code": "string", + "included": true, + "breakfastIncluded": true, + "lunchIncluded": true, + "dinnerIncluded": true + } + ], + "roomType": "string", + "ratePlanCode": "string", + "promotionCode": "string", + "start": "2020-08-26", + "end": "2020-08-26", + "availability": "Available", + "suppressRate": true, + "marketCode": "string", + "marketCodeDescription": "string", + "sourceCode": "string", + "sourceCodeDescription": "string", + "numberOfUnits": 0, + "roomId": "string", + "pseudoRoom": true, + "roomTypeCharged": "string", + "commissionCode": "string", + "commissionable": true, + "houseUseOnly": true, + "complimentary": true, + "inventoryLender": "string", + "fixedRate": true, + "barRanking": 0, + "rateGroup": "string", + "discountAllowed": true, + "bogoDiscount": true, + "rateLevel": "string", + "commissionPercentage": 0, + "commissionAmount": 0, + "credentialsRequired": true, + "taxIncluded": true, + "rateDescription": "string" } ], + "guestCounts": { + "childAges": [ + { + "age": 0 + } + ], + "childBuckets": { + "bucket1Count": 0, + "bucket2Count": 0, + "bucket3Count": 0, + "bucket4Count": 0, + "bucket5Count": 0 + }, + "adults": 0, + "children": 0 + }, + "arrivalDate": "2020-08-26", + "departureDate": "2020-08-26", + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-08-26T15:00:10.520Z", + "reservationExpectedDepartureTime": "2020-08-26T15:00:10.520Z" + }, + "originalTimeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { + "promotionCode": "string", + "promotionName": "string", + "couponCode": "string" + }, "suiteWith": "string", "total": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ + "taxes": { + "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - }, - "rateOverride": true, - "taxes": { + ], "amount": 0, - "currencyCode": "string", - "tax": [ + "currencyCode": "string" + }, + "fees": { + "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true }, "totalPoints": { "awardsType": "string", "points": 0 }, + "multiValueAttrs": [ + "string" + ], "upsellInfo": { "originalInfo": { - "nights": 0, "rateCode": "string", + "totalAmount": { + "amount": 0, + "currencyCode": "string" + }, "roomType": { "code": "string", "description": "string" }, - "totalAmount": { - "amount": 0, - "currencyCode": "string" - } + "nights": 0 }, "upsellInfo": { - "firstNightUpsellAmount": { + "totalUpsellCharge": { "amount": 0, "currencyCode": "string" }, - "firstNightUpsellCharge": { + "totalUpsellMoneyAmount": { "amount": 0, "currencyCode": "string" }, - "percentageSavings": 0, - "roomLongDescription": "string", - "roomType": { - "code": "string", - "description": "string" - }, - "ruleCode": "string", - "ruleDescription": "string", - "ruleId": 0, - "totalActualRateAmount": { + "firstNightUpsellAmount": { "amount": 0, "currencyCode": "string" }, - "totalUpsellCharge": { + "firstNightUpsellCharge": { "amount": 0, "currencyCode": "string" }, - "totalUpsellMoneyAmount": { + "totalUpsellPoints": 0, + "totalActualRateAmount": { "amount": 0, "currencyCode": "string" }, - "totalUpsellPoints": 0, + "roomType": { + "code": "string", + "description": "string" + }, + "roomLongDescription": "string", + "ruleId": 0, + "ruleCode": "string", + "ruleDescription": "string", + "percentageSavings": 0, "upsellDate": "2020-08-26", "upsellUser": "string" } - } + }, + "mobileNotifications": { + "roomReady": "Pending", + "keyReady": "Pending", + "checkoutMessageReceived": true, + "requiresAction": true, + "errorMessage": "string" + }, + "roomNumberLocked": true, + "printRate": true, + "primaryShareType": "Primary", + "remoteCheckInAllowed": true, + "bookingMedium": "string", + "bookingMediumDescription": "string" } ] }, - "reciprocalRelationship": true, - "relativePosition": { - "distance": 0, - "distanceType": "string", - "drivingTime": "string" + "channelSummaryInfo": { + "bookingChannel": { + "channelCode": "string", + "channelName": "string", + "channelType": "string" + }, + "messageId": "string", + "summaryOnly": true }, "sellMessages": { - "count": 0, - "hasMore": true, "sellMessage": [ { - "chainCode": "string", + "message": "string", "croCode": "string", + "chainCode": "string", "hotelId": "string", - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "languageCode": "string", - "message": "string", - "ratePlanCode": "string", "roomType": "string", + "ratePlanCode": "string", + "languageCode": "string", "stickyFlagYn": "string", - "type": "string", + "usedInModule": "Blocks", "url": "string", - "usedInModule": "Blocks" + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 } ], - "totalResults": 0 - } - } - ], - "attractions": [ - { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:00:10.520Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.520Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true + "hasMore": true, + "totalResults": 0, + "count": 0 }, - "class": "string", - "code": "string", - "displaySeq": 0, - "generalDirections": "string", - "name": { - "defaultText": "string", - "translatedTexts": [ - { - "language": "string", - "value": "string" + "currencyExchangeRates": [ + { + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "description": "string", + "exchangeRate": { + "amount": 0, + "currencyCode": "string" } - ] - }, - "operationHours": "string", - "priceRange": "string", - "relativePosition": { - "distance": 0, - "distanceType": "string", - "drivingTime": "string" - }, - "type": "string", - "website": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - } + } + ], + "chainCode": "string", + "hotelId": "string", + "hotelCityCode": "string", + "hotelName": "string", + "hotelCodeContext": "string", + "chainName": "string", + "hotelType": "string", + "negotiated": true, + "alternate": true, + "displayOrder": 0, + "inventoryRooms": 0, + "availableRooms": 0, + "comments": "string", + "direction": "string", + "reciprocalRelationship": true, + "alternateHotelCode": "string", + "newAlternateHotelCode": "string" } ], - "chainCode": "string", - "chainName": "string", - "communication": { - "emailAddress": "string", - "faxNumber": { - "createDateTime": "2020-08-26T15:00:10.503Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.503Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, - "phoneNumber": { - "createDateTime": "2020-08-26T15:00:10.503Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.503Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, - "tollFreeNumber": { - "createDateTime": "2020-08-26T15:00:10.503Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:00:10.503Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, - "webPage": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - } - }, - "generalInformation": { - "baseLanguage": "string", - "bedCount": 0, - "checkInTime": "2020-08-26T15:00:10.503Z", - "checkOutTime": "2020-08-26T15:00:10.503Z", - "floorCount": 0, - "hotelInfoWebsite": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - }, - "hotelType": "string", - "latitude": 0, - "longitude": 0, - "roomCount": 0 - }, - "hotelCityCode": "string", - "hotelCodeContext": "string", "hotelContacts": [ { - "communicationAddress": "string", - "communicationMethod": "string", - "hotelId": "string", - "name": "string", "nameId": { "id": "string", "type": "string" }, - "ownerCode": "string", - "primary": true, + "hotelId": "string", + "name": "string", "roles": [ "Lead" - ] + ], + "ownerCode": "string", + "communicationMethod": "string", + "communicationAddress": "string", + "primary": true } ], - "hotelCorporateInformations": { - "brandCode": "string", - "businessUnit": [ - { - "codeDescription": { - "code": "string", - "description": "string" - }, - "primary": true - } - ], - "departmentCode": [ - { - "codeDescription": { - "code": "string", - "description": "string" - }, - "primary": true - } - ], - "division": [ - { - "codeDescription": { - "code": "string", - "description": "string" - }, - "primary": true - } - ], - "hotelCategory": "string", - "opertingUnit": [ - { - "codeDescription": { - "code": "string", - "description": "string" - }, - "primary": true - } - ] - }, "hotelEventSpaces": { "eventSpaceDetails": [ { @@ -14477,156 +12500,192 @@ ], "eventSpaceSummaries": [ { + "no": 0, + "spaceType": "string", "maxCapacity": 0, "maxOccupancies": [ 0 - ], - "no": 0, - "spaceType": "string" + ] } ], "setupStyles": [ "string" ] }, - "hotelId": "string", - "hotelName": "string", "hotelNotes": [ { "comment": { - "actionDate": "2020-08-26", - "actionType": "string", + "text": { + "value": "string", + "language": "string" + }, + "image": "string", + "url": "string", "commentTitle": "string", + "notificationLocation": "string", + "type": "string", + "typeDescription": "string", + "internal": true, "confidential": true, + "overrideInternal": true, + "protectDescription": true, + "hotelId": "string", + "actionType": "string", + "actionDate": "2020-08-26", "createDateTime": "2020-08-26T15:00:10.520Z", "creatorId": "string", - "hotelId": "string", - "image": "string", - "internal": true, - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:00:10.520Z", - "notificationLocation": "string", - "overrideInternal": true, - "protectDescription": true, - "purgeDate": "2020-08-26", - "text": { - "language": "string", - "value": "string" - }, - "type": "string", - "typeDescription": "string", - "url": "string" + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, "createDateTime": "2020-08-26T15:00:10.520Z", "creatorId": "string", - "id": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:00:10.520Z", + "lastModifierId": "string", "purgeDate": "2020-08-26", + "id": "string", "type": "string" } ], - "hotelRateRanges": [ - { - "currencyCode": "string", - "hotelId": "string", - "maxRate": 0, - "minRate": 0, - "timeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" + "hotelCorporateInformations": { + "brandCode": "string", + "hotelCategory": "string", + "businessUnit": [ + { + "primary": true, + "codeDescription": { + "code": "string", + "description": "string" + } } - } - ], - "hotelRestaurants": [ - { - "category": "Restaurant", - "comments": "string", - "hotelId": "string", - "hours": "string", - "newRestaurantCode": "string", - "orderBy": 0, - "priceRange": "string", - "restaurantCode": "string", - "restaurantName": "string", - "restaurantType": "string", - "timeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" + ], + "departmentCode": [ + { + "primary": true, + "codeDescription": { + "code": "string", + "description": "string" + } + } + ], + "division": [ + { + "primary": true, + "codeDescription": { + "code": "string", + "description": "string" + } + } + ], + "opertingUnit": [ + { + "primary": true, + "codeDescription": { + "code": "string", + "description": "string" + } } + ] + }, + "attractions": [ + { + "name": { + "defaultText": "string", + "translatedTexts": [ + { + "value": "string", + "language": "string" + } + ] + }, + "type": "string", + "class": "string", + "generalDirections": "string", + "relativePosition": { + "distance": 0, + "distanceType": "string", + "drivingTime": "string" + }, + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:00:10.520Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:00:10.520Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "website": { + "value": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 + }, + "priceRange": "string", + "operationHours": "string", + "displaySeq": 0, + "code": "string" } ], "meetingRooms": [ { - "charge": "string", "code": "string", + "charge": "string", "description": "string" } ], - "primaryDetails": { - "legalOwner": "string" - }, - "propertyControls": { - "applicationMode": { - "configurationMode": "string", - "countryMode": "string", - "expHotelCode": "string", - "mbsSupported": true, - "touristNumber": "string" - }, - "cateringCurrencyFormatting": { - "currencyCode": "string", - "currencyFormat": "string" - }, - "currencyFormatting": { - "currencyCode": "string", - "currencyFormat": "string", - "currencySymbol": "string", - "decimalPositions": 0 - }, - "dateTimeFormatting": { - "longDateFormat": "string", - "shortDateFormat": "string", - "timeFormat": "string", - "timeZoneRegion": "string" - }, - "sellControls": { - "endDate": "2020-08-26", - "hotelId": "string", - "startDate": "2020-08-26" - } - } + "chainCode": "string", + "hotelId": "string", + "hotelCityCode": "string", + "hotelName": "string", + "hotelCodeContext": "string", + "chainName": "string" }, - "links": [ - { - "href": "string", - "method": "GET", - "operationId": "string", - "rel": "string", - "targetSchema": "string", - "templated": false, - "title": "string" - } - ], "masterInfoList": [ { "codeInfo": [ { + "description": "string", "addtionalCodeInfo": [ { "name": "LongDescription", "value": "string" } ], - "code": "string", - "description": "string", - "hotelId": "string" + "hotelId": "string", + "code": "string" } ], "codeType": "Country" } + ], + "links": [ + { + "href": "string", + "rel": "string", + "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", + "title": "string" + } ] } } @@ -14635,56 +12694,151 @@ "description": "Hotel not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", + "$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": "Update hotel information", + "description": "Use this API to update hotel configuration information.OperationId:putHotel
", + "operationId": "putHotel", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." + }, + { + "name": "hotelToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing Property general information.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/hotelToBeChanged" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$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": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/airports": { - "get": { - "description": "Use this API to get resort airports.OperationId:getAirports
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14693,156 +12847,133 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/airports": { + "get": { "summary": "Get resort airports", + "description": "Use this API to get resort airports.OperationId:getAirports
", "operationId": "getAirports", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "type": "integer", - "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.", "name": "pageNumber", - "in": "query" + "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": "airportCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Airport code identifying the airport.", - "name": "airportCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching airports configured for hotels.", - "schema": { - "$ref": "#/definitions/airportsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching airports configured for hotels.", + "schema": { + "$ref": "#/definitions/airportsDetails" } }, "204": { "description": "Airports not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create new resort airports.OperationId:postAirports
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14851,24 +12982,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create new resort airports", + "description": "Use this API to create new resort airports.OperationId:postAirports
", "operationId": "postAirports", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new airports for hotels.", "name": "airportsCriteria", "in": "body", "required": true, + "description": "Request object for creating new airports for hotels.", "schema": { "allOf": [ { @@ -14878,111 +13012,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/airports/{airportCode}": { - "put": { - "description": "Use this API to update airports for a specific property based on airportCode, hotelId, airportsToBeChanged.OperationId:changeAirports
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14991,33 +13091,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/airports/{airportCode}": { + "put": { "summary": "Change resort airports", + "description": "Use this API to update resort airports.OperationId:changeAirports
", "operationId": "changeAirports", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of airport.", "name": "airportCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of airport." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for modifying airports for hotels.", "name": "airportsToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying airports for hotels.", "schema": { "allOf": [ { @@ -15027,109 +13132,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete airports for a specific property based on airportCode, hotelId.OperationId:removeAirports
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15138,134 +13211,103 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete resort airports", + "description": "Use this API to delete resort airports.OperationId:removeAirports
", "operationId": "removeAirports", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of airport.", "name": "airportCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of airport." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/alternates": { - "post": { - "description": "This API Use this API to creates the hotels Alternate Hotel information.OperationId:postAlternateHotels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15274,24 +13316,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/alternates": { + "post": { "summary": "Create Alternate Hotels", + "description": "This API Use this API to creates the hotels Alternate Hotel information.OperationId:postAlternateHotels
", "operationId": "postAlternateHotels", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new Alternate Hotels for hotels.", "name": "alternateHotelsCriteria", "in": "body", "required": true, + "description": "Request object for creating new Alternate Hotels for hotels.", "schema": { "allOf": [ { @@ -15301,111 +13348,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/alternates/{alternateHotelId}": { - "put": { - "description": "Use this API to update alternate hotels for a specific property based on alternateHotelId, hotelId, alternateHotelsToBeChanged.OperationId:changeAlternateHotels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15414,33 +13427,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/alternates/{alternateHotelId}": { + "put": { "summary": "Update Alternate Hotels", + "description": "This API updated the hotel's Alternate Hotel information.OperationId:changeAlternateHotels
", "operationId": "changeAlternateHotels", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of alternate hotel.", "name": "alternateHotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of alternate hotel." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing hotel Alternate Hotels for hotels.", "name": "alternateHotelsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing hotel Alternate Hotels for hotels.", "schema": { "allOf": [ { @@ -15450,109 +13468,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete the alternate hotels for a specific property based on alternateHotelId, hotelId.OperationId:removeAlternateHotels
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15561,134 +13547,103 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Alternate Hotels", + "description": "This API Use this API to deletes the hotel's Alternate Hotel information.OperationId:removeAlternateHotels
", "operationId": "removeAlternateHotels", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of alternate hotel.", "name": "alternateHotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of alternate hotel." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/amenities": { - "get": { - "description": "Use this API to get amenities.OperationId:getAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15697,155 +13652,132 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/amenities": { + "get": { "summary": "Get amenities", + "description": "Use this API to get amenities.OperationId:getAmenities
", "operationId": "getAmenities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "boolean", - "description": "Is it a General amenity type.", "name": "general", - "in": "query" + "in": "query", + "required": false, + "description": "Is it a General amenity type.", + "type": "boolean" }, { - "type": "boolean", - "description": "Is it a Meeting amenity type.", "name": "meeting", - "in": "query" + "in": "query", + "required": false, + "description": "Is it a Meeting amenity type.", + "type": "boolean" }, { + "name": "amenityCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "amenityCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching amenities at the property level.", - "schema": { - "$ref": "#/definitions/amenitiesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching amenities at the property level.", + "schema": { + "$ref": "#/definitions/amenitiesDetails" } }, "204": { "description": "Amenities not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create amenities.OperationId:postAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15854,24 +13786,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create amenities", + "description": "Use this API to create amenities.OperationId:postAmenities
", "operationId": "postAmenities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating amenities at the property level.", "name": "amenitiesCriteria", "in": "body", "required": true, + "description": "Request object for creating amenities at the property level.", "schema": { "allOf": [ { @@ -15881,111 +13816,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/amenities/{featureCode}": { - "put": { - "description": "Use this API to update amenities for a specific property based on featureCode, hotelId, amenitiesToBeChanged.OperationId:changeAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15994,33 +13895,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/amenities/{featureCode}": { + "put": { "summary": "Change amenities", + "description": "Use this API to update amenities.OperationId:changeAmenities
", "operationId": "changeAmenities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of feature.", "name": "featureCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of feature." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing amenities at the property level.", "name": "amenitiesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing amenities at the property level.", "schema": { "allOf": [ { @@ -16030,109 +13936,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete amenities for a specific property based on featureCode, hotelId, beginDate.OperationId:removeAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16141,145 +14015,115 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete amenities", + "description": "Use this API to delete amenities.OperationId:removeAmenities
", "operationId": "removeAmenities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of feature.", "name": "featureCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of feature." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "beginDate", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "The date the amenity is scheduled to become active.", "items": { "type": "string", "format": "date" }, - "collectionFormat": "multi", - "description": "The date the amenity is scheduled to become active.", - "name": "beginDate", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/attractions": { - "get": { - "description": "Use this API to get Attractions.OperationId:getAttractions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16288,160 +14132,137 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/attractions": { + "get": { "summary": "Get Attractions", + "description": "Use this API to get Attractions.OperationId:getAttractions
", "operationId": "getAttractions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { + "name": "attractionCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "attractionCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { + "name": "classCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "classCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for information regarding attraction.", - "schema": { - "$ref": "#/definitions/attractionsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 attraction.", + "schema": { + "$ref": "#/definitions/attractionsDetails" } }, "204": { "description": "Attractions not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "This API can be used to Use this API to create a new attraction for a property. .OperationId:postAttractions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16450,24 +14271,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Attractions", + "description": "This API can be used to Use this API to create a new attraction for a property. .OperationId:postAttractions
", "operationId": "postAttractions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating a new group of attractions.", "name": "attractionsCriteria", "in": "body", "required": true, + "description": "Request object for creating a new group of attractions.", "schema": { "allOf": [ { @@ -16477,111 +14301,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/attractions/{attractionCode}": { - "put": { - "description": "Use this API to update attractions for a specific property based on attractionCode, hotelId, attractionsToBeChanged.OperationId:changeAttractions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16590,33 +14380,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/attractions/{attractionCode}": { + "put": { "summary": "Update an Attraction", + "description": "This API is used to Use this API to update an existing attraction. .OperationId:changeAttractions
", "operationId": "changeAttractions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of attraction.", "name": "attractionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of attraction." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for modifying an existing attraction.", "name": "attractionsToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying an existing attraction.", "schema": { "allOf": [ { @@ -16626,109 +14421,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete attractions for a specific property based on attractionCode, hotelId, attractionCodes.OperationId:removeAttractions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16737,144 +14500,114 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Attractions", + "description": " Use this API to remove an existing attraction.OperationId:removeAttractions
", "operationId": "removeAttractions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of attraction.", "name": "attractionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of attraction." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "array", + "name": "attractionCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Configuration code.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Configuration code.", - "name": "attractionCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/calendar": { - "get": { - "description": "Use this API to get detailed information of calendar entries for a date range.OperationId:getHotelCalendar
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16883,154 +14616,125 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/calendar": { + "get": { "summary": "Get Hotel Calendar", + "description": "Use this API to get detailed information of calendar entries for a date range.OperationId:getHotelCalendar
", "operationId": "getHotelCalendar", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "format": "date", "name": "startDate", "in": "query", - "required": true + "required": true, + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", "name": "endDate", "in": "query", - "required": true + "required": true, + "type": "string", + "format": "date" }, { - "uniqueItems": true, + "name": "fetchInstructions", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Indicates entries for a day in calendar. Entries can vary between day types, events, etc.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "DayType", "Event" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Indicates entries for a day in calendar. Entries can vary between day types, events, etc.", - "name": "fetchInstructions", - "in": "query", "required": true }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching calendar entries for a hotel.", - "schema": { - "$ref": "#/definitions/hotelCalendarDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching calendar entries for a hotel.", + "schema": { + "$ref": "#/definitions/hotelCalendarDetails" } }, "204": { "description": "HotelCalendar not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/contacts": { - "post": { - "description": "Use this API to create Hotel Contacts.OperationId:postHotelContacts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17039,24 +14743,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/contacts": { + "post": { "summary": "Create Hotel Contacts", + "description": "Use this API to create Hotel Contacts.OperationId:postHotelContacts
", "operationId": "postHotelContacts", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new Contacts for hotels.", "name": "hotelContactsCriteria", "in": "body", "required": true, + "description": "Request object for creating new Contacts for hotels.", "schema": { "allOf": [ { @@ -17066,111 +14775,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/contacts/{contactId}": { - "put": { - "description": "Use this API to update hotel contacts for a specific property based on contactId, hotelId, hotelContactsToBeChanged.OperationId:changeHotelContacts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17179,33 +14854,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/contacts/{contactId}": { + "put": { "summary": "Change Hotel Contact", + "description": "Use this API to update Hotel Contact.OperationId:changeHotelContacts
", "operationId": "changeHotelContacts", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of contact.", "name": "contactId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of contact." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing hotel Contacts for hotels.", "name": "hotelContactsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing hotel Contacts for hotels.", "schema": { "allOf": [ { @@ -17215,109 +14895,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete hotel contacts for a specific property based on contactId, hotelId, idExtension.OperationId:removeHotelContacts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17326,140 +14974,110 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Hotel contact", + "description": "Use this API to delete Hotel contact.OperationId:removeHotelContacts
", "operationId": "removeHotelContacts", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of contact.", "name": "contactId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of contact." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/countries": { - "get": { - "description": "Use this API to get Countries.OperationId:getCountries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17468,153 +15086,129 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/countries": { + "get": { "summary": "Get Countries", + "description": "Use this API to get Countries.OperationId:getCountries
", "operationId": "getCountries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "type": "integer", - "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.", "name": "pageNumber", - "in": "query" + "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": "countriesCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "countriesCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "maxLength": 4000, + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Countries.", - "schema": { - "$ref": "#/definitions/countriesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Countries.", + "schema": { + "$ref": "#/definitions/countriesDetails" } }, "204": { "description": "Countries not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/countries/{countryCode}": { - "put": { - "description": "Use this API to update country codes for a specific property based on countryCode, hotelId, countriesToBeChanged.OperationId:changeCountries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17623,33 +15217,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/countries/{countryCode}": { + "put": { "summary": "Update a Country Code", + "description": "Update a Country Code.OperationId:changeCountries
", "operationId": "changeCountries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of country.", "name": "countryCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of country." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for modifying Countries for hotels.", "name": "countriesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying Countries for hotels.", "schema": { "allOf": [ { @@ -17659,111 +15258,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/creditcardTypes": { - "get": { - "description": "Use this API to get Credit Card Types.OperationId:getCreditCardTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17772,162 +15337,140 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/creditcardTypes": { + "get": { "summary": "Get Credit Card Types", + "description": "Use this API to get Credit Card Types.OperationId:getCreditCardTypes
", "operationId": "getCreditCardTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Credit Card Types.", - "schema": { - "$ref": "#/definitions/creditCardTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Credit Card Types.", + "schema": { + "$ref": "#/definitions/creditCardTypesDetails" } }, "204": { "description": "CreditCardTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to update credit card types for a specific property based on hotelId, creditCardTypesToBeChanged.OperationId:changeCreditCardTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17936,136 +15479,105 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Change Credit Card Types", - "operationId": "changeCreditCardTypes", + ] + }, + "delete": { + "summary": "Delete Credit Card Types", + "description": "Use this API to delete Credit Card Types.OperationId:removeCreditCardTypes
", + "operationId": "removeCreditCardTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing Credit Card Types.", - "name": "creditCardTypesToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/creditCardTypesToBeChanged" - } - ] - } + "name": "creditCardTypesCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Configuration code.", + "items": { + "type": "string" + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Credit Card Types.OperationId:postCreditCardTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18074,136 +15586,107 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Create Credit Card Types", - "operationId": "postCreditCardTypes", + ] + }, + "put": { + "summary": "Change Credit Card Types", + "description": "Use this API to update Credit Card Types.OperationId:changeCreditCardTypes
", + "operationId": "changeCreditCardTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating Credit Card Types.", - "name": "creditCardTypesCriteria", + "name": "creditCardTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Credit Card Types.", "schema": { "allOf": [ { - "$ref": "#/definitions/creditCardTypesCriteria" + "$ref": "#/definitions/creditCardTypesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete credit card types for a specific property based on hotelId, creditCardTypesCode.OperationId:removeCreditCardTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18212,135 +15695,107 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Delete Credit Card Types", - "operationId": "removeCreditCardTypes", + ] + }, + "post": { + "summary": "Create Credit Card Types", + "description": "Use this API to create Credit Card Types.OperationId:postCreditCardTypes
", + "operationId": "postCreditCardTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "description": "Configuration code.", - "name": "creditCardTypesCode", - "in": "query" + "name": "creditCardTypesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Credit Card Types.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/creditCardTypesCriteria" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/dayTypeCodes": { - "get": { - "description": "Use this API to get Hotel Day Type Codes.OperationId:getHotelDayTypeCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18349,150 +15804,126 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/dayTypeCodes": { + "get": { "summary": "Get Hotel Day Type Codes", + "description": "Use this API to get Hotel Day Type Codes.OperationId:getHotelDayTypeCodes
", "operationId": "getHotelDayTypeCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { + "name": "dayTypesCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "dayTypesCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching day type codes for a hotel.", - "schema": { - "$ref": "#/definitions/hotelDayTypeCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching day type codes for a hotel.", + "schema": { + "$ref": "#/definitions/hotelDayTypeCodesDetails" } }, "204": { "description": "HotelDayTypeCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to update day type codes for a specific property based on hotelId, hotelDayTypeCodesToBeChanged.OperationId:changeHotelDayTypeCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18501,24 +15932,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "put": { "summary": "Change Hotel Day Type Codes", + "description": "Use this API to update Hotel Day Type Codes.OperationId:changeHotelDayTypeCodes
", "operationId": "changeHotelDayTypeCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for modifying day type codes for a hotel.", "name": "hotelDayTypeCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying day type codes for a hotel.", "schema": { "allOf": [ { @@ -18528,109 +15962,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Hotel Day Type Codes.OperationId:postHotelDayTypeCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18639,24 +16041,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Hotel Day Type Codes", + "description": "Use this API to create Hotel Day Type Codes.OperationId:postHotelDayTypeCodes
", "operationId": "postHotelDayTypeCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new day type codes for a hotel.", "name": "hotelDayTypeCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating new day type codes for a hotel.", "schema": { "allOf": [ { @@ -18666,109 +16071,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete day type codes for a specific property based on hotelId, hotelIds.OperationId:removeHotelDayTypeCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18777,135 +16150,105 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Hotel Day Type Codes", + "description": "Use this API to delete Hotel Day Type Codes.OperationId:removeHotelDayTypeCodes
", "operationId": "removeHotelDayTypeCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Configuration code.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Configuration code.", - "name": "hotelIds", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/events": { - "put": { - "description": "Use this API to update events for a specific property based on hotelId, setHotelEvents.OperationId:setHotelEvents
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18914,24 +16257,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/events": { + "put": { "summary": "Set hotel events ", + "description": "Set hotel events.OperationId:setHotelEvents
", "operationId": "setHotelEvents", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for setting hotel events for specified date range.", "name": "setHotelEvents", "in": "body", "required": true, + "description": "Request object for setting hotel events for specified date range.", "schema": { "allOf": [ { @@ -18941,111 +16289,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/events/{eventId}": { - "delete": { - "description": "Use this API to delete events for a specific property based on parameters such as eventId, hotelId, startDate, endDate, duration.OperationId:removeHotelEvents
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19054,186 +16368,167 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/events/{eventId}": { + "delete": { "summary": "Delete Hotel Events", + "description": "Use this API to delete Hotel Events.OperationId:removeHotelEvents
", "operationId": "removeHotelEvents", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of event.", "name": "eventId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of event." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "boolean", "name": "friday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "monday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "saturday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "sunday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "thursday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "tuesday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "boolean", "name": "wednesday", - "in": "query" + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "string", - "format": "date", "name": "startDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", "name": "endDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", "name": "duration", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/hotelBrochure": { - "get": { - "description": "This API Use this API to gets the hotel brochure information based on the search criteria. The Hotel code and a set of instructions can be sent as part of the request message.OperationId:getHotelBrochure
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -19242,1240 +16537,1412 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Get Hotel Brochure", - "operationId": "getHotelBrochure", + ] + } + }, + "/hotels/{hotelId}/flexFields/{flexFieldId}": { + "get": { + "summary": "Operation to fetch the flex field details.", + "description": "API to fetch the flex field details.
OperationId:getFlexField
", + "operationId": "getFlexField", + "deprecated": false, "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", - "name": "hotelId", + "name": "flexFieldId", "in": "path", - "required": true + "required": true, + "type": "number", + "description": "Flex Field ID" }, { - "uniqueItems": true, - "type": "array", - "items": { - "enum": [ - "General", - "Attraction", - "Transportation", - "Package", - "Dining", - "Feature", - "Directions", - "GeneralNotes", - "Airports", - "Alternatehotels", - "Miscellaneous", - "Raterange", - "Contacts", - "EventSpaces", - "Notes", - "Corporateinformation", - "Meetingrooms" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "Simple type for hotel fetch instruction.", - "name": "fetchInstructions", - "in": "query" + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique ID of the hotel in OPERA" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Basic Property information.", - "schema": { - "$ref": "#/definitions/hotelBrochureDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, - "examples": { - "application/json": { - "hotelBrochure": { - "accommodationDetails": { - "accessibleRooms": 0, - "connectingRooms": 0, - "doubleRooms": 0, - "executiveFloorNo": "string", + "description": "Response object for fetching the configuration of flex fields.", + "schema": { + "$ref": "#/definitions/flexFieldCriteria" + } + }, + "204": { + "description": "Flex field 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" + ] + }, + "put": { + "summary": "Operation to update flex field.", + "description": "Operation to update flex field.OperationId:updateFlexField
", + "operationId": "updateFlexField", + "parameters": [ + { + "name": "flexFieldId", + "in": "path", + "required": true, + "type": "number", + "description": "Flex Field ID" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique ID of the hotel in OPERA" + }, + { + "name": "flexFieldDetail", + "in": "body", + "required": true, + "description": "Request object for updating the configuration of flex fields.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/flexFieldCriteria" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "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": "Operation to delete a flex field.", + "description": "Operation to delete a flex field.OperationId:deleteFlexField
", + "operationId": "deleteFlexField", + "parameters": [ + { + "name": "flexFieldId", + "in": "path", + "required": true, + "type": "number", + "description": "Flex Field ID" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique ID of the hotel in OPERA" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of newly created resource" + } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ChainConfig" + ] + } + }, + "/hotels/{hotelId}/hotelBrochure": { + "get": { + "summary": "Get Hotel Brochure", + "description": "This API Use this API to gets the hotel brochure information based on the search criteria. The Hotel code and a set of instructions can be sent as part of the request message.OperationId:getHotelBrochure
", + "operationId": "getHotelBrochure", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." + }, + { + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Simple type for hotel fetch instruction.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "General", + "Attraction", + "Transportation", + "Package", + "Dining", + "Feature", + "Directions", + "GeneralNotes", + "Airports", + "Alternatehotels", + "Miscellaneous", + "Raterange", + "Contacts", + "EventSpaces", + "Notes", + "Corporateinformation", + "Meetingrooms" + ] + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 Basic Property information.", + "schema": { + "$ref": "#/definitions/hotelBrochureDetails" + }, + "examples": { + "application/json": { + "hotelBrochure": { + "primaryDetails": { + "legalOwner": "string" + }, + "generalInformation": { + "hotelType": "string", + "roomCount": 0, + "bedCount": 0, + "floorCount": 0, + "checkInTime": "2020-08-26T15:05:08.986Z", + "checkOutTime": "2020-08-26T15:05:08.986Z", + "hotelInfoWebsite": { + "value": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 + }, + "longitude": 0, + "latitude": 0, + "baseLanguage": "string" + }, + "accommodationDetails": { + "singleRooms": 0, + "doubleRooms": 0, + "twinRooms": 0, "familyRooms": 0, - "guestRoomElevators": 0, - "guestRoomFloors": 0, + "connectingRooms": 0, + "accessibleRooms": 0, + "nonSmokingRooms": 0, "maxAdultsInFamilyRoom": 0, "maxChildrenInFamilyRoom": 0, - "nonSmokingRooms": 0, - "roomAmenties": "string", - "shopDescription": "string", - "singleRooms": 0, + "guestRoomFloors": 0, + "guestRoomElevators": 0, "suites": 0, - "twinRooms": 0 + "executiveFloorNo": "string", + "roomAmenties": "string", + "shopDescription": "string" + }, + "propertyControls": { + "sellControls": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "hotelId": "string" + }, + "currencyFormatting": { + "currencyCode": "string", + "currencyFormat": "string", + "currencySymbol": "string", + "decimalPositions": 0 + }, + "cateringCurrencyFormatting": { + "currencyCode": "string", + "currencyFormat": "string" + }, + "dateTimeFormatting": { + "longDateFormat": "string", + "shortDateFormat": "string", + "timeFormat": "string", + "timeZoneRegion": "string" + }, + "applicationMode": { + "configurationMode": "string", + "countryMode": "string", + "expHotelCode": "string", + "touristNumber": "string", + "mbsSupported": true + } + }, + "communication": { + "phoneNumber": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.986Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.986Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "tollFreeNumber": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.986Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.986Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "faxNumber": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.986Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.986Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "emailAddress": "string", + "webPage": { + "value": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 + } }, "address": { "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", "createDateTime": "2020-08-26T15:05:08.986Z", "creatorId": "string", - "language": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:05:08.986Z", - "postalCode": "string", - "primaryInd": true, + "lastModifierId": "string", "purgeDate": "2020-08-26", - "regionCode": "string", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true + "regionCode": "string" }, + "hotelRestaurants": [ + { + "restaurantName": "string", + "restaurantType": "string", + "hours": "string", + "priceRange": "string", + "comments": "string", + "category": "Restaurant", + "timeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "newRestaurantCode": "string", + "restaurantCode": "string", + "orderBy": 0, + "hotelId": "string" + } + ], + "hotelRateRanges": [ + { + "timeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "minRate": 0, + "maxRate": 0, + "currencyCode": "string", + "hotelId": "string" + } + ], "alternateHotels": [ { "address": { "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", - "createDateTime": "2020-08-26T15:05:08.986Z", - "creatorId": "string", "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.986Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", "type": "string", "typeDescription": "string", - "updateReservations": true - }, - "alternate": true, - "alternateHotelCode": "string", - "availableRooms": 0, - "chainCode": "string", - "chainName": "string", - "channelSummaryInfo": { - "bookingChannel": { - "channelCode": "string", - "channelName": "string", - "channelType": "string" - }, - "messageId": "string", - "summaryOnly": true + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:05:08.986Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.986Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, - "comments": "string", "contactNumbers": [ { - "createDateTime": "2020-08-26T15:05:08.986Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.987Z", - "orderSequence": 0, - "phoneNumber": "string", "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.986Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.987Z", + "lastModifierId": "string", "purgeDate": "2020-08-26" } ], - "currencyExchangeRates": [ - { - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "exchangeRate": { - "amount": 0, - "currencyCode": "string" - } - } - ], - "direction": "string", - "displayOrder": 0, - "event": true, - "hotelAmenities": [ - { - "code": "string", - "description": "string", - "displayOrder": 0, - "type": "string" - } - ], - "hotelCityCode": "string", - "hotelCodeContext": "string", - "hotelId": "string", - "hotelName": "string", - "hotelType": "string", - "inventoryRooms": 0, - "maxRate": { + "minRate": { "amount": 0, "currencyCode": "string" }, - "minRate": { + "maxRate": { "amount": 0, "currencyCode": "string" }, - "negotiated": true, - "newAlternateHotelCode": "string", + "relativePosition": { + "distance": 0, + "distanceType": "string", + "drivingTime": "string" + }, + "hotelAmenities": [ + { + "description": "string", + "code": "string", + "type": "string", + "displayOrder": 0 + } + ], + "event": true, "rateRoomDetails": { "memberships": [ { - "associatedReservationsOnly": true, "membershipId": "string", "membershipLevel": [ "string" ], "membershipType": [ "string" - ] + ], + "associatedReservationsOnly": true } ], "restrictionType": "Closed", "roomStays": [ { - "arrivalDate": "2020-08-26", - "bookingMedium": "string", - "bookingMediumDescription": "string", - "departureDate": "2020-08-26", - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-08-26T15:05:08.994Z", - "reservationExpectedDepartureTime": "2020-08-26T15:05:08.994Z" - }, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestCounts": { - "adults": 0, - "childAges": [ - { - "age": 0 - } - ], - "childBuckets": { - "bucket1Count": 0, - "bucket2Count": 0, - "bucket3Count": 0, - "bucket4Count": 0, - "bucket5Count": 0 - }, - "children": 0 - }, - "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", - "keyReady": "Pending", - "requiresAction": true, - "roomReady": "Pending" - }, - "multiValueAttrs": [ - "string" - ], - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" - }, - "primaryShareType": "Primary", - "printRate": true, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "remoteCheckInAllowed": true, - "roomNumberLocked": true, "roomRates": [ { - "availability": "Available", - "awards": { - "awardVouchers": [ - { - "awardCode": "string", - "voucherNo": "string" - } - ], - "membershipNo": { - "id": "string", - "type": "string" + "total": { + "taxes": { + "tax": [ + { + "description": "string", + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" + } + ], + "amount": 0, + "currencyCode": "string" }, - "originalRoomType": "string", - "upgradeRoomType": "string" - }, - "barRanking": 0, - "bogoDiscount": true, - "commissionAmount": 0, - "commissionCode": "string", - "commissionPercentage": 0, - "commissionable": true, - "complimentary": true, - "credentialsRequired": true, - "discountAllowed": true, - "end": "2020-08-26", - "fixedRate": true, - "foreignExchange": { - "effectiveDate": "2020-08-26", - "type": "string" - }, - "guestCounts": { - "adults": 0, - "childAges": [ - { - "age": 0 - } - ], - "childBuckets": { - "bucket1Count": 0, - "bucket2Count": 0, - "bucket3Count": 0, - "bucket4Count": 0, - "bucket5Count": 0 + "fees": { + "fee": [ + { + "description": "string", + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" + } + ], + "amount": 0, + "currencyCode": "string" }, - "children": 0 + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true + }, + "totalPoints": { + "awardsType": "string", + "points": 0 }, - "houseUseOnly": true, - "inventoryLender": "string", - "marketCode": "string", - "marketCodeDescription": "string", - "mealPlans": [ - { - "breakfastIncluded": true, - "code": "string", - "dinnerIncluded": true, - "included": true, - "lunchIncluded": true - } - ], - "numberOfUnits": 0, - "packages": [ - { - "addRateCombinedLine": true, - "addRateSeprateLine": true, - "allowance": { - "amount": 0, - "currencyCode": "string" - }, - "amount": { - "amount": 0, - "currencyCode": "string" - }, - "calculationRule": "string", - "description": [ - "string" - ], - "endDate": "2020-08-26", - "endTime": "string", - "includedInRate": true, - "packageCode": "string", - "postingRhythm": "string", - "quantity": 0, - "sellSeparate": true, - "startDate": "2020-08-26", - "startTime": "string" - } - ], - "promotionCode": "string", - "pseudoRoom": true, - "rateDescription": "string", - "rateGroup": "string", - "rateLevel": "string", - "ratePlanCode": "string", "rates": { "rate": [ { + "base": { + "taxes": { + "tax": [ + { + "description": "string", + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" + } + ], + "amount": 0, + "currencyCode": "string" + }, + "fees": { + "fee": [ + { + "description": "string", + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" + } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true + }, "additionalGuestAmounts": [ { - "ageQualifyingCode": "ADULT", "amount": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ + "taxes": { + "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - }, - "rateOverride": true, - "taxes": { + ], "amount": 0, - "currencyCode": "string", - "tax": [ + "currencyCode": "string" + }, + "fees": { + "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true + }, + "ageQualifyingCode": "ADULT" } ], - "base": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", + "discount": { + "discountReason": "string", + "percent": 0, + "amount": 0, "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ - { - "amount": 0, - "code": "string", - "currencyCode": "string", - "description": "string", - "type": "Inclusive" - } - ] - }, - "rateOverride": true, + "discountCode": "string" + }, + "shareRatePercentage": 0, + "shareDistributionInstruction": "Full", + "total": { "taxes": { - "amount": 0, - "currencyCode": "string", "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } - }, - "discount": { - "amount": 0, - "currencyCode": "string", - "discountCode": "string", - "discountReason": "string", - "percent": 0 - }, - "effectiveRate": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { + ], "amount": 0, - "currencyCode": "string", + "currencyCode": "string" + }, + "fees": { "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" - } - ] - }, - "rateOverride": true, - "taxes": { - "amount": 0, - "currencyCode": "string", - "tax": [ - { - "amount": 0, + "type": "Inclusive", "code": "string", - "currencyCode": "string", - "description": "string", - "type": "Inclusive" + "amount": 0, + "currencyCode": "string" } - ] - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true }, - "end": "2020-08-26", "requiredPoints": { "awardsType": "string", "points": 0 }, - "shareDistributionInstruction": "Full", - "shareRatePercentage": 0, - "start": "2020-08-26", - "total": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ + "effectiveRate": { + "taxes": { + "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - }, - "rateOverride": true, - "taxes": { + ], "amount": 0, - "currencyCode": "string", - "tax": [ + "currencyCode": "string" + }, + "fees": { + "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true + }, + "start": "2020-08-26", + "end": "2020-08-26" } ], "rateRange": [ { "base": [ { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ + "taxes": { + "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - }, - "rateOverride": true, - "taxes": { + ], "amount": 0, - "currencyCode": "string", - "tax": [ + "currencyCode": "string" + }, + "fees": { + "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true } ], "rateChange": true } ] }, - "reservationBlock": { - "blockIdList": [ - { - "id": "string", - "type": "string" - } - ], - "blockName": "string", - "hotelId": "string" - }, - "roomId": "string", - "roomRateInfo": "string", - "roomType": "string", - "roomTypeCharged": "string", - "sourceCode": "string", - "sourceCodeDescription": "string", - "start": "2020-08-26", + "packages": [ + { + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "allowance": { + "amount": 0, + "currencyCode": "string" + }, + "description": [ + "string" + ], + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "packageCode": "string", + "calculationRule": "string", + "postingRhythm": "string", + "quantity": 0, + "includedInRate": true, + "addRateSeprateLine": true, + "addRateCombinedLine": true, + "startTime": "string", + "endTime": "string", + "sellSeparate": true + } + ], "stayProfiles": [ { + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ], "profile": { - "addresses": { - "addressInfo": [ + "customer": { + "personName": [ { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:05:08.988Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.988Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "surname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameTitleSuffix": 0, + "envelopeGreeting": "string", + "salutation": "string", + "nameType": "Primary", + "language": "string", + "externalSystem": "string" } ], - "count": 0, - "hasMore": true, - "totalResults": 0 - }, - "businessSegments": [ - "string" - ], - "cashiering": { - "arNoCentral": "string", - "autoFolioSettlementType": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "directBillingList": [ - { - "aRNumber": "string", - "hotelId": "string" - } - ], - "paymentDueDays": 0, - "referenceCurrency": "string", - "taxPercent1": 0, - "taxPercent2": 0, - "taxPercent3": 0, - "taxPercent4": 0, - "taxPercent5": 0, - "vATOffsetYN": "string" - }, - "comments": { - "commentInfo": [ - { - "comment": { - "actionDate": "2020-08-26", - "actionType": "string", - "commentTitle": "string", - "confidential": true, - "createDateTime": "2020-08-26T15:05:08.989Z", - "creatorId": "string", - "hotelId": "string", - "image": "string", - "internal": true, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "notificationLocation": "string", - "overrideInternal": true, - "protectDescription": true, - "purgeDate": "2020-08-26", - "text": { - "language": "string", - "value": "string" - }, - "type": "string", - "typeDescription": "string", - "url": "string" - }, - "createDateTime": "2020-08-26T15:05:08.989Z", - "creatorId": "string", - "id": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "purgeDate": "2020-08-26", - "type": "string" - } - ], - "count": 0, - "hasMore": true, - "totalResults": 0 - }, - "commissionInfoList": [ - { - "bankAccount": "string", - "commissionCode": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "hotelId": "string", - "paymentMethod": "Cent" - } - ], - "company": { - "alternateLanguage": "string", - "alternateName": "string", - "blacklist": true, - "businessLocale": "string", - "businessTitle": "string", - "commissionCode": "string", - "companyName": "string", - "companyName2": "string", - "companyName3": "string", - "corporateIdType": "string", - "creditRating": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "iATAInfo": { - "iATACompany": "string", - "iATAConsortia": "string", - "iATAValidationResult": true - }, - "language": "string", - "nationality": "string", - "nationalityDescription": "string", - "vipDescription": "string", - "vipStatus": "string" - }, - "createDateTime": "2020-08-26T15:05:08.993Z", - "creatorId": "string", - "customer": { - "alienInfo": { - "alienRegistrationNo": "string", - "immigrationStatus": "string", - "visaValidityType": "string" - }, "anonymization": { - "anonymizationDate": "2020-08-26T15:05:08.987Z", - "anonymizationStatus": "Requested" - }, - "birthCountry": { - "code": "string", - "value": "string" + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-08-26T15:05:08.987Z" }, - "birthDate": "2020-08-26", - "birthDateMasked": "string", - "birthPlace": "string", - "blacklist": true, - "businessTitle": "string", "citizenCountry": { - "code": "string", - "value": "string" - }, - "companyInfo": { - "department": "string", - "legalCompany": "string", - "position": "string" + "value": "string", + "code": "string" }, - "creditRating": "string", - "currencyCode": "string", - "currencySymbol": "string", - "customerValue": "string", - "decimalPlaces": 0, - "gender": "Male", "identifications": { - "count": 0, - "hasMore": true, "identificationInfo": [ { - "id": "string", "identification": { - "expirationDate": "2020-08-26", + "idType": "string", "idNumber": "string", "idNumberMasked": "string", - "idType": "string", "issuedCountry": "string", "issuedDate": "2020-08-26", "issuedPlace": "string", - "orderSequence": 0, + "expirationDate": "2020-08-26", + "registeredProperty": "string", "primaryInd": true, - "registeredProperty": "string" + "orderSequence": 0 }, + "id": "string", "type": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "profession": "string", + "alienInfo": { + "alienRegistrationNo": "string", + "immigrationStatus": "string", + "visaValidityType": "string" + }, + "birthCountry": { + "value": "string", + "code": "string" }, - "language": "string", "legalCompany": "string", + "companyInfo": { + "legalCompany": "string", + "department": "string", + "position": "string" + }, + "businessTitle": "string", + "gender": "Male", + "birthDate": "2020-08-26", + "birthDateMasked": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "language": "string", "nationality": "string", "nationalityDescription": "string", - "personName": [ - { - "envelopeGreeting": "string", - "externalSystem": "string", - "givenName": "string", - "language": "string", - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameTitleSuffix": 0, - "nameType": "Primary", - "salutation": "string", - "surname": "string" - } - ], + "customerValue": "string", + "creditRating": "string", + "vipStatus": "string", + "vipDescription": "string", + "birthPlace": "string", "privateProfile": true, - "profession": "string", + "blacklist": true + }, + "company": { + "companyName": "string", + "companyName2": "string", + "companyName3": "string", + "alternateName": "string", + "alternateLanguage": "string", + "businessLocale": "string", + "iATAInfo": { + "iATACompany": "string", + "iATAConsortia": "string", + "iATAValidationResult": true + }, + "businessTitle": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "language": "string", + "nationality": "string", + "nationalityDescription": "string", + "commissionCode": "string", + "creditRating": "string", + "corporateIdType": "string", + "vipStatus": "string", "vipDescription": "string", - "vipStatus": "string" + "blacklist": true }, - "eCertificates": [ - { - "awardId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - }, - "awardPoints": 0, - "cancelRequestDate": "2020-08-26", - "certificateId": 0, - "certificateNo": "string", - "consumptionDetail": { - "authorizationCode": "string", - "date": "2020-08-26", - "email": "string", - "firstName": "string", - "hotelId": "string", - "locationType": "string", - "middleName": "string", - "referenceId": { - "id": "string", - "type": "string" - }, - "serviceDate": "2020-08-26", - "source": "Central", - "surname": "string", - "userName": "string", - "userNotes": "string" - }, - "databaseId": "string", - "eCertificateInfo": { - "awardCode": "string", - "benefitSummary": "string", - "certificateType": "string", - "cost": { - "amount": 0, - "currencyCode": "string" - }, - "description": "string", - "hotels": { - "code": [ + "profileImage": { + "language": "string", + "imageSet": "string", + "sequenceId": 0, + "imageStyle": "Full", + "imageType": "string", + "hotelId": "string", + "chainCode": "string", + "imageURL": "string", + "description": "string", + "imageOrder": 0, + "website": "string" + }, + "addresses": { + "addressInfo": [ + { + "address": { + "addressLine": [ "string" ], - "scope": "Global" - }, - "label": "string", - "longDescription": "string", - "maxExtensionAllowed": 0, - "membershipType": "string", - "promotionCode": "string", - "usageCriteria": { - "benefit": true, - "cancelAllowed": true, - "generateInLieuCertificate": true, - "hotel": true, - "reservation": true, - "verifyCertificateNo": true, - "web": true, - "webAllowed": true - }, - "value": { - "amount": 0, - "currencyCode": "string" - }, - "voucherBenefitCode": "string" - }, - "expiryDate": "2020-08-26", - "extensionCount": 0, - "generationDetail": { - "generationDetail": "string", - "referenceValue": "string", - "ruleId": { - "id": "string", - "type": "string" - } - }, - "inLieuSequence": 0, - "inactiveDate": "2020-08-26", - "issueDate": "2020-08-26", - "issueType": "Assigned", - "newExpiryDate": "2020-08-26", - "originalCertificateNo": "string", - "originalVoucherNo": "string", - "printed": true, - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - }, - "source": "Opera", - "status": "Cancelled", - "voucherNo": "string" - } - ], - "eligibleForFiscalFolio": "string", - "emails": { - "count": 0, - "emailInfo": [ - { - "email": { + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", "createDateTime": "2020-08-26T15:05:08.988Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:05:08.988Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, "id": "string", "type": "string" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "gdsNegotiatedRates": { - "count": 0, - "gdsNegotiatedRate": [ + "businessSegments": [ + "string" + ], + "territory": "string", + "traceCode": "string", + "ownerCode": "string", + "influenceCode": "string", + "telephones": { + "telephoneInfo": [ { - "bookingChannelCode": "string", - "channelRatePlanCode": "string", - "gdsNegotiatedInfoList": [ - { - "accessCode": "string", - "end": "2020-08-26", - "inactive": true, - "order": 0, - "start": "2020-08-26" - } - ], - "hotelId": "string" + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.988Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.988Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "hasCommission": true, - "influenceCode": "string", - "inheritedNegRates": true, - "keywords": { - "count": 0, - "hasMore": true, - "keyword": [ + "emails": { + "emailInfo": [ { - "keyword": "string", - "keywordDetail": { - "newKeyword": "string" + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.988Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.988Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, + "id": "string", "type": "string" } ], - "totalResults": 0 - }, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.993Z", - "lastStayInfo": { - "lastRate": { - "amount": 0, - "currencyCode": "string" - }, - "lastRoom": "string", - "lastVisit": "2020-08-26", - "totalStay": 0 - }, - "localizationGuestType": "string", - "mailingActions": { - "active": true, - "count": 0, "hasMore": true, - "mailingAction": [ - { - "code": "string", - "description": "string" - } - ], - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "markAsRecentlyAccessed": true, - "markForHistory": true, - "negotiatedRates": { - "count": 0, - "hasMore": true, - "negotiatedRate": [ + "uRLs": { + "uRLInfo": [ { - "hotelId": "string", - "negotiatedInfoList": [ - { - "comissionCode": "string", - "corporateAgreementId": "string", - "end": "2020-08-26", - "inactive": true, - "order": 0, - "start": "2020-08-26" - } - ], - "rateCode": "string" + "url": { + "value": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 + }, + "id": "string", + "type": "string" } ], - "totalResults": 0 - }, - "ownerCode": "string", - "preferenceCollection": { - "count": 0, "hasMore": true, - "preferenceType": [ + "totalResults": 0, + "count": 0 + }, + "comments": { + "commentInfo": [ { - "availableQuantity": 0, + "comment": { + "text": { + "value": "string", + "language": "string" + }, + "image": "string", + "url": "string", + "commentTitle": "string", + "notificationLocation": "string", + "type": "string", + "typeDescription": "string", + "internal": true, + "confidential": true, + "overrideInternal": true, + "protectDescription": true, + "hotelId": "string", + "actionType": "string", + "actionDate": "2020-08-26", + "createDateTime": "2020-08-26T15:05:08.989Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.989Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, "createDateTime": "2020-08-26T15:05:08.989Z", "creatorId": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "maxQuantity": 0, - "maxResortUsedQuantity": 0, - "preference": [ - { - "description": "string", - "excludedPreferencesCount": 0, - "global": true, - "hotels": [ - "string" - ], - "preferenceId": "string", - "preferenceValue": "string", - "source": "string" - } - ], - "preferenceType": "string", - "preferenceTypeDescription": "string", + "lastModifierId": "string", "purgeDate": "2020-08-26", - "reservationPreference": true, - "sequence": "string" + "id": "string", + "type": "string" } ], - "totalResults": 0 - }, - "privacyInfo": { - "allowEmail": true, - "allowPhone": true, - "allowSMS": true, - "autoEnrollLoyaltyProgram": true, - "infoFromThirdParty": true, - "lastPrivacyPromptDate": "2020-08-26", - "marketResearchParticipation": true, - "optInAutoEnrollmentMember": true, - "optInEmail": true, - "optInMailingList": true, - "optInMarketResearch": true, - "optInPhone": true, - "optInSms": true, - "optInThirdParty": true - }, - "profileAccessType": { - "chainCode": "string", - "croCode": "string", - "hotelId": "string", - "sharedLevel": "Global" + "hasMore": true, + "totalResults": 0, + "count": 0 }, "profileDeliveryMethods": { - "count": 0, - "hasMore": true, "profileDeliveryMethod": [ { "deliveryId": { "id": "string", "type": "string" }, - "deliveryModule": "EfolioExport", "deliveryType": "string", "deliveryValue": "string", "hotelId": "string", - "orderSequence": 0, - "primaryInd": true + "deliveryModule": "EfolioExport", + "primaryInd": true, + "orderSequence": 0 } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 }, - "profileImage": { - "chainCode": "string", - "description": "string", - "hotelId": "string", - "imageOrder": 0, - "imageSet": "string", - "imageStyle": "Full", - "imageType": "string", - "imageURL": "string", - "language": "string", - "sequenceId": 0, - "website": "string" - }, - "profileIndicators": [ - { - "count": 0, - "indicatorName": "string" - } - ], "profileMemberships": { - "count": 0, - "hasMore": true, "profileMembership": [ { - "benefits": [ - { - "code": "string", - "inactive": true, - "message": "string" - } - ], - "centralSetup": true, "comment": { - "image": "string", "text": { - "language": "string", - "value": "string" + "value": "string", + "language": "string" }, + "image": "string", "url": "string" }, - "createDateTime": "2020-08-26T15:05:08.989Z", - "creatorId": "string", - "currentPoints": 0, - "downgrade": "Grace", - "downgradeDescription": "string", + "newMembershipNumber": "string", + "nameOnCard": "string", + "programDescription": "string", + "membershipLevel": "string", + "membershipLevelDescription": "string", + "membershipClass": "string", "earningPreference": "Points", - "effectiveDate": "2020-08-26", - "enrollmentResort": "string", - "enrollmentSource": "string", - "excludeFromBatch": true, - "expireDate": "2020-08-26", - "expireDateExclusiveIndicator": true, "inactive": true, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "memberStatus": "string", - "membershipClass": "string", + "benefits": [ + { + "code": "string", + "message": "string", + "inactive": true + } + ], + "tierAdministration": "Disabled", + "downgrade": "Grace", + "reIssueNewCard": "Pending", + "excludeFromBatch": true, + "upgradeDescription": "string", + "downgradeDescription": "string", + "rating": "string", "membershipEnrollmentCode": "string", - "membershipId": "string", - "membershipIdNo": 0, - "membershipLevel": "string", - "membershipLevelDescription": "string", - "membershipType": "string", - "nameOnCard": "string", - "newMembershipNumber": "string", - "orderSequence": 0, - "playerRanking": 0, + "memberStatus": "string", + "currentPoints": 0, "pointsLabel": "string", + "enrollmentSource": "string", + "enrollmentResort": "string", "preferredCard": true, - "primaryMembership": true, + "membershipId": "string", + "membershipType": "string", "primaryMembershipYn": "string", - "programDescription": "string", - "purgeDate": "2020-08-26", - "rating": "string", - "reIssueNewCard": "Pending", + "primaryMembership": true, + "membershipIdNo": 0, + "playerRanking": 0, + "centralSetup": true, "signupDate": "2020-08-26", - "tierAdministration": "Disabled", - "upgradeDescription": "string" + "effectiveDate": "2020-08-26", + "expireDate": "2020-08-26", + "expireDateExclusiveIndicator": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.989Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.989Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 }, - "profileRestrictions": { - "reason": "string", - "reasonDescription": "string", - "restricted": true + "preferenceCollection": { + "preferenceType": [ + { + "preference": [ + { + "preferenceValue": "string", + "description": "string", + "global": true, + "source": "string", + "hotels": [ + "string" + ], + "preferenceId": "string", + "excludedPreferencesCount": 0 + } + ], + "preferenceType": "string", + "preferenceTypeDescription": "string", + "sequence": "string", + "maxQuantity": 0, + "availableQuantity": 0, + "maxResortUsedQuantity": 0, + "reservationPreference": true, + "createDateTime": "2020-08-26T15:05:08.989Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.989Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 }, - "profileType": "Guest", - "protectedBy": "string", - "purgeDate": "2020-08-26", - "registeredProperty": "string", - "relationships": { - "count": 0, + "keywords": { + "keyword": [ + { + "keywordDetail": { + "newKeyword": "string" + }, + "type": "string", + "keyword": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "negotiatedRates": { + "negotiatedRate": [ + { + "negotiatedInfoList": [ + { + "corporateAgreementId": "string", + "comissionCode": "string", + "order": 0, + "inactive": true, + "start": "2020-08-26", + "end": "2020-08-26" + } + ], + "hotelId": "string", + "rateCode": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "gdsNegotiatedRates": { + "gdsNegotiatedRate": [ + { + "gdsNegotiatedInfoList": [ + { + "accessCode": "string", + "order": 0, + "inactive": true, + "start": "2020-08-26", + "end": "2020-08-26" + } + ], + "bookingChannelCode": "string", + "hotelId": "string", + "channelRatePlanCode": "string" + } + ], "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "profileIndicators": [ + { + "indicatorName": "string", + "count": 0 + } + ], + "relationships": { "relationship": [ { "changeRelationship": { @@ -20485,256 +17952,267 @@ "targetRelation": "string", "targetRelationDescription": "string" }, - "id": "string", - "masterAccountInfo": { - "masterAccountId": { - "id": "string", - "type": "string" - }, - "masterAccountName": "string" - }, - "relation": "string", - "relationDescription": "string", "relationshipProfile": { - "address": { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:05:08.989Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" - }, - "changeProfileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "company": { - "alternateLanguage": "string", - "alternateName": "string", - "blacklist": true, - "businessLocale": "string", - "businessTitle": "string", - "commissionCode": "string", - "companyName": "string", - "companyName2": "string", - "companyName3": "string", - "corporateIdType": "string", - "creditRating": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "iATAInfo": { - "iATACompany": "string", - "iATAConsortia": "string", - "iATAValidationResult": true - }, - "language": "string", - "nationality": "string", - "nationalityDescription": "string", - "vipDescription": "string", - "vipStatus": "string" - }, "customer": { - "alienInfo": { - "alienRegistrationNo": "string", - "immigrationStatus": "string", - "visaValidityType": "string" - }, + "personName": [ + { + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "surname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameTitleSuffix": 0, + "envelopeGreeting": "string", + "salutation": "string", + "nameType": "Primary", + "language": "string", + "externalSystem": "string" + } + ], "anonymization": { - "anonymizationDate": "2020-08-26T15:05:08.989Z", - "anonymizationStatus": "Requested" - }, - "birthCountry": { - "code": "string", - "value": "string" + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-08-26T15:05:08.989Z" }, - "birthDate": "2020-08-26", - "birthDateMasked": "string", - "birthPlace": "string", - "blacklist": true, - "businessTitle": "string", "citizenCountry": { - "code": "string", - "value": "string" - }, - "companyInfo": { - "department": "string", - "legalCompany": "string", - "position": "string" + "value": "string", + "code": "string" }, - "creditRating": "string", - "currencyCode": "string", - "currencySymbol": "string", - "customerValue": "string", - "decimalPlaces": 0, - "gender": "Male", "identifications": { - "count": 0, - "hasMore": true, "identificationInfo": [ { - "id": "string", "identification": { - "expirationDate": "2020-08-26", + "idType": "string", "idNumber": "string", "idNumberMasked": "string", - "idType": "string", "issuedCountry": "string", "issuedDate": "2020-08-26", "issuedPlace": "string", - "orderSequence": 0, + "expirationDate": "2020-08-26", + "registeredProperty": "string", "primaryInd": true, - "registeredProperty": "string" + "orderSequence": 0 }, + "id": "string", "type": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "profession": "string", + "alienInfo": { + "alienRegistrationNo": "string", + "immigrationStatus": "string", + "visaValidityType": "string" + }, + "birthCountry": { + "value": "string", + "code": "string" }, - "language": "string", "legalCompany": "string", + "companyInfo": { + "legalCompany": "string", + "department": "string", + "position": "string" + }, + "businessTitle": "string", + "gender": "Male", + "birthDate": "2020-08-26", + "birthDateMasked": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "language": "string", "nationality": "string", "nationalityDescription": "string", - "personName": [ - { - "envelopeGreeting": "string", - "externalSystem": "string", - "givenName": "string", - "language": "string", - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameTitleSuffix": 0, - "nameType": "Primary", - "salutation": "string", - "surname": "string" - } - ], + "customerValue": "string", + "creditRating": "string", + "vipStatus": "string", + "vipDescription": "string", + "birthPlace": "string", "privateProfile": true, - "profession": "string", + "blacklist": true + }, + "company": { + "companyName": "string", + "companyName2": "string", + "companyName3": "string", + "alternateName": "string", + "alternateLanguage": "string", + "businessLocale": "string", + "iATAInfo": { + "iATACompany": "string", + "iATAConsortia": "string", + "iATAValidationResult": true + }, + "businessTitle": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "language": "string", + "nationality": "string", + "nationalityDescription": "string", + "commissionCode": "string", + "creditRating": "string", + "corporateIdType": "string", + "vipStatus": "string", "vipDescription": "string", - "vipStatus": "string" + "blacklist": true }, - "email": { - "email": { + "telephone": { + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, "createDateTime": "2020-08-26T15:05:08.989Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", + "lastModifyDateTime": "2020-08-26T15:05:08.989Z", "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "address": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:05:08.989Z", + "creatorId": "string", "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "orderSequence": 0, + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "email": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", "primaryInd": true, - "purgeDate": "2020-08-26", + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.989Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.989Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "uRLs": { + "url": { + "value": "string", "type": "string", - "typeDescription": "string" + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 }, "id": "string", "type": "string" }, - "id": "string", - "primary": "string", "primaryOwner": { - "department": { + "hotel": { "code": "string", "description": "string" }, - "email": { - "email": { - "createDateTime": "2020-08-26T15:05:08.989Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" - }, + "userId": { "id": "string", "type": "string" }, - "hotel": { - "code": "string", - "description": "string" + "userName": "string", + "ownerCode": "string", + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 }, "name": { - "envelopeGreeting": "string", - "externalSystem": "string", + "namePrefix": "string", "givenName": "string", - "language": "string", "middleName": "string", - "namePrefix": "string", + "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, - "nameType": "Primary", + "envelopeGreeting": "string", "salutation": "string", - "surname": "string" + "nameType": "Primary", + "language": "string", + "externalSystem": "string" }, - "ownerCode": "string", - "phone": { - "id": "string", - "telephone": { + "department": { + "code": "string", + "description": "string" + }, + "email": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, "createDateTime": "2020-08-26T15:05:08.989Z", "creatorId": "string", - "extension": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "orderSequence": 0, - "phoneNumber": "string", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "phone": { + "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.989Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.989Z", + "lastModifierId": "string", "purgeDate": "2020-08-26" }, - "type": "string" - }, - "primary": true, - "profileId": { "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" + "type": "string" }, "relationship": { "code": "string", "description": "string" }, - "userId": { - "id": "string", - "type": "string" - }, - "userName": "string" + "primary": true }, "profileIdList": [ { @@ -20742,61 +18220,219 @@ "type": "string" } ], - "profileType": "Guest", + "changeProfileIdList": [ + { + "id": "string", + "type": "string" + } + ], + "primary": "string", + "id": "string", "statusCode": "Active", - "telephone": { + "profileType": "Guest" + }, + "masterAccountInfo": { + "masterAccountId": { "id": "string", - "telephone": { - "createDateTime": "2020-08-26T15:05:08.989Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.989Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, "type": "string" }, - "uRLs": { - "id": "string", - "type": "string", - "url": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - } - } + "masterAccountName": "string" }, + "id": "string", + "relation": "string", + "relationDescription": "string", "targetRelation": "string", "targetRelationDescription": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 }, - "requestForHotel": "string", "reservationInfoList": { - "futureList": { - "count": 0, - "hasMore": true, + "historyList": { "reservationInfo": [ { - "accessRestriction": "Change", - "advanceCheckIn": { - "advanceCheckedIn": true, - "eTRComments": "string", - "expectedReturnTime": "2020-08-26T15:05:08.993Z" + "reservationIdList": [ + { + "id": "string", + "type": "string" + } + ], + "roomStay": { + "arrivalDate": "2020-08-26", + "departureDate": "2020-08-26", + "originalTimeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-08-26T15:05:08.989Z", + "reservationExpectedDepartureTime": "2020-08-26T15:05:08.989Z" + }, + "adultCount": 0, + "childCount": 0, + "roomClass": "string", + "roomType": "string", + "numberOfRooms": 0, + "roomNumber": "string", + "ratePlanCode": "string", + "rateAmount": { + "amount": 0, + "currencyCode": "string" + }, + "points": { + "awardsType": "string", + "points": 0 + }, + "rateSuppressed": true, + "reservationBlock": { + "blockIdList": [ + { + "id": "string", + "type": "string" + } + ], + "blockName": "string", + "hotelId": "string" + }, + "bookingChannelCode": "string", + "partyCode": "string", + "fixedRate": true, + "totalAmount": { + "amount": 0, + "currencyCode": "string" + }, + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { + "promotionCode": "string", + "promotionName": "string", + "couponCode": "string" + }, + "marketCode": "string", + "sourceOfBusiness": "string", + "sourceOfBusinessDescription": "string", + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "compBalance": { + "amount": 0, + "currencyCode": "string" + }, + "roomTypeCharged": "string", + "depositPayments": { + "amount": 0, + "currencyCode": "string" + }, + "guestServiceStatus": "DoNotDisturb", + "scheduledCheckoutTime": "2020-08-26", + "roomNumberLocked": true, + "pseudoRoom": true }, - "allowMobileCheckout": true, - "allowMobileViewFolio": true, - "allowedActions": [ - "Cancel" + "reservationGuest": { + "membership": { + "membershipId": 0, + "programCode": "string", + "bonusCode": "string", + "membershipTypeDesc": "string", + "membershipLevelDesc": "string", + "accountId": "string", + "membershipLevel": "string", + "playerRanking": 0 + }, + "namePrefix": "string", + "givenName": "string", + "alternateGivenName": "string", + "middleName": "string", + "surnamePrefix": "string", + "surname": "string", + "alternateSurname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "fullName": "string", + "alternateFullName": "string", + "phoneNumber": "string", + "email": "string", + "birthDate": "2020-08-26", + "language": "string", + "nationality": { + "value": "string", + "code": "string" + }, + "vip": { + "vipCode": "string", + "vipDescription": "string" + }, + "address": { + "cityName": "string", + "postalCode": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "streetAddress": "string", + "excludeNoCity": true + }, + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-08-26T15:05:08.989Z" + }, + "accompanyGuests": [ + { + "firstName": "string", + "lastName": "string", + "fullName": "string", + "registrationCardNo": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ] + } + ], + "externalInfo": { + "givenName": "string", + "surname": "string" + }, + "guestLastStayInfo": { + "lastStayDate": "2020-08-26", + "lastStayRoom": "string", + "lastStayRate": { + "amount": 0, + "currencyCode": "string" + }, + "totalStay": 0 + }, + "guestRestrictedCode": "string", + "guestRestrictedReasonDesc": "string", + "guestRestricted": true, + "registrationCardNo": "string", + "nameType": "Guest", + "id": "string", + "type": "string" + }, + "sharedGuests": [ + { + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "firstName": "string", + "lastName": "string", + "fullName": "string" + } ], "attachedProfiles": [ { @@ -20810,1505 +18446,1495 @@ "reservationProfileType": "Company" } ], - "cancellationInfo": { - "code": "string", - "date": "2020-08-26", - "description": "string" - }, - "cashiering": { - "bedTaxReporting": { - "taxRegistrationNo": 0, - "taxableDays": 0, - "visaExpiryDate": "2020-08-26", - "visaIssueDate": "2020-08-26", - "visaNumber": "string" + "reservationPaymentMethod": { + "paymentCard": { + "cardId": { + "id": "string", + "type": "string" + }, + "currentAuthorizedAmount": { + "amount": 0, + "currencyCode": "string" + }, + "approvalAmountNeeded": { + "amount": 0, + "currencyCode": "string" + }, + "cardType": "Ab", + "userDefinedCardType": "string", + "cardNumber": "string", + "cardNumberMasked": "string", + "cardNumberLast4Digits": "string", + "expirationDate": "2020-08-26", + "expirationDateMasked": "string", + "expirationDateExpired": true, + "cardHolderName": "string", + "attachCreditCardToProfile": true, + "processing": "Eft", + "swiped": true, + "cardOrToken": "CardNumber" }, - "billingPrivileges": { - "allowAutoCheckin": true, - "autoSettlement": true, - "autoSettlementFreq": 0, - "autoSettlementType": "string", - "creditLimitAutoPay": true, - "directBillAuthorized": true, - "folioCloseDate": "2020-08-26", - "postStayCharging": true, - "postingRestriction": true, - "preStayCharging": true, - "scheduledCheckout": true, - "scheduledCheckoutTime": "2020-08-26", - "videoCheckout": true + "balance": { + "amount": 0, + "currencyCode": "string" }, - "compAccounting": { - "authorizer": "string", - "compPostings": "string", - "compType": "string" + "authorizationRule": { + "code": 0, + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "percent": 0 }, - "financiallyResponsible": true, - "folioTexts": [ - { - "row": 0, - "text": "string" - } - ], - "lastRoomAndTaxPostedDate": "2020-08-26", - "periodicFolio": { - "frequency": 0, - "lastFolioDate": "2020-08-26", - "lastSettlementDate": "2020-08-26" + "emailFolioInfo": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.990Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.990Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "emailFolio": true, + "id": "string", + "type": "string" }, - "proratedBilling": true, - "reservationPreConfiguredRoutingInstruction": { - "authorizerInfo": { - "authorizerId": { + "paymentMethod": "string", + "description": "string", + "folioView": 0 + }, + "reservationFolioWindows": [ + { + "payeeInfo": { + "payeeId": { "id": "string", "type": "string" }, - "authorizerName": "string", - "authorizerRateCode": "string", - "authorizerUserName": "string", - "inheritAuthorizerRateCode": true + "payeeName": "string", + "payeeAddress": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:05:08.990Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.990Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "payeeAddressCount": 0, + "payeeReferenceCurrency": "string", + "payeeAccountInfo": { + "accountName": "string", + "accountId": { + "id": "string", + "type": "string" + }, + "accountNo": "string", + "status": { + "restriction": "string", + "description": "string", + "restricted": true + } + }, + "payeeTaxNumber": "string" }, - "profileType": "Company", - "promotionCode": "string", - "ratePlanCode": "string" - }, - "revenuesAndBalances": { "balance": { "amount": 0, "currencyCode": "string" }, - "foodAndBevRevenue": { + "paymentMethod": "string", + "folioWindowNo": 0 + } + ], + "specials": "string", + "lastPrivacyPromptDate": "2020-08-26", + "displayColor": "string", + "reservationIndicators": [ + { + "indicatorName": "string", + "count": 0 + } + ], + "roomStatus": "Clean", + "searchMatches": [ + { + "attribute": "string", + "value": "string" + } + ], + "sourceOfSale": { + "sourceType": "string", + "sourceCode": "string" + }, + "waitlist": { + "reasonDescription": "string", + "priorityDescription": "string", + "description": "string", + "reasonCode": "string", + "priorityCode": "string", + "telephone": "string" + }, + "queue": { + "timeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string", + "durationInSeconds": 0 + }, + "guestTextInfo": { + "sentTime": "2020-08-26T15:05:08.990Z", + "sentBy": "string" + }, + "priority": 0, + "averageQueueTimeToCheckIn": 0, + "averageQueueTimeCurrentReservations": 0, + "queueDate": "2020-08-26" + }, + "housekeeping": { + "instructions": "string", + "facilityTaskInfo": { + "task": { + "description": "string", + "instructions": "string", + "facilityDepartureTask": true, + "linenChange": true, + "hotelId": "string", + "code": "string", + "sequence": 0 + }, + "supplies": [ + { + "description": "string", + "quantity": 0, + "code": "string" + } + ], + "date": "2020-08-26" + }, + "linenChange": true, + "turndownRequested": true, + "serviceTime": "2020-08-26", + "expectedServiceTime": "string", + "roomStatus": "Clean" + }, + "cashiering": { + "revenuesAndBalances": { + "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, - "nonRevenue": { + "totalPayment": { "amount": 0, "currencyCode": "string" }, - "otherRevenue": { + "roomRevenue": { "amount": 0, "currencyCode": "string" }, - "roomRevenue": { + "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, - "totalFixedCharge": { + "otherRevenue": { "amount": 0, "currencyCode": "string" }, - "totalPayment": { + "nonRevenue": { "amount": 0, "currencyCode": "string" }, "totalRevenue": { "amount": 0, "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" } }, - "reverseAdvanceCheckInAllowed": true, - "reverseCheckInAllowed": true, + "billingPrivileges": { + "postingRestriction": true, + "preStayCharging": true, + "postStayCharging": true, + "folioCloseDate": "2020-08-26", + "scheduledCheckout": true, + "scheduledCheckoutTime": "2020-08-26", + "directBillAuthorized": true, + "videoCheckout": true, + "allowAutoCheckin": true, + "autoSettlement": true, + "autoSettlementType": "string", + "autoSettlementFreq": 0, + "creditLimitAutoPay": true + }, "taxType": { + "hotelId": "string", "code": "string", - "collectingAgentTax": true, "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, + "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, + "minimumLengthOfStay": 0, "taxExemptNo": "string" }, + "bedTaxReporting": { + "taxRegistrationNo": 0, + "visaNumber": "string", + "visaIssueDate": "2020-08-26", + "visaExpiryDate": "2020-08-26", + "taxableDays": 0 + }, + "folioTexts": [ + { + "text": "string", + "row": 0 + } + ], + "periodicFolio": { + "lastSettlementDate": "2020-08-26", + "lastFolioDate": "2020-08-26", + "frequency": 0 + }, + "compAccounting": { + "compType": "string", + "authorizer": "string", + "compPostings": "string" + }, + "reservationPreConfiguredRoutingInstruction": { + "authorizerInfo": { + "authorizerId": { + "id": "string", + "type": "string" + }, + "authorizerUserName": "string", + "authorizerName": "string", + "authorizerRateCode": "string", + "inheritAuthorizerRateCode": true + }, + "ratePlanCode": "string", + "profileType": "Company", + "promotionCode": "string" + }, + "financiallyResponsible": true, + "proratedBilling": true, + "lastRoomAndTaxPostedDate": "2020-08-26", + "reverseCheckInAllowed": true, + "reverseAdvanceCheckInAllowed": true, "transactionsPosted": true }, - "commissionPayoutTo": "TravelAgent", - "computedReservationStatus": "Reserved", - "createDateTime": "2020-08-26T15:05:08.993Z", - "creatorId": "string", + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0 + }, "deposit": { - "amountOwed": 0, - "amountPaid": 0, "amountRequired": 0, + "amountPaid": 0, + "amountOwed": 0, "dueDate": "2020-08-26", - "hasOutstanding": true, + "postingDate": "2020-08-26", "hasPaid": true, - "postingDate": "2020-08-26" + "hasOutstanding": true }, - "displayColor": "string", - "expectedServiceTime": "string", - "guestPreferredCurrency": "string", - "hotelId": "string", - "hotelInterfaceStatusList": [ - { - "hotelInterface": { - "activeFlag": true, - "hotelId": "string", - "interfaceId": { - "id": "string", - "type": "string" - }, - "interfaceName": "string", - "interfaceType": "Bms", - "logo": "string", - "machineName": "string", - "status": "Stopped" - }, - "interfaceRights": [ - { - "category": "string", - "description": "string", - "right": 0, - "statusCode": "string" - } - ], - "roomExtension": "string" - } + "allowedActions": [ + "Cancel" ], - "hotelName": "string", - "housekeeping": { - "expectedServiceTime": "string", - "facilityTaskInfo": { - "date": "2020-08-26", - "supplies": [ + "revenuesAndBalances": { + "totalFixedCharge": { + "amount": 0, + "currencyCode": "string" + }, + "totalPayment": { + "amount": 0, + "currencyCode": "string" + }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } + }, + "hotelInterfaceStatusList": [ + { + "roomExtension": "string", + "hotelInterface": { + "interfaceId": { + "id": "string", + "type": "string" + }, + "hotelId": "string", + "interfaceName": "string", + "interfaceType": "Bms", + "logo": "string", + "machineName": "string", + "status": "Stopped", + "activeFlag": true + }, + "interfaceRights": [ { - "code": "string", + "right": 0, + "statusCode": "string", "description": "string", - "quantity": 0 + "category": "string" } - ], - "task": { - "code": "string", - "description": "string", - "facilityDepartureTask": true, - "hotelId": "string", - "instructions": "string", - "linenChange": true, - "sequence": 0 - } - }, - "instructions": "string", - "linenChange": true, - "roomStatus": "Clean", - "serviceTime": "2020-08-26", - "turndownRequested": true + ] + } + ], + "guestPreferredCurrency": "string", + "turndownInfo": { + "allowed": true, + "status": "Required" }, - "keyCount": 0, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.993Z", - "lastPrivacyPromptDate": "2020-08-26", "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", + "roomReady": "Pending", "keyReady": "Pending", + "checkoutMessageReceived": true, "requiresAction": true, - "roomReady": "Pending" - }, - "openFolio": true, - "optedForCommunication": true, - "paymentMethod": "string", - "preRegistered": true, - "purgeDate": "2020-08-26", - "queue": { - "averageQueueTimeCurrentReservations": 0, - "averageQueueTimeToCheckIn": 0, - "guestTextInfo": { - "sentBy": "string", - "sentTime": "2020-08-26T15:05:08.991Z" - }, - "priority": 0, - "queueDate": "2020-08-26", - "timeSpan": { - "duration": "string", - "durationInSeconds": 0, - "endDate": "2020-08-26", - "startDate": "2020-08-26" - } + "errorMessage": "string" }, "reservationCommunication": { - "emails": { - "count": 0, - "emailInfo": [ + "telephones": { + "telephoneInfo": [ { - "email": { - "createDateTime": "2020-08-26T15:05:08.993Z", + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.991Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", + "lastModifyDateTime": "2020-08-26T15:05:08.991Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.993Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" + "purgeDate": "2020-08-26" }, "id": "string", "type": "string" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ + "emails": { + "emailInfo": [ { - "id": "string", - "telephone": { - "createDateTime": "2020-08-26T15:05:08.993Z", + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.991Z", "creatorId": "string", - "extension": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.991Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.993Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, "purgeDate": "2020-08-26" }, + "id": "string", "type": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 } }, - "reservationFolioWindows": [ + "advanceCheckIn": { + "advanceCheckedIn": true, + "expectedReturnTime": "2020-08-26T15:05:08.991Z", + "eTRComments": "string" + }, + "welcomeOffer": true, + "cancellationInfo": { + "description": "string", + "code": "string", + "date": "2020-08-26" + }, + "keyCount": 0, + "hotelId": "string", + "hotelName": "string", + "expectedServiceTime": "string", + "roomStayReservation": true, + "createDateTime": "2020-08-26T15:05:08.991Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.991Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "reservationStatus": "Reserved", + "computedReservationStatus": "Reserved", + "walkInIndicator": true, + "accessRestriction": "Change", + "commissionPayoutTo": "TravelAgent", + "paymentMethod": "string", + "preRegistered": true, + "openFolio": true, + "allowMobileCheckout": true, + "allowMobileViewFolio": true, + "optedForCommunication": true + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "futureList": { + "reservationInfo": [ + { + "reservationIdList": [ { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "folioWindowNo": 0, - "payeeInfo": { - "payeeAccountInfo": { - "accountId": { - "id": "string", - "type": "string" - }, - "accountName": "string", - "accountNo": "string", - "status": { - "description": "string", - "restricted": true, - "restriction": "string" - } - }, - "payeeAddress": { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:05:08.991Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.991Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" - }, - "payeeAddressCount": 0, - "payeeId": { - "id": "string", - "type": "string" - }, - "payeeName": "string", - "payeeReferenceCurrency": "string", - "payeeTaxNumber": "string" - }, - "paymentMethod": "string" + "id": "string", + "type": "string" } ], + "roomStay": { + "arrivalDate": "2020-08-26", + "departureDate": "2020-08-26", + "originalTimeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-08-26T15:05:08.991Z", + "reservationExpectedDepartureTime": "2020-08-26T15:05:08.991Z" + }, + "adultCount": 0, + "childCount": 0, + "roomClass": "string", + "roomType": "string", + "numberOfRooms": 0, + "roomNumber": "string", + "ratePlanCode": "string", + "rateAmount": { + "amount": 0, + "currencyCode": "string" + }, + "points": { + "awardsType": "string", + "points": 0 + }, + "rateSuppressed": true, + "reservationBlock": { + "blockIdList": [ + { + "id": "string", + "type": "string" + } + ], + "blockName": "string", + "hotelId": "string" + }, + "bookingChannelCode": "string", + "partyCode": "string", + "fixedRate": true, + "totalAmount": { + "amount": 0, + "currencyCode": "string" + }, + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { + "promotionCode": "string", + "promotionName": "string", + "couponCode": "string" + }, + "marketCode": "string", + "sourceOfBusiness": "string", + "sourceOfBusinessDescription": "string", + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "compBalance": { + "amount": 0, + "currencyCode": "string" + }, + "roomTypeCharged": "string", + "depositPayments": { + "amount": 0, + "currencyCode": "string" + }, + "guestServiceStatus": "DoNotDisturb", + "scheduledCheckoutTime": "2020-08-26", + "roomNumberLocked": true, + "pseudoRoom": true + }, "reservationGuest": { + "membership": { + "membershipId": 0, + "programCode": "string", + "bonusCode": "string", + "membershipTypeDesc": "string", + "membershipLevelDesc": "string", + "accountId": "string", + "membershipLevel": "string", + "playerRanking": 0 + }, + "namePrefix": "string", + "givenName": "string", + "alternateGivenName": "string", + "middleName": "string", + "surnamePrefix": "string", + "surname": "string", + "alternateSurname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "fullName": "string", + "alternateFullName": "string", + "phoneNumber": "string", + "email": "string", + "birthDate": "2020-08-26", + "language": "string", + "nationality": { + "value": "string", + "code": "string" + }, + "vip": { + "vipCode": "string", + "vipDescription": "string" + }, + "address": { + "cityName": "string", + "postalCode": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "streetAddress": "string", + "excludeNoCity": true + }, + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-08-26T15:05:08.991Z" + }, "accompanyGuests": [ { "firstName": "string", - "fullName": "string", "lastName": "string", + "fullName": "string", + "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } - ], - "registrationCardNo": "string" + ] } ], - "address": { - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "excludeNoCity": true, - "postalCode": "string", - "state": "string", - "streetAddress": "string" - }, - "alternateFullName": "string", - "alternateGivenName": "string", - "alternateSurname": "string", - "anonymization": { - "anonymizationDate": "2020-08-26T15:05:08.991Z", - "anonymizationStatus": "Requested" - }, - "birthDate": "2020-08-26", - "email": "string", "externalInfo": { "givenName": "string", "surname": "string" }, - "fullName": "string", - "givenName": "string", "guestLastStayInfo": { "lastStayDate": "2020-08-26", + "lastStayRoom": "string", "lastStayRate": { "amount": 0, "currencyCode": "string" }, - "lastStayRoom": "string", "totalStay": 0 }, - "guestRestricted": true, "guestRestrictedCode": "string", "guestRestrictedReasonDesc": "string", - "id": "string", - "language": "string", - "membership": { - "accountId": "string", - "bonusCode": "string", - "membershipId": 0, - "membershipLevel": "string", - "membershipLevelDesc": "string", - "membershipTypeDesc": "string", - "playerRanking": 0, - "programCode": "string" - }, - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Guest", - "nationality": { - "code": "string", - "value": "string" - }, - "phoneNumber": "string", + "guestRestricted": true, "registrationCardNo": "string", - "surname": "string", - "surnamePrefix": "string", - "type": "string", - "vip": { - "vipCode": "string", - "vipDescription": "string" - } + "nameType": "Guest", + "id": "string", + "type": "string" }, - "reservationIdList": [ + "sharedGuests": [ { - "id": "string", - "type": "string" + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "firstName": "string", + "lastName": "string", + "fullName": "string" } ], - "reservationIndicators": [ + "attachedProfiles": [ { - "count": 0, - "indicatorName": "string" + "name": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ], + "reservationProfileType": "Company" } ], "reservationPaymentMethod": { - "authorizationRule": { - "amount": { + "paymentCard": { + "cardId": { + "id": "string", + "type": "string" + }, + "currentAuthorizedAmount": { "amount": 0, "currencyCode": "string" }, - "code": 0, - "percent": 0 + "approvalAmountNeeded": { + "amount": 0, + "currencyCode": "string" + }, + "cardType": "Ab", + "userDefinedCardType": "string", + "cardNumber": "string", + "cardNumberMasked": "string", + "cardNumberLast4Digits": "string", + "expirationDate": "2020-08-26", + "expirationDateMasked": "string", + "expirationDateExpired": true, + "cardHolderName": "string", + "attachCreditCardToProfile": true, + "processing": "Eft", + "swiped": true, + "cardOrToken": "CardNumber" }, "balance": { "amount": 0, "currencyCode": "string" }, - "description": "string", + "authorizationRule": { + "code": 0, + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "percent": 0 + }, "emailFolioInfo": { "email": { - "createDateTime": "2020-08-26T15:05:08.991Z", - "creatorId": "string", "emailAddress": "string", + "type": "string", + "typeDescription": "string", "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.991Z", - "orderSequence": 0, "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.991Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.991Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, "emailFolio": true, "id": "string", "type": "string" }, - "folioView": 0, - "paymentCard": { - "approvalAmountNeeded": { + "paymentMethod": "string", + "description": "string", + "folioView": 0 + }, + "reservationFolioWindows": [ + { + "payeeInfo": { + "payeeId": { + "id": "string", + "type": "string" + }, + "payeeName": "string", + "payeeAddress": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:05:08.991Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.991Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "id": "string", + "type": "string" + }, + "payeeAddressCount": 0, + "payeeReferenceCurrency": "string", + "payeeAccountInfo": { + "accountName": "string", + "accountId": { + "id": "string", + "type": "string" + }, + "accountNo": "string", + "status": { + "restriction": "string", + "description": "string", + "restricted": true + } + }, + "payeeTaxNumber": "string" + }, + "balance": { "amount": 0, "currencyCode": "string" }, - "attachCreditCardToProfile": true, - "cardHolderName": "string", - "cardId": { - "id": "string", - "type": "string" - }, - "cardNumber": "string", - "cardNumberLast4Digits": "string", - "cardNumberMasked": "string", - "cardOrToken": "CardNumber", - "cardType": "Ab", - "currentAuthorizedAmount": { - "amount": 0, - "currencyCode": "string" - }, - "expirationDate": "2020-08-26", - "expirationDateExpired": true, - "expirationDateMasked": "string", - "processing": "Eft", - "swiped": true, - "userDefinedCardType": "string" - }, - "paymentMethod": "string" - }, - "reservationStatus": "Reserved", - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "totalFixedCharge": { - "amount": 0, - "currencyCode": "string" - }, - "totalPayment": { - "amount": 0, - "currencyCode": "string" - }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" + "paymentMethod": "string", + "folioWindowNo": 0 } - }, - "roomStatus": "Clean", - "roomStay": { - "adultCount": 0, - "arrivalDate": "2020-08-26", - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "bookingChannelCode": "string", - "childCount": 0, - "compBalance": { - "amount": 0, - "currencyCode": "string" - }, - "departureDate": "2020-08-26", - "depositPayments": { - "amount": 0, - "currencyCode": "string" - }, - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-08-26T15:05:08.991Z", - "reservationExpectedDepartureTime": "2020-08-26T15:05:08.991Z" - }, - "fixedRate": true, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestServiceStatus": "DoNotDisturb", - "marketCode": "string", - "numberOfRooms": 0, - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" - }, - "partyCode": "string", - "points": { - "awardsType": "string", - "points": 0 - }, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "pseudoRoom": true, - "rateAmount": { - "amount": 0, - "currencyCode": "string" - }, - "ratePlanCode": "string", - "rateSuppressed": true, - "reservationBlock": { - "blockIdList": [ - { - "id": "string", - "type": "string" - } - ], - "blockName": "string", - "hotelId": "string" - }, - "roomClass": "string", - "roomNumber": "string", - "roomNumberLocked": true, - "roomType": "string", - "roomTypeCharged": "string", - "scheduledCheckoutTime": "2020-08-26", - "sourceOfBusiness": "string", - "sourceOfBusinessDescription": "string", - "totalAmount": { - "amount": 0, - "currencyCode": "string" + ], + "specials": "string", + "lastPrivacyPromptDate": "2020-08-26", + "displayColor": "string", + "reservationIndicators": [ + { + "indicatorName": "string", + "count": 0 } - }, - "roomStayReservation": true, + ], + "roomStatus": "Clean", "searchMatches": [ { "attribute": "string", "value": "string" } ], - "sharedGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - } - } - ], "sourceOfSale": { - "sourceCode": "string", - "sourceType": "string" - }, - "specials": "string", - "taxType": { - "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0 - }, - "turndownInfo": { - "allowed": true, - "status": "Required" + "sourceType": "string", + "sourceCode": "string" }, "waitlist": { - "description": "string", - "priorityCode": "string", + "reasonDescription": "string", "priorityDescription": "string", + "description": "string", "reasonCode": "string", - "reasonDescription": "string", + "priorityCode": "string", "telephone": "string" }, - "walkInIndicator": true, - "welcomeOffer": true - } - ], - "totalResults": 0 - }, - "historyList": { - "count": 0, - "hasMore": true, - "reservationInfo": [ - { - "accessRestriction": "Change", - "advanceCheckIn": { - "advanceCheckedIn": true, - "eTRComments": "string", - "expectedReturnTime": "2020-08-26T15:05:08.991Z" + "queue": { + "timeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string", + "durationInSeconds": 0 + }, + "guestTextInfo": { + "sentTime": "2020-08-26T15:05:08.991Z", + "sentBy": "string" + }, + "priority": 0, + "averageQueueTimeToCheckIn": 0, + "averageQueueTimeCurrentReservations": 0, + "queueDate": "2020-08-26" }, - "allowMobileCheckout": true, - "allowMobileViewFolio": true, - "allowedActions": [ - "Cancel" - ], - "attachedProfiles": [ - { - "name": "string", - "profileIdList": [ + "housekeeping": { + "instructions": "string", + "facilityTaskInfo": { + "task": { + "description": "string", + "instructions": "string", + "facilityDepartureTask": true, + "linenChange": true, + "hotelId": "string", + "code": "string", + "sequence": 0 + }, + "supplies": [ { - "id": "string", - "type": "string" + "description": "string", + "quantity": 0, + "code": "string" } ], - "reservationProfileType": "Company" - } - ], - "cancellationInfo": { - "code": "string", - "date": "2020-08-26", - "description": "string" + "date": "2020-08-26" + }, + "linenChange": true, + "turndownRequested": true, + "serviceTime": "2020-08-26", + "expectedServiceTime": "string", + "roomStatus": "Clean" }, "cashiering": { - "bedTaxReporting": { - "taxRegistrationNo": 0, - "taxableDays": 0, - "visaExpiryDate": "2020-08-26", - "visaIssueDate": "2020-08-26", - "visaNumber": "string" - }, - "billingPrivileges": { - "allowAutoCheckin": true, - "autoSettlement": true, - "autoSettlementFreq": 0, - "autoSettlementType": "string", - "creditLimitAutoPay": true, - "directBillAuthorized": true, - "folioCloseDate": "2020-08-26", - "postStayCharging": true, - "postingRestriction": true, - "preStayCharging": true, - "scheduledCheckout": true, - "scheduledCheckoutTime": "2020-08-26", - "videoCheckout": true - }, - "compAccounting": { - "authorizer": "string", - "compPostings": "string", - "compType": "string" - }, - "financiallyResponsible": true, - "folioTexts": [ - { - "row": 0, - "text": "string" - } - ], - "lastRoomAndTaxPostedDate": "2020-08-26", - "periodicFolio": { - "frequency": 0, - "lastFolioDate": "2020-08-26", - "lastSettlementDate": "2020-08-26" - }, - "proratedBilling": true, - "reservationPreConfiguredRoutingInstruction": { - "authorizerInfo": { - "authorizerId": { - "id": "string", - "type": "string" - }, - "authorizerName": "string", - "authorizerRateCode": "string", - "authorizerUserName": "string", - "inheritAuthorizerRateCode": true - }, - "profileType": "Company", - "promotionCode": "string", - "ratePlanCode": "string" - }, "revenuesAndBalances": { - "balance": { + "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, - "foodAndBevRevenue": { + "totalPayment": { "amount": 0, "currencyCode": "string" }, - "nonRevenue": { + "roomRevenue": { "amount": 0, "currencyCode": "string" }, - "otherRevenue": { + "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, - "roomRevenue": { + "otherRevenue": { "amount": 0, "currencyCode": "string" }, - "totalFixedCharge": { + "nonRevenue": { "amount": 0, "currencyCode": "string" }, - "totalPayment": { + "totalRevenue": { "amount": 0, "currencyCode": "string" }, - "totalRevenue": { + "balance": { "amount": 0, "currencyCode": "string" } }, - "reverseAdvanceCheckInAllowed": true, - "reverseCheckInAllowed": true, + "billingPrivileges": { + "postingRestriction": true, + "preStayCharging": true, + "postStayCharging": true, + "folioCloseDate": "2020-08-26", + "scheduledCheckout": true, + "scheduledCheckoutTime": "2020-08-26", + "directBillAuthorized": true, + "videoCheckout": true, + "allowAutoCheckin": true, + "autoSettlement": true, + "autoSettlementType": "string", + "autoSettlementFreq": 0, + "creditLimitAutoPay": true + }, "taxType": { + "hotelId": "string", "code": "string", - "collectingAgentTax": true, "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, + "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, + "minimumLengthOfStay": 0, "taxExemptNo": "string" }, + "bedTaxReporting": { + "taxRegistrationNo": 0, + "visaNumber": "string", + "visaIssueDate": "2020-08-26", + "visaExpiryDate": "2020-08-26", + "taxableDays": 0 + }, + "folioTexts": [ + { + "text": "string", + "row": 0 + } + ], + "periodicFolio": { + "lastSettlementDate": "2020-08-26", + "lastFolioDate": "2020-08-26", + "frequency": 0 + }, + "compAccounting": { + "compType": "string", + "authorizer": "string", + "compPostings": "string" + }, + "reservationPreConfiguredRoutingInstruction": { + "authorizerInfo": { + "authorizerId": { + "id": "string", + "type": "string" + }, + "authorizerUserName": "string", + "authorizerName": "string", + "authorizerRateCode": "string", + "inheritAuthorizerRateCode": true + }, + "ratePlanCode": "string", + "profileType": "Company", + "promotionCode": "string" + }, + "financiallyResponsible": true, + "proratedBilling": true, + "lastRoomAndTaxPostedDate": "2020-08-26", + "reverseCheckInAllowed": true, + "reverseAdvanceCheckInAllowed": true, "transactionsPosted": true }, - "commissionPayoutTo": "TravelAgent", - "computedReservationStatus": "Reserved", - "createDateTime": "2020-08-26T15:05:08.991Z", - "creatorId": "string", + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0 + }, "deposit": { - "amountOwed": 0, - "amountPaid": 0, "amountRequired": 0, + "amountPaid": 0, + "amountOwed": 0, "dueDate": "2020-08-26", - "hasOutstanding": true, + "postingDate": "2020-08-26", "hasPaid": true, - "postingDate": "2020-08-26" + "hasOutstanding": true + }, + "allowedActions": [ + "Cancel" + ], + "revenuesAndBalances": { + "totalFixedCharge": { + "amount": 0, + "currencyCode": "string" + }, + "totalPayment": { + "amount": 0, + "currencyCode": "string" + }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } }, - "displayColor": "string", - "expectedServiceTime": "string", - "guestPreferredCurrency": "string", - "hotelId": "string", "hotelInterfaceStatusList": [ { + "roomExtension": "string", "hotelInterface": { - "activeFlag": true, - "hotelId": "string", "interfaceId": { "id": "string", "type": "string" }, + "hotelId": "string", "interfaceName": "string", "interfaceType": "Bms", "logo": "string", "machineName": "string", - "status": "Stopped" + "status": "Stopped", + "activeFlag": true }, "interfaceRights": [ { - "category": "string", - "description": "string", "right": 0, - "statusCode": "string" + "statusCode": "string", + "description": "string", + "category": "string" } - ], - "roomExtension": "string" + ] } ], - "hotelName": "string", - "housekeeping": { - "expectedServiceTime": "string", - "facilityTaskInfo": { - "date": "2020-08-26", - "supplies": [ - { - "code": "string", - "description": "string", - "quantity": 0 - } - ], - "task": { - "code": "string", - "description": "string", - "facilityDepartureTask": true, - "hotelId": "string", - "instructions": "string", - "linenChange": true, - "sequence": 0 - } - }, - "instructions": "string", - "linenChange": true, - "roomStatus": "Clean", - "serviceTime": "2020-08-26", - "turndownRequested": true + "guestPreferredCurrency": "string", + "turndownInfo": { + "allowed": true, + "status": "Required" }, - "keyCount": 0, - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.991Z", - "lastPrivacyPromptDate": "2020-08-26", "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", + "roomReady": "Pending", "keyReady": "Pending", + "checkoutMessageReceived": true, "requiresAction": true, - "roomReady": "Pending" - }, - "openFolio": true, - "optedForCommunication": true, - "paymentMethod": "string", - "preRegistered": true, - "purgeDate": "2020-08-26", - "queue": { - "averageQueueTimeCurrentReservations": 0, - "averageQueueTimeToCheckIn": 0, - "guestTextInfo": { - "sentBy": "string", - "sentTime": "2020-08-26T15:05:08.990Z" - }, - "priority": 0, - "queueDate": "2020-08-26", - "timeSpan": { - "duration": "string", - "durationInSeconds": 0, - "endDate": "2020-08-26", - "startDate": "2020-08-26" - } + "errorMessage": "string" }, "reservationCommunication": { - "emails": { - "count": 0, - "emailInfo": [ + "telephones": { + "telephoneInfo": [ { - "email": { - "createDateTime": "2020-08-26T15:05:08.991Z", + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.993Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", + "lastModifyDateTime": "2020-08-26T15:05:08.993Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.991Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" + "purgeDate": "2020-08-26" }, "id": "string", "type": "string" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ + "emails": { + "emailInfo": [ { - "id": "string", - "telephone": { - "createDateTime": "2020-08-26T15:05:08.991Z", + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.993Z", "creatorId": "string", - "extension": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.993Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.991Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, "purgeDate": "2020-08-26" }, + "id": "string", "type": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 } }, - "reservationFolioWindows": [ - { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "folioWindowNo": 0, - "payeeInfo": { - "payeeAccountInfo": { - "accountId": { - "id": "string", - "type": "string" - }, - "accountName": "string", - "accountNo": "string", - "status": { - "description": "string", - "restricted": true, - "restriction": "string" - } - }, - "payeeAddress": { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:05:08.990Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.990Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" - }, - "payeeAddressCount": 0, - "payeeId": { - "id": "string", - "type": "string" - }, - "payeeName": "string", - "payeeReferenceCurrency": "string", - "payeeTaxNumber": "string" - }, - "paymentMethod": "string" - } - ], - "reservationGuest": { - "accompanyGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "registrationCardNo": "string" - } - ], - "address": { - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "excludeNoCity": true, - "postalCode": "string", - "state": "string", - "streetAddress": "string" - }, - "alternateFullName": "string", - "alternateGivenName": "string", - "alternateSurname": "string", - "anonymization": { - "anonymizationDate": "2020-08-26T15:05:08.989Z", - "anonymizationStatus": "Requested" - }, - "birthDate": "2020-08-26", - "email": "string", - "externalInfo": { - "givenName": "string", - "surname": "string" - }, - "fullName": "string", - "givenName": "string", - "guestLastStayInfo": { - "lastStayDate": "2020-08-26", - "lastStayRate": { - "amount": 0, - "currencyCode": "string" - }, - "lastStayRoom": "string", - "totalStay": 0 - }, - "guestRestricted": true, - "guestRestrictedCode": "string", - "guestRestrictedReasonDesc": "string", - "id": "string", - "language": "string", - "membership": { - "accountId": "string", - "bonusCode": "string", - "membershipId": 0, - "membershipLevel": "string", - "membershipLevelDesc": "string", - "membershipTypeDesc": "string", - "playerRanking": 0, - "programCode": "string" - }, - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Guest", - "nationality": { - "code": "string", - "value": "string" - }, - "phoneNumber": "string", - "registrationCardNo": "string", - "surname": "string", - "surnamePrefix": "string", - "type": "string", - "vip": { - "vipCode": "string", - "vipDescription": "string" - } + "advanceCheckIn": { + "advanceCheckedIn": true, + "expectedReturnTime": "2020-08-26T15:05:08.993Z", + "eTRComments": "string" }, - "reservationIdList": [ - { - "id": "string", - "type": "string" - } - ], - "reservationIndicators": [ - { - "count": 0, - "indicatorName": "string" - } - ], - "reservationPaymentMethod": { - "authorizationRule": { - "amount": { - "amount": 0, - "currencyCode": "string" - }, - "code": 0, - "percent": 0 - }, - "balance": { - "amount": 0, - "currencyCode": "string" - }, + "welcomeOffer": true, + "cancellationInfo": { "description": "string", - "emailFolioInfo": { - "email": { - "createDateTime": "2020-08-26T15:05:08.990Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.990Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-08-26", - "type": "string", - "typeDescription": "string" - }, - "emailFolio": true, - "id": "string", - "type": "string" - }, - "folioView": 0, - "paymentCard": { - "approvalAmountNeeded": { - "amount": 0, - "currencyCode": "string" - }, - "attachCreditCardToProfile": true, - "cardHolderName": "string", - "cardId": { - "id": "string", - "type": "string" - }, - "cardNumber": "string", - "cardNumberLast4Digits": "string", - "cardNumberMasked": "string", - "cardOrToken": "CardNumber", - "cardType": "Ab", - "currentAuthorizedAmount": { - "amount": 0, - "currencyCode": "string" - }, - "expirationDate": "2020-08-26", - "expirationDateExpired": true, - "expirationDateMasked": "string", - "processing": "Eft", - "swiped": true, - "userDefinedCardType": "string" - }, - "paymentMethod": "string" - }, - "reservationStatus": "Reserved", - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "totalFixedCharge": { - "amount": 0, - "currencyCode": "string" - }, - "totalPayment": { - "amount": 0, - "currencyCode": "string" - }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStatus": "Clean", - "roomStay": { - "adultCount": 0, - "arrivalDate": "2020-08-26", - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "bookingChannelCode": "string", - "childCount": 0, - "compBalance": { - "amount": 0, - "currencyCode": "string" - }, - "departureDate": "2020-08-26", - "depositPayments": { - "amount": 0, - "currencyCode": "string" - }, - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-08-26T15:05:08.989Z", - "reservationExpectedDepartureTime": "2020-08-26T15:05:08.989Z" - }, - "fixedRate": true, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestServiceStatus": "DoNotDisturb", - "marketCode": "string", - "numberOfRooms": 0, - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" - }, - "partyCode": "string", - "points": { - "awardsType": "string", - "points": 0 - }, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "pseudoRoom": true, - "rateAmount": { - "amount": 0, - "currencyCode": "string" - }, - "ratePlanCode": "string", - "rateSuppressed": true, - "reservationBlock": { - "blockIdList": [ - { - "id": "string", - "type": "string" - } - ], - "blockName": "string", - "hotelId": "string" - }, - "roomClass": "string", - "roomNumber": "string", - "roomNumberLocked": true, - "roomType": "string", - "roomTypeCharged": "string", - "scheduledCheckoutTime": "2020-08-26", - "sourceOfBusiness": "string", - "sourceOfBusinessDescription": "string", - "totalAmount": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStayReservation": true, - "searchMatches": [ - { - "attribute": "string", - "value": "string" - } - ], - "sharedGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - } - } - ], - "sourceOfSale": { - "sourceCode": "string", - "sourceType": "string" - }, - "specials": "string", - "taxType": { "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0 - }, - "turndownInfo": { - "allowed": true, - "status": "Required" - }, - "waitlist": { - "description": "string", - "priorityCode": "string", - "priorityDescription": "string", - "reasonCode": "string", - "reasonDescription": "string", - "telephone": "string" + "date": "2020-08-26" }, + "keyCount": 0, + "hotelId": "string", + "hotelName": "string", + "expectedServiceTime": "string", + "roomStayReservation": true, + "createDateTime": "2020-08-26T15:05:08.993Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.993Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "reservationStatus": "Reserved", + "computedReservationStatus": "Reserved", "walkInIndicator": true, - "welcomeOffer": true + "accessRestriction": "Change", + "commissionPayoutTo": "TravelAgent", + "paymentMethod": "string", + "preRegistered": true, + "openFolio": true, + "allowMobileCheckout": true, + "allowMobileViewFolio": true, + "optedForCommunication": true } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 } }, - "salesInfo": { - "accountSource": "string", - "accountType": "string", - "actionCode": "string", - "businessSegments": "string", - "competitionCode": "string", + "lastStayInfo": { + "lastVisit": "2020-08-26", + "lastRoom": "string", + "lastRate": { + "amount": 0, + "currencyCode": "string" + }, + "totalStay": 0 + }, + "profileAccessType": { + "chainCode": "string", + "croCode": "string", "hotelId": "string", - "industryCode": "string", - "influence": "string", - "preferredRoom": "string", - "priority": "string", - "roomsPotential": "string", - "scope": "string", - "scopeCity": "string" + "sharedLevel": "Global" }, - "statusCode": "Active", - "subscriptions": [ - { - "distributed": true, - "externalProfileId": { - "id": "string", - "type": "string" - }, - "force": true, - "inactive": true, - "lastDistributionDate": "2020-08-26T15:05:08.993Z", - "lastExternalUpdateDate": "2020-08-26T15:05:08.993Z", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - }, - "profileInfo": { - "fullName": "string", - "givenName": "string", - "middleName": "string", - "name": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Primary", - "profileType": "Guest" - }, - "subscriptionDate": "2020-08-26T15:05:08.993Z" - } - ], - "taxInfo": { - "businessId": "string", - "businessRegistration": "string", - "tax1No": "string", - "tax2No": "string", - "taxCategory": "string", - "taxOffice": "string", - "taxType": "string" + "profileRestrictions": { + "reason": "string", + "reasonDescription": "string", + "restricted": true }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ + "mailingActions": { + "mailingAction": [ { - "id": "string", - "telephone": { - "createDateTime": "2020-08-26T15:05:08.988Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.988Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, - "type": "string" + "code": "string", + "description": "string" } ], - "totalResults": 0 - }, - "territory": "string", - "traceCode": "string", - "uRLs": { - "count": 0, + "active": true, "hasMore": true, "totalResults": 0, - "uRLInfo": [ + "count": 0 + }, + "privacyInfo": { + "marketResearchParticipation": true, + "lastPrivacyPromptDate": "2020-08-26", + "infoFromThirdParty": true, + "autoEnrollLoyaltyProgram": true, + "allowPhone": true, + "allowSMS": true, + "allowEmail": true, + "optInMailingList": true, + "optInMarketResearch": true, + "optInThirdParty": true, + "optInAutoEnrollmentMember": true, + "optInPhone": true, + "optInSms": true, + "optInEmail": true + }, + "cashiering": { + "directBillingList": [ { - "id": "string", - "type": "string", - "url": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - } + "hotelId": "string", + "aRNumber": "string" } - ] + ], + "autoFolioSettlementType": "string", + "paymentDueDays": 0, + "taxPercent1": 0, + "taxPercent2": 0, + "taxPercent3": 0, + "taxPercent4": 0, + "taxPercent5": 0, + "arNoCentral": "string", + "referenceCurrency": "string", + "vATOffsetYN": "string", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0 }, + "commissionInfoList": [ + { + "hotelId": "string", + "commissionCode": "string", + "bankAccount": "string", + "paymentMethod": "Cent", + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0 + } + ], "userDefinedFields": { "characterUDFs": [ { - "alternateName": "string", "name": "string", - "value": "string" + "value": "string", + "alternateName": "string" } ], - "dateUDFs": [ + "numericUDFs": [ { - "alternateName": "string", "name": "string", - "value": "2020-08-26" + "value": 0, + "alternateName": "string" } ], - "numericUDFs": [ + "dateUDFs": [ { - "alternateName": "string", "name": "string", - "value": 0 + "value": "2020-08-26", + "alternateName": "string" } ] }, "webUserAccounts": [ { - "autoGeneratePassword": true, + "securityQuestion": { + "code": "string", + "description": "string" + }, + "securityAnswer": "string", "comments": "string", - "domainCode": "string", "history": { "createDateTime": "2020-08-26T15:05:08.993Z", "creatorId": "string", - "inactiveDate": "2020-08-26", - "lastLogin": "2020-08-26", - "lastModifierId": "string", "lastModifyDateTime": "2020-08-26T15:05:08.993Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "lastLogin": "2020-08-26", "lastPasswordChange": "2020-08-26", - "purgeDate": "2020-08-26" + "inactiveDate": "2020-08-26" }, - "inactive": true, - "locked": true, - "loginName": "string", "newLoginName": "string", "newPassword": "string", - "securityAnswer": "string", - "securityQuestion": { - "code": "string", - "description": "string" - } + "autoGeneratePassword": true, + "loginName": "string", + "domainCode": "string", + "locked": true, + "inactive": true } - ] + ], + "taxInfo": { + "tax1No": "string", + "tax2No": "string", + "taxCategory": "string", + "taxOffice": "string", + "taxType": "string", + "businessId": "string", + "businessRegistration": "string" + }, + "salesInfo": { + "scope": "string", + "scopeCity": "string", + "accountType": "string", + "accountSource": "string", + "industryCode": "string", + "businessSegments": "string", + "priority": "string", + "roomsPotential": "string", + "actionCode": "string", + "competitionCode": "string", + "influence": "string", + "preferredRoom": "string", + "hotelId": "string" + }, + "eCertificates": [ + { + "certificateId": 0, + "voucherNo": "string", + "certificateNo": "string", + "eCertificateInfo": { + "certificateType": "string", + "membershipType": "string", + "awardCode": "string", + "promotionCode": "string", + "voucherBenefitCode": "string", + "hotels": { + "code": [ + "string" + ], + "scope": "Global" + }, + "description": "string", + "longDescription": "string", + "label": "string", + "maxExtensionAllowed": 0, + "usageCriteria": { + "reservation": true, + "web": true, + "webAllowed": true, + "benefit": true, + "hotel": true, + "verifyCertificateNo": true, + "cancelAllowed": true, + "generateInLieuCertificate": true + }, + "value": { + "amount": 0, + "currencyCode": "string" + }, + "cost": { + "amount": 0, + "currencyCode": "string" + }, + "benefitSummary": "string" + }, + "expiryDate": "2020-08-26", + "newExpiryDate": "2020-08-26", + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "consumptionDetail": { + "hotelId": "string", + "source": "Central", + "surname": "string", + "firstName": "string", + "middleName": "string", + "email": "string", + "date": "2020-08-26", + "userName": "string", + "userNotes": "string", + "referenceId": { + "id": "string", + "type": "string" + }, + "locationType": "string", + "authorizationCode": "string", + "serviceDate": "2020-08-26" + }, + "status": "Cancelled", + "printed": true, + "inactiveDate": "2020-08-26", + "awardId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "databaseId": "string", + "source": "Opera", + "issueType": "Assigned", + "issueDate": "2020-08-26", + "awardPoints": 0, + "generationDetail": { + "ruleId": { + "id": "string", + "type": "string" + }, + "generationDetail": "string", + "referenceValue": "string" + }, + "originalVoucherNo": "string", + "originalCertificateNo": "string", + "inLieuSequence": 0, + "cancelRequestDate": "2020-08-26", + "extensionCount": 0 + } + ], + "subscriptions": [ + { + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "externalProfileId": { + "id": "string", + "type": "string" + }, + "profileInfo": { + "name": "string", + "fullName": "string", + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameType": "Primary", + "profileType": "Guest" + }, + "distributed": true, + "force": true, + "subscriptionDate": "2020-08-26T15:05:08.993Z", + "lastDistributionDate": "2020-08-26T15:05:08.993Z", + "lastExternalUpdateDate": "2020-08-26T15:05:08.993Z", + "inactive": true + } + ], + "localizationGuestType": "string", + "eligibleForFiscalFolio": "string", + "profileType": "Guest", + "statusCode": "Active", + "registeredProperty": "string", + "requestForHotel": "string", + "protectedBy": "string", + "createDateTime": "2020-08-26T15:05:08.993Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.993Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "markAsRecentlyAccessed": true, + "markForHistory": true, + "hasCommission": true, + "inheritedNegRates": true }, - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], "reservationProfileType": "Company" } ], - "suppressRate": true, - "taxFreeGuestCounts": { + "guestCounts": { + "childAges": [ + { + "age": 0 + } + ], + "childBuckets": { + "bucket1Count": 0, + "bucket2Count": 0, + "bucket3Count": 0, + "bucket4Count": 0, + "bucket5Count": 0 + }, "adults": 0, + "children": 0 + }, + "taxFreeGuestCounts": { "childAges": [ { "age": 0 @@ -22321,678 +19947,657 @@ "bucket4Count": 0, "bucket5Count": 0 }, + "adults": 0, "children": 0 }, - "taxIncluded": true, - "total": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ - { - "amount": 0, - "code": "string", - "currencyCode": "string", - "description": "string", - "type": "Inclusive" - } - ] + "awards": { + "membershipNo": { + "id": "string", + "type": "string" }, - "rateOverride": true, - "taxes": { - "amount": 0, - "currencyCode": "string", - "tax": [ - { - "amount": 0, - "code": "string", - "currencyCode": "string", - "description": "string", - "type": "Inclusive" - } - ] - } + "awardVouchers": [ + { + "awardCode": "string", + "voucherNo": "string" + } + ], + "originalRoomType": "string", + "upgradeRoomType": "string" }, - "totalPoints": { - "awardsType": "string", - "points": 0 - } + "foreignExchange": { + "type": "string", + "effectiveDate": "2020-08-26" + }, + "reservationBlock": { + "blockIdList": [ + { + "id": "string", + "type": "string" + } + ], + "blockName": "string", + "hotelId": "string" + }, + "roomRateInfo": "string", + "mealPlans": [ + { + "code": "string", + "included": true, + "breakfastIncluded": true, + "lunchIncluded": true, + "dinnerIncluded": true + } + ], + "roomType": "string", + "ratePlanCode": "string", + "promotionCode": "string", + "start": "2020-08-26", + "end": "2020-08-26", + "availability": "Available", + "suppressRate": true, + "marketCode": "string", + "marketCodeDescription": "string", + "sourceCode": "string", + "sourceCodeDescription": "string", + "numberOfUnits": 0, + "roomId": "string", + "pseudoRoom": true, + "roomTypeCharged": "string", + "commissionCode": "string", + "commissionable": true, + "houseUseOnly": true, + "complimentary": true, + "inventoryLender": "string", + "fixedRate": true, + "barRanking": 0, + "rateGroup": "string", + "discountAllowed": true, + "bogoDiscount": true, + "rateLevel": "string", + "commissionPercentage": 0, + "commissionAmount": 0, + "credentialsRequired": true, + "taxIncluded": true, + "rateDescription": "string" } ], + "guestCounts": { + "childAges": [ + { + "age": 0 + } + ], + "childBuckets": { + "bucket1Count": 0, + "bucket2Count": 0, + "bucket3Count": 0, + "bucket4Count": 0, + "bucket5Count": 0 + }, + "adults": 0, + "children": 0 + }, + "arrivalDate": "2020-08-26", + "departureDate": "2020-08-26", + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-08-26T15:05:08.994Z", + "reservationExpectedDepartureTime": "2020-08-26T15:05:08.994Z" + }, + "originalTimeSpan": { + "startDate": "2020-08-26", + "endDate": "2020-08-26", + "duration": "string" + }, + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { + "promotionCode": "string", + "promotionName": "string", + "couponCode": "string" + }, "suiteWith": "string", "total": { - "amountAfterTax": 0, - "amountBeforeTax": 0, - "code": "string", - "currencyCode": "string", - "currencySymbol": "string", - "decimalPlaces": 0, - "description": "string", - "fees": { - "amount": 0, - "currencyCode": "string", - "fee": [ + "taxes": { + "tax": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - }, - "rateOverride": true, - "taxes": { + ], "amount": 0, - "currencyCode": "string", - "tax": [ + "currencyCode": "string" + }, + "fees": { + "fee": [ { - "amount": 0, - "code": "string", - "currencyCode": "string", "description": "string", - "type": "Inclusive" + "type": "Inclusive", + "code": "string", + "amount": 0, + "currencyCode": "string" } - ] - } + ], + "amount": 0, + "currencyCode": "string" + }, + "description": "string", + "amountBeforeTax": 0, + "amountAfterTax": 0, + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "code": "string", + "rateOverride": true }, "totalPoints": { "awardsType": "string", "points": 0 }, + "multiValueAttrs": [ + "string" + ], "upsellInfo": { "originalInfo": { - "nights": 0, "rateCode": "string", + "totalAmount": { + "amount": 0, + "currencyCode": "string" + }, "roomType": { "code": "string", "description": "string" }, - "totalAmount": { - "amount": 0, - "currencyCode": "string" - } + "nights": 0 }, "upsellInfo": { - "firstNightUpsellAmount": { + "totalUpsellCharge": { "amount": 0, "currencyCode": "string" }, - "firstNightUpsellCharge": { + "totalUpsellMoneyAmount": { "amount": 0, "currencyCode": "string" }, - "percentageSavings": 0, - "roomLongDescription": "string", - "roomType": { - "code": "string", - "description": "string" - }, - "ruleCode": "string", - "ruleDescription": "string", - "ruleId": 0, - "totalActualRateAmount": { + "firstNightUpsellAmount": { "amount": 0, "currencyCode": "string" }, - "totalUpsellCharge": { + "firstNightUpsellCharge": { "amount": 0, "currencyCode": "string" }, - "totalUpsellMoneyAmount": { + "totalUpsellPoints": 0, + "totalActualRateAmount": { "amount": 0, "currencyCode": "string" }, - "totalUpsellPoints": 0, + "roomType": { + "code": "string", + "description": "string" + }, + "roomLongDescription": "string", + "ruleId": 0, + "ruleCode": "string", + "ruleDescription": "string", + "percentageSavings": 0, "upsellDate": "2020-08-26", "upsellUser": "string" } - } + }, + "mobileNotifications": { + "roomReady": "Pending", + "keyReady": "Pending", + "checkoutMessageReceived": true, + "requiresAction": true, + "errorMessage": "string" + }, + "roomNumberLocked": true, + "printRate": true, + "primaryShareType": "Primary", + "remoteCheckInAllowed": true, + "bookingMedium": "string", + "bookingMediumDescription": "string" } ] }, - "reciprocalRelationship": true, - "relativePosition": { - "distance": 0, - "distanceType": "string", - "drivingTime": "string" + "channelSummaryInfo": { + "bookingChannel": { + "channelCode": "string", + "channelName": "string", + "channelType": "string" + }, + "messageId": "string", + "summaryOnly": true }, "sellMessages": { - "count": 0, - "hasMore": true, "sellMessage": [ { - "chainCode": "string", + "message": "string", "croCode": "string", + "chainCode": "string", "hotelId": "string", - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "languageCode": "string", - "message": "string", - "ratePlanCode": "string", "roomType": "string", + "ratePlanCode": "string", + "languageCode": "string", "stickyFlagYn": "string", - "type": "string", + "usedInModule": "Blocks", "url": "string", - "usedInModule": "Blocks" + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 } ], - "totalResults": 0 - } + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "currencyExchangeRates": [ + { + "currencyCode": "string", + "currencySymbol": "string", + "decimalPlaces": 0, + "description": "string", + "exchangeRate": { + "amount": 0, + "currencyCode": "string" + } + } + ], + "chainCode": "string", + "hotelId": "string", + "hotelCityCode": "string", + "hotelName": "string", + "hotelCodeContext": "string", + "chainName": "string", + "hotelType": "string", + "negotiated": true, + "alternate": true, + "displayOrder": 0, + "inventoryRooms": 0, + "availableRooms": 0, + "comments": "string", + "direction": "string", + "reciprocalRelationship": true, + "alternateHotelCode": "string", + "newAlternateHotelCode": "string" } ], - "attractions": [ + "hotelContacts": [ { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:05:08.994Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.994Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true + "nameId": { + "id": "string", + "type": "string" }, - "class": "string", - "code": "string", - "displaySeq": 0, - "generalDirections": "string", - "name": { - "defaultText": "string", - "translatedTexts": [ - { - "language": "string", - "value": "string" - } + "hotelId": "string", + "name": "string", + "roles": [ + "Lead" + ], + "ownerCode": "string", + "communicationMethod": "string", + "communicationAddress": "string", + "primary": true + } + ], + "hotelEventSpaces": { + "eventSpaceDetails": [ + { + "code": "string", + "description": "string", + "maxCapacity": 0, + "maxOccupancies": [ + 0 ] - }, - "operationHours": "string", - "priceRange": "string", - "relativePosition": { - "distance": 0, - "distanceType": "string", - "drivingTime": "string" - }, - "type": "string", - "website": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - } - } - ], - "baseLanguage": "string", - "chainCode": "string", - "chainName": "string", - "communication": { - "emailAddress": "string", - "faxNumber": { - "createDateTime": "2020-08-26T15:05:08.986Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.986Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, - "phoneNumber": { - "createDateTime": "2020-08-26T15:05:08.986Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.986Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, - "tollFreeNumber": { - "createDateTime": "2020-08-26T15:05:08.986Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.986Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-08-26" - }, - "webPage": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - } - }, - "currentTime": "string", - "directions": [ - { - "description": "string", - "title": "string" - } - ], - "generalInformation": { - "baseLanguage": "string", - "bedCount": 0, - "checkInTime": "2020-08-26T15:05:08.986Z", - "checkOutTime": "2020-08-26T15:05:08.986Z", - "floorCount": 0, - "hotelInfoWebsite": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" - }, - "hotelType": "string", - "latitude": 0, - "longitude": 0, - "roomCount": 0 - }, - "generalNotes": [ - { - "note": "string", - "title": "string" - } - ], - "hotelAirports": [ - { - "airportCode": "string", - "description": "string", - "direction": "string", - "orderSequence": 0, - "relativePosition": { - "distance": 0, - "distanceType": "string", - "drivingTime": "string" - }, - "transportationList": [ - { - "code": "string" - } - ] - } - ], - "hotelAttractions": [ - { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-08-26T15:05:08.995Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.995Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-08-26", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "class": "string", - "code": "string", - "displaySeq": 0, - "generalDirections": "string", - "name": { - "defaultText": "string", - "translatedTexts": [ - { - "language": "string", - "value": "string" - } - ] - }, - "operationHours": "string", - "priceRange": "string", - "relativePosition": { - "distance": 0, - "distanceType": "string", - "drivingTime": "string" - }, - "type": "string", - "website": { - "orderSequence": 0, - "primaryInd": true, - "type": "string", - "typeDescription": "string", - "value": "string" } - } - ], - "hotelCityCode": "string", - "hotelCodeContext": "string", - "hotelConferenceFacilities": { - "hotelBanquetSpace": { - "banquetArea": "string", - "banquetSeats": 0, - "meetingArea": 0, - "meetingRooms": 0, - "unitOfMeasureCode": "string" - }, - "hotelConferenceRooms": [ + ], + "eventSpaceSummaries": [ { - "roomCode": "string", - "roomName": "string", - "roomType": "string" + "no": 0, + "spaceType": "string", + "maxCapacity": 0, + "maxOccupancies": [ + 0 + ] } + ], + "setupStyles": [ + "string" ] }, - "hotelContacts": [ + "hotelNotes": [ { - "communicationAddress": "string", - "communicationMethod": "string", - "hotelId": "string", - "name": "string", - "nameId": { - "id": "string", - "type": "string" + "comment": { + "text": { + "value": "string", + "language": "string" + }, + "image": "string", + "url": "string", + "commentTitle": "string", + "notificationLocation": "string", + "type": "string", + "typeDescription": "string", + "internal": true, + "confidential": true, + "overrideInternal": true, + "protectDescription": true, + "hotelId": "string", + "actionType": "string", + "actionDate": "2020-08-26", + "createDateTime": "2020-08-26T15:05:08.994Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.994Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" }, - "ownerCode": "string", - "primary": true, - "roles": [ - "Lead" - ] + "createDateTime": "2020-08-26T15:05:08.994Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.994Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26", + "id": "string", + "type": "string" } ], "hotelCorporateInformations": { "brandCode": "string", + "hotelCategory": "string", "businessUnit": [ { + "primary": true, "codeDescription": { "code": "string", "description": "string" - }, - "primary": true + } } ], "departmentCode": [ { + "primary": true, "codeDescription": { "code": "string", "description": "string" - }, - "primary": true + } } ], "division": [ { + "primary": true, "codeDescription": { "code": "string", "description": "string" - }, - "primary": true + } } ], - "hotelCategory": "string", "opertingUnit": [ { + "primary": true, "codeDescription": { "code": "string", "description": "string" - }, - "primary": true + } } ] }, - "hotelEventSpaces": { - "eventSpaceDetails": [ - { - "code": "string", - "description": "string", - "maxCapacity": 0, - "maxOccupancies": [ - 0 + "attractions": [ + { + "name": { + "defaultText": "string", + "translatedTexts": [ + { + "value": "string", + "language": "string" + } ] - } - ], - "eventSpaceSummaries": [ - { - "maxCapacity": 0, - "maxOccupancies": [ - 0 + }, + "type": "string", + "class": "string", + "generalDirections": "string", + "relativePosition": { + "distance": 0, + "distanceType": "string", + "drivingTime": "string" + }, + "address": { + "addressLine": [ + "string" ], - "no": 0, - "spaceType": "string" - } - ], - "setupStyles": [ - "string" - ] - }, - "hotelFeatures": [ - { - "comments": "string", - "description": "string", - "featureCode": "string", - "hours": "string", - "orderSequence": 0, - "priceRange": "string" + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:05:08.994Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.994Z", + "lastModifierId": "string", + "purgeDate": "2020-08-26" + }, + "website": { + "value": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "orderSequence": 0 + }, + "priceRange": "string", + "operationHours": "string", + "displaySeq": 0, + "code": "string" } ], - "hotelId": "string", - "hotelMiscellaneousInformation": [ + "meetingRooms": [ { - "category": "string", - "infoType": "string", - "information": "string" + "code": "string", + "charge": "string", + "description": "string" } ], + "chainCode": "string", + "hotelId": "string", + "hotelCityCode": "string", "hotelName": "string", - "hotelNotes": [ + "hotelCodeContext": "string", + "chainName": "string", + "baseLanguage": "string", + "currentTime": "string", + "hotelAttractions": [ { - "comment": { - "actionDate": "2020-08-26", - "actionType": "string", - "commentTitle": "string", - "confidential": true, - "createDateTime": "2020-08-26T15:05:08.994Z", + "name": { + "defaultText": "string", + "translatedTexts": [ + { + "value": "string", + "language": "string" + } + ] + }, + "type": "string", + "class": "string", + "generalDirections": "string", + "relativePosition": { + "distance": 0, + "distanceType": "string", + "drivingTime": "string" + }, + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-08-26T15:05:08.995Z", "creatorId": "string", - "hotelId": "string", - "image": "string", - "internal": true, + "lastModifyDateTime": "2020-08-26T15:05:08.995Z", "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.994Z", - "notificationLocation": "string", - "overrideInternal": true, - "protectDescription": true, - "purgeDate": "2020-08-26", - "text": { - "language": "string", - "value": "string" - }, + "purgeDate": "2020-08-26" + }, + "website": { + "value": "string", "type": "string", "typeDescription": "string", - "url": "string" + "primaryInd": true, + "orderSequence": 0 }, - "createDateTime": "2020-08-26T15:05:08.994Z", - "creatorId": "string", - "id": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.994Z", - "purgeDate": "2020-08-26", - "type": "string" + "priceRange": "string", + "operationHours": "string", + "displaySeq": 0, + "code": "string" } ], "hotelPackages": [ { + "packageName": "string", "beginDate": "2020-08-26", "endDate": "2020-08-26", - "packageCode": "string", - "packageName": "string", "packagePrice": 0, + "rateCode": "string", "pointsRequired": 0, - "rateCode": "string" - } - ], - "hotelRateRanges": [ - { - "currencyCode": "string", - "hotelId": "string", - "maxRate": 0, - "minRate": 0, - "timeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" - } - } - ], - "hotelRestaurants": [ - { - "category": "Restaurant", - "comments": "string", - "hotelId": "string", - "hours": "string", - "newRestaurantCode": "string", - "orderBy": 0, - "priceRange": "string", - "restaurantCode": "string", - "restaurantName": "string", - "restaurantType": "string", - "timeSpan": { - "duration": "string", - "endDate": "2020-08-26", - "startDate": "2020-08-26" - } + "packageCode": "string" } ], "hotelTransportations": [ { - "comments": "string", - "description": "string", - "keyOptions": [ - "string" - ], - "label": "string", - "orderBy": 0, "phoneNumber": { - "createDateTime": "2020-08-26T15:05:08.995Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-08-26T15:05:08.995Z", - "orderSequence": 0, - "phoneNumber": "string", "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-08-26T15:05:08.995Z", + "creatorId": "string", + "lastModifyDateTime": "2020-08-26T15:05:08.995Z", + "lastModifierId": "string", "purgeDate": "2020-08-26" }, - "priceRange": "string", "relativePosition": { "distance": 0, "distanceType": "string", "drivingTime": "string" }, - "transportationCode": "string", + "description": "string", + "comments": "string", + "priceRange": "string", "website": { - "orderSequence": 0, - "primaryInd": true, + "value": "string", "type": "string", "typeDescription": "string", - "value": "string" + "primaryInd": true, + "orderSequence": 0 + }, + "keyOptions": [ + "string" + ], + "transportationCode": "string", + "label": "string", + "orderBy": 0 + } + ], + "hotelConferenceFacilities": { + "hotelBanquetSpace": { + "banquetSeats": 0, + "meetingRooms": 0, + "banquetArea": "string", + "meetingArea": 0, + "unitOfMeasureCode": "string" + }, + "hotelConferenceRooms": [ + { + "roomName": "string", + "roomType": "string", + "roomCode": "string" } + ] + }, + "hotelFeatures": [ + { + "description": "string", + "comments": "string", + "featureCode": "string", + "orderSequence": 0, + "hours": "string", + "priceRange": "string" } ], - "meetingRooms": [ + "directions": [ { - "charge": "string", - "code": "string", - "description": "string" + "description": "string", + "title": "string" } ], - "primaryDetails": { - "legalOwner": "string" - }, - "propertyControls": { - "applicationMode": { - "configurationMode": "string", - "countryMode": "string", - "expHotelCode": "string", - "mbsSupported": true, - "touristNumber": "string" - }, - "cateringCurrencyFormatting": { - "currencyCode": "string", - "currencyFormat": "string" - }, - "currencyFormatting": { - "currencyCode": "string", - "currencyFormat": "string", - "currencySymbol": "string", - "decimalPositions": 0 - }, - "dateTimeFormatting": { - "longDateFormat": "string", - "shortDateFormat": "string", - "timeFormat": "string", - "timeZoneRegion": "string" - }, - "sellControls": { - "endDate": "2020-08-26", - "hotelId": "string", - "startDate": "2020-08-26" + "generalNotes": [ + { + "note": "string", + "title": "string" } - } + ], + "hotelAirports": [ + { + "description": "string", + "relativePosition": { + "distance": 0, + "distanceType": "string", + "drivingTime": "string" + }, + "direction": "string", + "transportationList": [ + { + "code": "string" + } + ], + "airportCode": "string", + "orderSequence": 0 + } + ], + "hotelMiscellaneousInformation": [ + { + "category": "string", + "infoType": "string", + "information": "string" + } + ] }, "links": [ { "href": "string", - "method": "GET", - "operationId": "string", "rel": "string", - "targetSchema": "string", "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", "title": "string" } ] @@ -23003,56 +20608,42 @@ "description": "HotelBrochure not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/hotelDetails": { - "get": { - "description": "Use this API to get hotel details.OperationId:getHotelDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23061,155 +20652,129 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/hotelDetails": { + "get": { "summary": "Get hotel details ", + "description": "Use this API to get hotel details.OperationId:getHotelDetails
", "operationId": "getHotelDetails", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { + "name": "hotelDetailCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "hotelDetailCodes", - "in": "query" + "required": false }, { + "name": "hotelDetailCategoriesCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "hotelDetailCategoriesCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching hotel details at the property level.", - "schema": { - "$ref": "#/definitions/hotelDetailsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 details at the property level.", + "schema": { + "$ref": "#/definitions/hotelDetailsDetails" } }, "204": { "description": "HotelDetails not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/jobTitles": { - "get": { - "description": "Use this API to get resort job titles.OperationId:getJobTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23218,143 +20783,118 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/jobTitles": { + "get": { "summary": "Get resort job titles", + "description": "Use this API to get resort job titles.OperationId:getJobTitles
", "operationId": "getJobTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { + "name": "jobTitleCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "jobTitleCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching job titles configured for hotels.", - "schema": { - "$ref": "#/definitions/jobTitlesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching job titles configured for hotels.", + "schema": { + "$ref": "#/definitions/jobTitlesDetails" } }, "204": { "description": "JobTitles not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create new resort job titles.OperationId:postJobTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23363,24 +20903,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create new resort job titles", + "description": "Use this API to create new resort job titles.OperationId:postJobTitles
", "operationId": "postJobTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new job titles for hotels.", "name": "jobTitlesCriteria", "in": "body", "required": true, + "description": "Request object for creating new job titles for hotels.", "schema": { "allOf": [ { @@ -23390,111 +20933,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/jobTitles/{jobTitleCode}": { - "put": { - "description": "Use this API to update job titles for a specific property based on jobTitleCode, hotelId, jobTitlesToBeChanged.OperationId:changeJobTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23503,33 +21012,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/jobTitles/{jobTitleCode}": { + "put": { "summary": "Change resort job titles", + "description": "Use this API to update resort job titles.OperationId:changeJobTitles
", "operationId": "changeJobTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Code for Job Title.", "name": "jobTitleCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code for Job Title." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for modifying job titles for hotels.", "name": "jobTitlesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying job titles for hotels.", "schema": { "allOf": [ { @@ -23539,109 +21053,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete job titles for a specific property based on jobTitleCode, hotelId.OperationId:removeJobTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23650,134 +21132,103 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete resort job titles", + "description": "Use this API to delete resort job titles.OperationId:removeJobTitles
", "operationId": "removeJobTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Code for Job Title.", "name": "jobTitleCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code for Job Title." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/marketingCities": { - "get": { - "description": "Use this API to get resort marketing cities.OperationId:getMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23786,178 +21237,158 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/marketingCities": { + "get": { "summary": "Get resort marketing cities", + "description": "Use this API to get resort marketing cities.OperationId:getMarketingCities
", "operationId": "getMarketingCities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "boolean", - "description": "Flag to indicate whether to include inactive marketing cities in the results or not.", "name": "includeInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Flag to indicate whether to include inactive marketing cities in the results or not.", + "type": "boolean" }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "type": "integer", - "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.", "name": "pageNumber", - "in": "query" + "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": "marketingCitys", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "List of Marketing Cities.", - "name": "marketingCitys", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { + "name": "regionCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "regionCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Marketing city description to search for.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Marketing city description to search for.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching marketing cities configured for hotels.", - "schema": { - "$ref": "#/definitions/marketingCitiesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching marketing cities configured for hotels.", + "schema": { + "$ref": "#/definitions/marketingCitiesDetails" } }, "204": { "description": "MarketingCities not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create new resort marketing cities.OperationId:postMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -23966,24 +21397,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create new resort marketing cities", + "description": "Use this API to create new resort marketing cities.OperationId:postMarketingCities
", "operationId": "postMarketingCities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new marketing cities for hotels.", "name": "marketingCitiesCriteria", "in": "body", "required": true, + "description": "Request object for creating new marketing cities for hotels.", "schema": { "allOf": [ { @@ -23993,111 +21427,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/marketingCities/{cityCode}": { - "put": { - "description": "Use this API to update marketing cities for a specific property based on cityCode, hotelId, marketingCitiesToBeChanged.OperationId:changeMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24106,33 +21506,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/marketingCities/{cityCode}": { + "put": { "summary": "Change resort marketing cities", + "description": "Use this API to update resort marketing cities.OperationId:changeMarketingCities
", "operationId": "changeMarketingCities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of city.", "name": "cityCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of city." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for modifying marketing cities for hotels.", "name": "marketingCitiesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying marketing cities for hotels.", "schema": { "allOf": [ { @@ -24142,109 +21547,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete marketing cities for a specific property based on cityCode, hotelId, regionCode.OperationId:removeMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24253,140 +21626,110 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete resort marketing cities", + "description": "Use this API to delete resort marketing cities.OperationId:removeMarketingCities
", "operationId": "removeMarketingCities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of city.", "name": "cityCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of city." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Region code the marketing city belongs to.", "name": "regionCode", - "in": "query" + "in": "query", + "required": false, + "description": "Region code the marketing city belongs to.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/notes": { - "post": { - "description": "Use this API to create Note information.OperationId:postHotelNotes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24395,24 +21738,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/notes": { + "post": { "summary": "Create Note information", + "description": "Use this API to create Note information.OperationId:postHotelNotes
", "operationId": "postHotelNotes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new Notes for the hotels", "name": "hotelNotesCriteria", "in": "body", "required": true, + "description": "Request object for creating new Notes for the hotels", "schema": { "allOf": [ { @@ -24422,111 +21770,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/notes/{noteCode}": { - "put": { - "description": "Use this API to update note information for a specific property based on noteCode, hotelId, hotelNotesToBeChanged.OperationId:changeHotelNotes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24535,33 +21849,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/notes/{noteCode}": { + "put": { "summary": "Update Note information", + "description": "Update Note information.OperationId:changeHotelNotes
", "operationId": "changeHotelNotes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of note.", "name": "noteCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of note." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing hotel Notes for hotels.", "name": "hotelNotesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing hotel Notes for hotels.", "schema": { "allOf": [ { @@ -24571,111 +21890,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/operaContext": { - "get": { - "description": "This API will retrieve general contextual information for the specified hotel such as business date.OperationId:getOperaHotelContext
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24684,124 +21969,95 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/operaContext": { + "get": { "summary": "Get Opera Hotel Context", + "description": "This API will retrieve general contextual information for the specified hotel such as business date.OperationId:getOperaHotelContext
", "operationId": "getOperaHotelContext", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "The result element returned with general hotel contextual information.", - "schema": { - "$ref": "#/definitions/operaHotelContextDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "The result element returned with general hotel contextual information.", + "schema": { + "$ref": "#/definitions/operaHotelContextDetails" } }, "204": { "description": "OperaHotelContext not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/rateRanges": { - "put": { - "description": "Use this API to update rate range information for a specific property based on hotelId, hotelRateRangesToBeChanged.OperationId:changeHotelRateRanges
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24810,136 +22066,109 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Update Rate Range information", - "operationId": "changeHotelRateRanges", + ] + } + }, + "/hotels/{hotelId}/rateRanges": { + "post": { + "summary": "Create Rate Range information", + "description": "Use this API to create Rate Range information.OperationId:postHotelRateRanges
", + "operationId": "postHotelRateRanges", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing hotel Rate Ranges for hotels.", - "name": "hotelRateRangesToBeChanged", + "name": "hotelRateRangesCriteria", "in": "body", "required": true, + "description": "Request object for creating new Rate Ranges for hotels.", "schema": { "allOf": [ { - "$ref": "#/definitions/hotelRateRangesToBeChanged" + "$ref": "#/definitions/hotelRateRangesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Rate Range information.OperationId:postHotelRateRanges
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -24948,136 +22177,107 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Create Rate Range information", - "operationId": "postHotelRateRanges", + ] + }, + "put": { + "summary": "Update Rate Range information", + "description": "Update Rate Range information.OperationId:changeHotelRateRanges
", + "operationId": "changeHotelRateRanges", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new Rate Ranges for hotels.", - "name": "hotelRateRangesCriteria", + "name": "hotelRateRangesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing hotel Rate Ranges for hotels.", "schema": { "allOf": [ { - "$ref": "#/definitions/hotelRateRangesCriteria" + "$ref": "#/definitions/hotelRateRangesToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete rate range information for a specific property based on hotelId, startDate, endDate, duration.OperationId:removeHotelRateRanges
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25086,142 +22286,114 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Rate Range information", + "description": "Use this API to delete Rate Range information.OperationId:removeHotelRateRanges
", "operationId": "removeHotelRateRanges", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "format": "date", "name": "startDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", "name": "endDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", "name": "duration", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/restaurants": { - "post": { - "description": "Use this API to create restaurant information.OperationId:postHotelRestaurants
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25230,24 +22402,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/restaurants": { + "post": { "summary": "Create restaurant information", + "description": "Use this API to create restaurant information.OperationId:postHotelRestaurants
", "operationId": "postHotelRestaurants", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new restaurants for hotels.", "name": "hotelRestaurantsCriteria", "in": "body", "required": true, + "description": "Request object for creating new restaurants for hotels.", "schema": { "allOf": [ { @@ -25257,111 +22434,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/restaurants/{restaurantCode}": { - "put": { - "description": "Use this API to update restaurant information for a specific property based on restaurantCode, hotelId, hotelRestaurantsToBeChanged.OperationId:changeHotelRestaurants
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25370,33 +22513,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/restaurants/{restaurantCode}": { + "put": { "summary": "Update the restaurant information", + "description": "Update the restaurant information.OperationId:changeHotelRestaurants
", "operationId": "changeHotelRestaurants", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of restaurant.", "name": "restaurantCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of restaurant." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing hotel restaurants for hotels.", "name": "hotelRestaurantsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing hotel restaurants for hotels.", "schema": { "allOf": [ { @@ -25406,109 +22554,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete restaurant information for a specific property based on restaurantCode, hotelId.OperationId:removeHotelRestaurants
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25517,134 +22633,103 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete restaurant information", + "description": "Use this API to delete restaurant information.OperationId:removeHotelRestaurants
", "operationId": "removeHotelRestaurants", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of restaurant.", "name": "restaurantCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of restaurant." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/telephoneBookCategories": { - "get": { - "description": "Use this API to get Telephone Book Category.OperationId:getTelephoneBookCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25653,139 +22738,114 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/telephoneBookCategories": { + "get": { "summary": "Get Telephone Book Category", + "description": "Use this API to get Telephone Book Category.OperationId:getTelephoneBookCategories
", "operationId": "getTelephoneBookCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetch Telephone Categories.", - "schema": { - "$ref": "#/definitions/telephoneBookCategoriesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetch Telephone Categories.", + "schema": { + "$ref": "#/definitions/telephoneBookCategoriesDetails" } }, "204": { "description": "TelephoneBookCategories not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Telephone Book Category.OperationId:postTelephoneBookCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25794,24 +22854,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Telephone Book Category", + "description": "Use this API to create Telephone Book Category.OperationId:postTelephoneBookCategories
", "operationId": "postTelephoneBookCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for Telephone Book Category.", "name": "telephoneBookCategoriesCriteria", "in": "body", "required": true, + "description": "Request object for Telephone Book Category.", "schema": { "allOf": [ { @@ -25821,111 +22884,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/telephoneBookCategories/{categoryCode}": { - "put": { - "description": "Use this API to update telephone book categories for a specific property based on categoryCode, hotelId, telephoneBookCategoriesToBeChanged.OperationId:changeTelephoneBookCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -25934,33 +22963,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/telephoneBookCategories/{categoryCode}": { + "put": { "summary": "Change Telephone Book Category", + "description": "Use this API to update Telephone Book Category.OperationId:changeTelephoneBookCategories
", "operationId": "changeTelephoneBookCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of category.", "name": "categoryCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of category." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for Telephone Book Category.", "name": "telephoneBookCategoriesToBeChanged", "in": "body", "required": true, + "description": "Request object for Telephone Book Category.", "schema": { "allOf": [ { @@ -25970,109 +23004,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete telephone book categories for a specific property based on categoryCode, hotelId, description, orderBy, generic.OperationId:removeTelephoneBookCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26081,161 +23083,133 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Telephone Book Category", + "description": "Use this API to delete Telephone Book Category.OperationId:removeTelephoneBookCategories
", "operationId": "removeTelephoneBookCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of category.", "name": "categoryCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of category." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "description", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { "type": "string" }, - "collectionFormat": "multi", - "name": "description", - "in": "query" + "required": false }, { + "name": "orderBy", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { "type": "integer" }, - "collectionFormat": "multi", - "name": "orderBy", - "in": "query" + "required": false }, { + "name": "generic", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { "type": "boolean" }, - "collectionFormat": "multi", - "name": "generic", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/telephoneBookEntries": { - "get": { - "description": "Use this API to get Telephone Book Entries.OperationId:getTelephoneBookEntries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26244,134 +23218,109 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/telephoneBookEntries": { + "get": { "summary": "Get Telephone Book Entries", + "description": "Use this API to get Telephone Book Entries.OperationId:getTelephoneBookEntries
", "operationId": "getTelephoneBookEntries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Category code that the telephone book entry belongs to.", "name": "category", - "in": "query" + "in": "query", + "required": false, + "description": "Category code that the telephone book entry belongs to.", + "type": "string" }, { - "type": "string", - "description": "Wildcard search on the name of telephone book entry.", "name": "name", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the name of telephone book entry.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetch Telephone Book Entries.", - "schema": { - "$ref": "#/definitions/telephoneBookEntriesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetch Telephone Book Entries.", + "schema": { + "$ref": "#/definitions/telephoneBookEntriesDetails" } }, "204": { "description": "TelephoneBookEntries not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Telephone Book Entries.OperationId:postTelephoneBookEntries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26380,24 +23329,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Telephone Book Entries", + "description": "Use this API to create Telephone Book Entries.OperationId:postTelephoneBookEntries
", "operationId": "postTelephoneBookEntries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for Telephone Book Entries.", "name": "telephoneBookEntriesCriteria", "in": "body", "required": true, + "description": "Request object for Telephone Book Entries.", "schema": { "allOf": [ { @@ -26407,111 +23359,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/telephoneBookEntries/{entryId}": { - "put": { - "description": "Use this API to update telephone book entries for a specific property based on entryId, hotelId, telephoneBookEntriesToBeChanged.OperationId:changeTelephoneBookEntries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26520,33 +23438,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/telephoneBookEntries/{entryId}": { + "put": { "summary": "Create Telephone Book Entries", + "description": "Use this API to create Telephone Book Entries.OperationId:changeTelephoneBookEntries
", "operationId": "changeTelephoneBookEntries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of entry.", "name": "entryId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of entry." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for Telephone Book Entries.", "name": "telephoneBookEntriesToBeChanged", "in": "body", "required": true, + "description": "Request object for Telephone Book Entries.", "schema": { "allOf": [ { @@ -26556,109 +23479,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete telephone book entries for a specific property based on entryId, hotelId, idContext.OperationId:removeTelephoneBookEntries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26667,144 +23558,114 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Telephone Book Entries", + "description": "Use this API to delete Telephone Book Entries.OperationId:removeTelephoneBookEntries
", "operationId": "removeTelephoneBookEntries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of entry.", "name": "entryId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of entry." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "idContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "idContext", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/transportations": { - "get": { - "description": "Use this API to get transportation.OperationId:getTransportation
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26813,150 +23674,126 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/transportations": { + "get": { "summary": "Get transportation", + "description": "Use this API to get transportation.OperationId:getTransportation
", "operationId": "getTransportation", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { + "name": "transportationCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "transportationCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for information regarding transportation.", - "schema": { - "$ref": "#/definitions/transportationDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 transportation.", + "schema": { + "$ref": "#/definitions/transportationDetails" } }, "204": { "description": "Transportation not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create transportation.OperationId:postTransportation
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -26965,24 +23802,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create transportation", + "description": "Use this API to create transportation.OperationId:postTransportation
", "operationId": "postTransportation", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating transportation.", "name": "transportationCriteria", "in": "body", "required": true, + "description": "Request object for creating transportation.", "schema": { "allOf": [ { @@ -26992,111 +23832,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/transportations/{transportationCode}": { - "put": { - "description": "Use this API to update transportation for a specific property based on transportationCode, hotelId, transportationToBeChanged.OperationId:changeTransportation
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27105,33 +23911,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/transportations/{transportationCode}": { + "put": { "summary": " modify transportation", + "description": "You can use this API to modify Transportation for a property.OperationId:changeTransportation
", "operationId": "changeTransportation", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of transportation.", "name": "transportationCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of transportation." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for modifying transportation.", "name": "transportationToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying transportation.", "schema": { "allOf": [ { @@ -27141,109 +23952,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete transportation for a specific property based on parameters such as transportationCode, hotelId, label, orderBy, createDateTime, creatorId, extension, lastModifierId, lastModifyDateTime, etc.OperationId:removeTransportation
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27252,309 +24031,303 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete transportation", + "description": "Use this API to delete transportation.OperationId:removeTransportation
", "operationId": "removeTransportation", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of transportation.", "name": "transportationCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of transportation." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "label", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { "type": "string" }, - "collectionFormat": "multi", - "name": "label", - "in": "query" + "required": false }, { + "name": "orderBy", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { "type": "integer" }, - "collectionFormat": "multi", - "name": "orderBy", - "in": "query" + "required": false }, { - "type": "string", - "format": "date-time", - "description": "Time stamp of the creation.", "name": "createDateTime", - "in": "query" + "in": "query", + "required": false, + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" }, { - "type": "string", - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", "name": "creatorId", - "in": "query" + "in": "query", + "required": false, + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string" }, { - "type": "string", - "description": "Extension to reach a specific party at the phone number.", "name": "extension", - "in": "query" + "in": "query", + "required": false, + "description": "Extension to reach a specific party at the phone number.", + "type": "string" }, { - "type": "string", - "description": "Identifies the last software system or person to modify a record.", "name": "lastModifierId", - "in": "query" + "in": "query", + "required": false, + "description": "Identifies the last software system or person to modify a record.", + "type": "string" }, { - "type": "string", - "format": "date-time", - "description": "Time stamp of last modification.", "name": "lastModifyDateTime", - "in": "query" + "in": "query", + "required": false, + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" }, { - "type": "number", - "description": "Display Order sequence.", "name": "phoneNumberOrderSequence", - "in": "query" + "in": "query", + "required": false, + "description": "Display Order sequence.", + "type": "number" }, { - "type": "string", - "description": "Telephone number assigned to a single location.", "name": "phoneNumber", - "in": "query" + "in": "query", + "required": false, + "description": "Telephone number assigned to a single location.", + "type": "string" }, { - "type": "string", - "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.", "name": "phoneTechType", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.", + "type": "string" }, { - "type": "string", - "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).", "name": "phoneUseType", - "in": "query" + "in": "query", + "required": false, + "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).", + "type": "string" }, { - "type": "string", - "description": "Description of the PhoneUseType code", "name": "phoneUseTypeDescription", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the PhoneUseType code", + "type": "string" }, { - "type": "boolean", - "description": "When true, indicates a primary information.", "name": "phoneNumberPrimaryInd", - "in": "query" + "in": "query", + "required": false, + "description": "When true, indicates a primary information.", + "type": "boolean" }, { - "type": "string", - "format": "date", - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "name": "purgeDate", - "in": "query" + "in": "query", + "required": false, + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date" }, { - "type": "number", - "description": "Defines the distance between two points.", "name": "distance", - "in": "query" + "in": "query", + "required": false, + "description": "Defines the distance between two points.", + "type": "number" }, { - "type": "string", - "description": "The unit of measure in a code format.", "name": "distanceType", - "in": "query" + "in": "query", + "required": false, + "description": "The unit of measure in a code format.", + "type": "string" }, { - "type": "string", - "description": "The driving time in a free text format.", "name": "drivingTime", - "in": "query" + "in": "query", + "required": false, + "description": "The driving time in a free text format.", + "type": "string" }, { + "name": "description", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "The description of the transportation.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "The description of the transportation.", - "name": "description", - "in": "query" + "required": false }, { + "name": "comments", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Comments about the transportation.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Comments about the transportation.", - "name": "comments", - "in": "query" + "required": false }, { + "name": "priceRange", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "The price range of the transportation.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "The price range of the transportation.", - "name": "priceRange", - "in": "query" + "required": false }, { - "type": "number", - "description": "Display Order sequence.", "name": "websiteOrderSequence", - "in": "query" + "in": "query", + "required": false, + "description": "Display Order sequence.", + "type": "number" }, { - "type": "boolean", - "description": "When true, indicates a primary information.", "name": "websitePrimaryInd", - "in": "query" + "in": "query", + "required": false, + "description": "When true, indicates a primary information.", + "type": "boolean" }, { - "type": "string", - "description": "Defines the purpose of the URL address, such as personal, business, public, etc.", "name": "type", - "in": "query" + "in": "query", + "required": false, + "description": "Defines the purpose of the URL address, such as personal, business, public, etc.", + "type": "string" }, { - "type": "string", - "description": "Describes the Type code", "name": "typeDescription", - "in": "query" + "in": "query", + "required": false, + "description": "Describes the Type code", + "type": "string" }, { + "name": "keyOptionsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "keyOptionsCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/yieldAdjustmentCodes": { - "get": { - "description": "Use this API to get Yield Adjustment Codes.OperationId:getYieldAdjustmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27563,163 +24336,140 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/yieldAdjustmentCodes": { + "get": { "summary": "Get Yield Adjustment Codes", + "description": "Use this API to get Yield Adjustment Codes.OperationId:getYieldAdjustmentCodes
", "operationId": "getYieldAdjustmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "hotelIds", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "hotelIds", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { + "name": "yieldAdjustmentCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "yieldAdjustmentCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { + "name": "type", + "in": "query", + "required": false, + "type": "string", + "description": "Defines values for Yield Adjustment Types.", "uniqueItems": true, "enum": [ "PerStay", "PerNight", "PerPersonPerNight", "PerPersonPerStay" - ], - "type": "string", - "description": "Defines values for Yield Adjustment Types.", - "name": "type", - "in": "query" + ] }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Yield AdjustmentCodes configurations.", - "schema": { - "$ref": "#/definitions/yieldAdjustmentCodesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Yield AdjustmentCodes configurations.", + "schema": { + "$ref": "#/definitions/yieldAdjustmentCodesDetails" } }, "204": { "description": "YieldAdjustmentCodes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Yield Adjustment Codes.OperationId:postYieldAdjustmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27728,24 +24478,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Yield Adjustment Codes", + "description": "Use this API to create Yield Adjustment Codes.OperationId:postYieldAdjustmentCodes
", "operationId": "postYieldAdjustmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new Yield AdjustmentCodes Configurations.", "name": "yieldAdjustmentCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating new Yield AdjustmentCodes Configurations.", "schema": { "allOf": [ { @@ -27755,111 +24508,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/yieldAdjustmentCodes/{yieldAdjustmentCode}": { - "put": { - "description": "Use this API to update yield adjustment codes for a specific property based on yieldAdjustmentCode, hotelId, yieldAdjustmentCodesToBeChanged.OperationId:changeYieldAdjustmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -27868,33 +24587,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/yieldAdjustmentCodes/{yieldAdjustmentCode}": { + "put": { "summary": "Change Yield Adjustment Codes", + "description": "Use this API to update Yield Adjustment Codes.OperationId:changeYieldAdjustmentCodes
", "operationId": "changeYieldAdjustmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of yield adjustment.", "name": "yieldAdjustmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of yield adjustment." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing existing Yield AdjustmentCodes Configurations.", "name": "yieldAdjustmentCodesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing existing Yield AdjustmentCodes Configurations.", "schema": { "allOf": [ { @@ -27904,109 +24628,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete yield adjstment codes for a specific property based on yieldAdjustmentCode, hotelId.OperationId:removeYieldAdjustmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28015,134 +24707,103 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Yield Adjustment Codes", + "description": "Use this API to delete Yield Adjustment Codes.OperationId:removeYieldAdjustmentCodes
", "operationId": "removeYieldAdjustmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of yield adjustment.", "name": "yieldAdjustmentCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of yield adjustment." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/yieldCategories": { - "get": { - "description": "Use this API to get Yield Category.OperationId:getYieldCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28151,139 +24812,114 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/yieldCategories": { + "get": { "summary": "Get Yield Category", + "description": "Use this API to get Yield Category.OperationId:getYieldCategories
", "operationId": "getYieldCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { + "name": "yieldCategoriesCodes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "yieldCategoriesCodes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Yield Category configurations.", - "schema": { - "$ref": "#/definitions/yieldCategoriesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Yield Category configurations.", + "schema": { + "$ref": "#/definitions/yieldCategoriesDetails" } }, "204": { "description": "YieldCategories not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Yield Category.OperationId:postYieldCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28292,24 +24928,27 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Yield Category", + "description": "Use this API to create Yield Category.OperationId:postYieldCategories
", "operationId": "postYieldCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for creating new Yield Category Configurations.", "name": "yieldCategoriesCriteria", "in": "body", "required": true, + "description": "Request object for creating new Yield Category Configurations.", "schema": { "allOf": [ { @@ -28319,111 +24958,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/yieldCategories/{code}": { - "put": { - "description": "Use this API to update yield categories for a specific property based on code, hotelId, yieldCategoriesToBeChanged.OperationId:changeYieldCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28432,33 +25037,38 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/yieldCategories/{code}": { + "put": { "summary": "Change Yield Category", + "description": "Use this API to update Yield Category.OperationId:changeYieldCategories
", "operationId": "changeYieldCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of yield category.", "name": "code", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of yield category." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "description": "Request object for changing existing Yield Category Configurations.", "name": "yieldCategoriesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing existing Yield Category Configurations.", "schema": { "allOf": [ { @@ -28468,109 +25078,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete yield categories for a specific property based on code, hotelId.OperationId:removeYieldCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28579,134 +25157,103 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete Yield Category", + "description": "Use this API to delete Yield Category.OperationId:removeYieldCategories
", "operationId": "removeYieldCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of yield category.", "name": "code", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of yield category." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/yieldMarketTypes/{code}": { - "delete": { - "description": "Use this API to delete yield market types for a specific property based on code, hotelId.OperationId:removeYieldMarketTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28715,134 +25262,105 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{hotelId}/yieldMarketTypes/{code}": { + "delete": { "summary": "Delete Yield Market Types", + "description": "Use this API to delete Yield Market Types.OperationId:removeYieldMarketTypes
", "operationId": "removeYieldMarketTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Code of the YieldMarketType.", "name": "code", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code of the YieldMarketType." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of hotel.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{sourceHotelId}/departments/copy": { - "put": { - "description": "Copy Departments.OperationId:copyDepartments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28851,24 +25369,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{sourceHotelId}/departments/copy": { + "put": { "summary": " copy Departments", + "description": "Copy Departments.OperationId:copyDepartments
", "operationId": "copyDepartments", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of source hotel.", "name": "sourceHotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of source hotel." }, { - "description": "List of the departments to be copied.", "name": "copyDepartments", "in": "body", "required": true, + "description": "List of the departments to be copied.", "schema": { "allOf": [ { @@ -28878,111 +25401,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{sourceHotelId}/yieldAdjustmentCodes/copy": { - "put": { - "description": "Copy Yield Adjustment Codes.OperationId:copyYieldAdjustmentCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -28991,24 +25480,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{sourceHotelId}/yieldAdjustmentCodes/copy": { + "put": { "summary": " copy Yield Adjustment Codes", + "description": "Copy Yield Adjustment Codes.OperationId:copyYieldAdjustmentCodes
", "operationId": "copyYieldAdjustmentCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of source hotel.", "name": "sourceHotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of source hotel." }, { - "description": "List of the Yield AdjustmentCodes to be copied.", "name": "copyYieldAdjustmentCodes", "in": "body", "required": true, + "description": "List of the Yield AdjustmentCodes to be copied.", "schema": { "allOf": [ { @@ -29018,111 +25512,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{sourceHotelId}/yieldCategories/copy": { - "put": { - "description": "Copy Yield Category.OperationId:copyYieldCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29131,24 +25591,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/hotels/{sourceHotelId}/yieldCategories/copy": { + "put": { "summary": " copy Yield Category", + "description": "Copy Yield Category.OperationId:copyYieldCategories
", "operationId": "copyYieldCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of source hotel.", "name": "sourceHotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of source hotel." }, { - "description": "List of the Yield Category to be copied.", "name": "copyYieldCategories", "in": "body", "required": true, + "description": "List of the Yield Category to be copied.", "schema": { "allOf": [ { @@ -29158,111 +25623,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/jobTitles": { - "get": { - "description": "Use this API to get template job titles.OperationId:getTemplateJobTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29271,123 +25702,97 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/jobTitles": { + "get": { "summary": "Get template job titles", + "description": "Use this API to get template job titles.OperationId:getTemplateJobTitles
", "operationId": "getTemplateJobTitles", "parameters": [ { + "name": "jobTitleCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "jobTitleCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching template job titles.", - "schema": { - "$ref": "#/definitions/templateJobTitlesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 job titles.", + "schema": { + "$ref": "#/definitions/templateJobTitlesDetails" } }, "204": { "description": "TemplateJobTitles not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create new template job titles.OperationId:postTemplateJobTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29396,15 +25801,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create new template job titles", + "description": "Use this API to create new template job titles.OperationId:postTemplateJobTitles
", "operationId": "postTemplateJobTitles", "parameters": [ { - "description": "Request object for creating new template job titles.", "name": "templateJobTitlesCriteria", "in": "body", "required": true, + "description": "Request object for creating new template job titles.", "schema": { "allOf": [ { @@ -29414,111 +25822,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/jobTitles/{jobTitleCode}": { - "put": { - "description": "Use this API to update job title templates based on jobTitleCode, templateJobTitlesToBeChanged.OperationId:changeTemplateJobTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29527,24 +25901,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/jobTitles/{jobTitleCode}": { + "put": { "summary": "Change template job titles", + "description": "Use this API to update template job titles.OperationId:changeTemplateJobTitles
", "operationId": "changeTemplateJobTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Code for Job Title template.", "name": "jobTitleCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code for Job Title template." }, { - "description": "Request object for modifying template job titles.", "name": "templateJobTitlesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying template job titles.", "schema": { "allOf": [ { @@ -29554,109 +25933,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete job title templates based on jobTitleCode.OperationId:removeTemplateJobTitles
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29665,125 +26012,94 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete template job titles", + "description": "Use this API to delete template job titles.OperationId:removeTemplateJobTitles
", "operationId": "removeTemplateJobTitles", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Code for Job Title template.", "name": "jobTitleCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code for Job Title template." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/languages": { - "get": { - "description": "Use this API to get Languages.OperationId:getLanguages
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29792,135 +26108,111 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/languages": { + "get": { "summary": "Get Languages", + "description": "Use this API to get Languages.OperationId:getLanguages
", "operationId": "getLanguages", "parameters": [ { + "name": "languageCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "languageCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Language description to be searched.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Language description to be searched.", + "type": "string" }, { - "type": "boolean", - "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", "name": "useAsAlternateLanguage", - "in": "query" + "in": "query", + "required": false, + "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching languages.", - "schema": { - "$ref": "#/definitions/languagesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching languages.", + "schema": { + "$ref": "#/definitions/languagesDetails" } }, "204": { "description": "Languages not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Languages.OperationId:postLanguages
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -29929,15 +26221,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create Languages", + "description": "Use this API to create Languages.OperationId:postLanguages
", "operationId": "postLanguages", "parameters": [ { - "description": "Request object for creating new language records.", "name": "languagesCriteria", "in": "body", "required": true, + "description": "Request object for creating new language records.", "schema": { "allOf": [ { @@ -29947,111 +26242,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/languages/{languageCode}": { - "put": { - "description": "Use this API to update languages based on languageCode, languagesToBeChanged.OperationId:changeLanguages
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30060,24 +26321,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/languages/{languageCode}": { + "put": { "summary": "Update a Language", + "description": "Update a Language.OperationId:changeLanguages
", "operationId": "changeLanguages", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of language.", "name": "languageCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of language." }, { - "description": "Request object for changing details of existing language records.", "name": "languagesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing details of existing language records.", "schema": { "allOf": [ { @@ -30087,109 +26353,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete languages based on languageCode.OperationId:removeLanguages
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30198,125 +26432,94 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete a Language", + "description": "Use this API to delete a Language.OperationId:removeLanguages
", "operationId": "removeLanguages", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of language.", "name": "languageCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of language." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/marketingCities": { - "get": { - "description": "Use this API to get template marketing cities.OperationId:getTemplateMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30325,158 +26528,137 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/marketingCities": { + "get": { "summary": "Get template marketing cities", + "description": "Use this API to get template marketing cities.OperationId:getTemplateMarketingCities
", "operationId": "getTemplateMarketingCities", "parameters": [ { - "type": "boolean", - "description": "Flag to indicate whether to include inactive marketing cities in the results or not.", "name": "includeInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Flag to indicate whether to include inactive marketing cities in the results or not.", + "type": "boolean" }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "type": "integer", - "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.", "name": "pageNumber", - "in": "query" + "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": "marketingCitys", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "List of Marketing Cities.", - "name": "marketingCitys", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { + "name": "regionCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "regionCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Marketing city description to search for.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Marketing city description to search for.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching template marketing cities.", - "schema": { - "$ref": "#/definitions/templateMarketingCitiesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 marketing cities.", + "schema": { + "$ref": "#/definitions/templateMarketingCitiesDetails" } }, "204": { "description": "TemplateMarketingCities not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create new template marketing cities.OperationId:postTemplateMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30485,15 +26667,18 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "post": { "summary": "Create new template marketing cities", + "description": "Use this API to create new template marketing cities.OperationId:postTemplateMarketingCities
", "operationId": "postTemplateMarketingCities", "parameters": [ { - "description": "Request object for creating new template marketing cities.", "name": "templateMarketingCitiesCriteria", "in": "body", "required": true, + "description": "Request object for creating new template marketing cities.", "schema": { "allOf": [ { @@ -30503,111 +26688,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/marketingCities/copy": { - "put": { - "description": "Copy marketing cities to resorts.OperationId:copyMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30616,15 +26767,20 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/marketingCities/copy": { + "put": { "summary": "Copy marketing cities to resorts", + "description": "Copy marketing cities to resorts.OperationId:copyMarketingCities
", "operationId": "copyMarketingCities", "parameters": [ { - "description": "Request object for copying template marketing cities to hotel(s).", "name": "copyMarketingCities", "in": "body", "required": true, + "description": "Request object for copying template marketing cities to hotel(s).", "schema": { "allOf": [ { @@ -30634,111 +26790,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/marketingCities/{cityCode}": { - "put": { - "description": "Use this API to update marketing city templates based on cityCode, templateMarketingCitiesToBeChanged.OperationId:changeTemplateMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30747,24 +26869,29 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/marketingCities/{cityCode}": { + "put": { "summary": "Change template marketing cities", + "description": "Use this API to update template marketing cities.OperationId:changeTemplateMarketingCities
", "operationId": "changeTemplateMarketingCities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of city.", "name": "cityCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of city." }, { - "description": "Request object for modifying template marketing cities.", "name": "templateMarketingCitiesToBeChanged", "in": "body", "required": true, + "description": "Request object for modifying template marketing cities.", "schema": { "allOf": [ { @@ -30774,109 +26901,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete marketing city templates based on cityCode, regionCode.OperationId:removeTemplateMarketingCities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -30885,131 +26980,101 @@ ], "tags": [ "HotelConfig" - ], + ] + }, + "delete": { "summary": "Delete template marketing cities", + "description": "Use this API to delete template marketing cities.OperationId:removeTemplateMarketingCities
", "operationId": "removeTemplateMarketingCities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of city.", "name": "cityCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of city." }, { - "type": "string", - "description": "Region code the marketing city belongs to.", "name": "regionCode", - "in": "query" + "in": "query", + "required": false, + "description": "Region code the marketing city belongs to.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/marketingCitiesByRegion": { - "get": { - "description": "Use this API to get marketing cities by region.OperationId:getMarketingCitiesByRegion
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31017,128 +27082,101 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/marketingCitiesByRegion": { + "get": { "summary": "Get marketing cities by region", + "description": "Use this API to get marketing cities by region.OperationId:getMarketingCitiesByRegion
", "operationId": "getMarketingCitiesByRegion", "parameters": [ { - "type": "string", - "description": "Region Code", "name": "regionCode", - "in": "query" + "in": "query", + "required": false, + "description": "Region Code", + "type": "string" }, { - "type": "string", - "description": "Marketing City", "name": "marketingCity", - "in": "query" + "in": "query", + "required": false, + "description": "Marketing City", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "", - "schema": { - "$ref": "#/definitions/marketingCitiesByRegionDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "", + "schema": { + "$ref": "#/definitions/marketingCitiesByRegionDetails" } }, "204": { "description": "MarketingCitiesByRegion not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/marketingRegions": { - "get": { - "description": "Use this API to get Marketing Regions.OperationId:getMarketingRegions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31147,142 +27185,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/marketingRegions": { + "get": { "summary": "Get Marketing Regions", + "description": "Use this API to get Marketing Regions.OperationId:getMarketingRegions
", "operationId": "getMarketingRegions", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Marketing Regions.", - "schema": { - "$ref": "#/definitions/marketingRegionsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Marketing Regions.", + "schema": { + "$ref": "#/definitions/marketingRegionsDetails" } }, "204": { "description": "MarketingRegions not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Marketing Regions.OperationId:postMarketingRegions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31291,15 +27306,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Marketing Regions", + "description": "Use this API to create Marketing Regions.OperationId:postMarketingRegions
", "operationId": "postMarketingRegions", "parameters": [ { - "description": "Request object for creating Marketing Regions.", "name": "marketingRegionsCriteria", "in": "body", "required": true, + "description": "Request object for creating Marketing Regions.", "schema": { "allOf": [ { @@ -31309,111 +27327,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/marketingRegions/{marketingRegionCode}": { - "put": { - "description": "Use this API to update Marketing Regions.OperationId:putMarketingRegions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31422,24 +27406,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/marketingRegions/{marketingRegionCode}": { + "put": { "summary": "Change Marketing Regions", + "description": "Use this API to update Marketing Regions.OperationId:putMarketingRegions
", "operationId": "putMarketingRegions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Marketing Regions.", "name": "marketingRegionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Marketing Regions." }, { - "description": "Request object for changing Marketing Regions.", "name": "marketingRegionsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Marketing Regions.", "schema": { "allOf": [ { @@ -31449,109 +27438,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Marketing Regions.OperationId:deleteMarketingRegions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31560,135 +27517,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Marketing Regions", + "description": "Use this API to delete Marketing Regions.OperationId:deleteMarketingRegions
", "operationId": "deleteMarketingRegions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Marketing Regions.", "name": "marketingRegionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Marketing Regions." }, { + "name": "marketingRegionsCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "marketingRegionsCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/noteTypes": { - "get": { - "description": "Use this API to get Note Types.OperationId:getNoteTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31697,147 +27624,125 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/noteTypes": { + "get": { "summary": "Get Note Types", + "description": "Use this API to get Note Types.OperationId:getNoteTypes
", "operationId": "getNoteTypes", "parameters": [ { - "type": "string", - "description": "Notes Group added to the search criteria.", "name": "noteGroup", - "in": "query" + "in": "query", + "required": false, + "description": "Notes Group added to the search criteria.", + "type": "string" }, { - "type": "boolean", - "description": "If true this boolean will set the criteria to only return Inactive records.", "name": "includeInactive", - "in": "query" + "in": "query", + "required": false, + "description": "If true this boolean will set the criteria to only return Inactive records.", + "type": "boolean" }, { - "type": "boolean", - "description": "Boolean flag to fetch note types with/without departments. 'True' indicates including departments information for corresponding note types.", "name": "includeDepartmentDetails", - "in": "query" + "in": "query", + "required": false, + "description": "Boolean flag to fetch note types with/without departments. 'True' indicates including departments information for corresponding note types.", + "type": "boolean" }, { - "type": "string", - "description": "Code of the Note Type.", "name": "noteCode", - "in": "query" + "in": "query", + "required": false, + "description": "Code of the Note Type.", + "type": "string" }, { + "name": "codes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "codes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Note Types of specific Notes Group.", - "schema": { - "$ref": "#/definitions/noteTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Note Types of specific Notes Group.", + "schema": { + "$ref": "#/definitions/noteTypesDetails" } }, "204": { "description": "NoteTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Note Types.OperationId:postNoteTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31846,15 +27751,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Note Types", + "description": "Use this API to create Note Types.OperationId:postNoteTypes
", "operationId": "postNoteTypes", "parameters": [ { - "description": "Request object for creating new Note Types.", "name": "noteTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating new Note Types.", "schema": { "allOf": [ { @@ -31864,111 +27772,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/noteTypes/{noteTypeCode}": { - "put": { - "description": "Use this API to update note types based on noteTypeCode, noteTypesToBeChanged.OperationId:changeNoteTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -31977,24 +27851,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/noteTypes/{noteTypeCode}": { + "put": { "summary": "Change Note Types", + "description": "Use this API to update Note Types.OperationId:changeNoteTypes
", "operationId": "changeNoteTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Note Types.", "name": "noteTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Note Types." }, { - "description": "Request object for changing existing Note Types.", "name": "noteTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing existing Note Types.", "schema": { "allOf": [ { @@ -32004,109 +27883,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete note types based on noteTypeCode, noteGroup.OperationId:removeNoteTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -32115,131 +27962,101 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Note Types", + "description": "Use this API to delete Note Types.OperationId:removeNoteTypes
", "operationId": "removeNoteTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Note Types.", "name": "noteTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Note Types." }, { - "type": "string", - "description": "Notes Group of the Note Types code.", "name": "noteGroup", - "in": "query" + "in": "query", + "required": false, + "description": "Notes Group of the Note Types code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/notes/{noteCode}": { - "delete": { - "description": "Use this API to delete note information based on noteCode.OperationId:removeHotelNotes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -32247,126 +28064,97 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], + "ChainConfig" + ] + } + }, + "/notes/{noteCode}": { + "delete": { "summary": "Delete Note information", + "description": "Use this API to delete Note information.OperationId:removeHotelNotes
", "operationId": "removeHotelNotes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of note.", "name": "noteCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of note." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/parameters": { - "get": { - "description": "Use this API to get OPERA Parameters.OperationId:getOperaParameters
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -32375,125 +28163,97 @@ ], "tags": [ "HotelConfig" - ], + ] + } + }, + "/parameters": { + "get": { "summary": "Get OPERA Parameters", + "description": "Use this API to get OPERA Parameters.OperationId:getOperaParameters
", "operationId": "getOperaParameters", "parameters": [ { + "name": "parameterName", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used for Character Strings, length 0 to 80.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used for Character Strings, length 0 to 80.", - "name": "parameterName", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "The result element containing a collection of the requested application parameters.", - "schema": { - "$ref": "#/definitions/operaParametersDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "The result element containing a collection of the requested application parameters.", + "schema": { + "$ref": "#/definitions/operaParametersDetails" } }, "204": { "description": "OperaParameters not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/propertyDetailsCategories": { - "get": { - "description": "Use this API to get Property Detail Categories.OperationId:getPropertyDetailCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -32501,143 +28261,120 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], + "HotelConfig" + ] + } + }, + "/propertyDetailsCategories": { + "get": { "summary": "Get Property Detail Categories", + "description": "Use this API to get Property Detail Categories.OperationId:getPropertyDetailCategories
", "operationId": "getPropertyDetailCategories", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Property Detail Categories.", - "schema": { - "$ref": "#/definitions/propertyDetailCategoriesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Property Detail Categories.", + "schema": { + "$ref": "#/definitions/propertyDetailCategoriesDetails" } }, "204": { "description": "PropertyDetailCategories not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Property Detail Categories.OperationId:postPropertyDetailCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -32646,15 +28383,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Property Detail Categories", + "description": "Use this API to create Property Detail Categories.OperationId:postPropertyDetailCategories
", "operationId": "postPropertyDetailCategories", "parameters": [ { - "description": "Request object for creating Property Detail Categories.", "name": "propertyDetailCategoriesCriteria", "in": "body", "required": true, + "description": "Request object for creating Property Detail Categories.", "schema": { "allOf": [ { @@ -32664,111 +28404,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/propertyDetailsCategories/{categoryCode}": { - "put": { - "description": "Use this API to update property detail categories based on categoryCode, propertyDetailCategoriesToBeChanged.OperationId:changePropertyDetailCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -32777,24 +28483,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/propertyDetailsCategories/{categoryCode}": { + "put": { "summary": "Change Property Detail Categories", + "description": "Use this API to update Property Detail Categories.OperationId:changePropertyDetailCategories
", "operationId": "changePropertyDetailCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Categories.", "name": "categoryCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Categories." }, { - "description": "Request object for changing Property Detail Categories.", "name": "propertyDetailCategoriesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Property Detail Categories.", "schema": { "allOf": [ { @@ -32804,109 +28515,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete property detail categories based on categoryCode, propertyDetailCategoriesCodes.OperationId:removePropertyDetailCategories
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -32915,135 +28594,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Property Detail Categories", + "description": "Use this API to delete Property Detail Categories.OperationId:removePropertyDetailCategories
", "operationId": "removePropertyDetailCategories", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Categories.", "name": "categoryCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Categories." }, { + "name": "propertyDetailCategoriesCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "propertyDetailCategoriesCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/propertyTypes": { - "get": { - "description": "Use this API to get Property Types based on search criteria such as codes, wildCard, description. Property types are used for different hotel types i.e. Resort, Business, CityCenter, Motel, BedAndBreakfast.OperationId:getPropertyTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -33052,142 +28701,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/propertyTypes": { + "get": { "summary": "Get property types", + "description": "Use this API to get Property Types based on search criteria such as codes, wildCard, description. Property types are used for different hotel types i.e. Resort, Business, CityCenter, Motel, BedAndBreakfast.OperationId:getPropertyTypes
", "operationId": "getPropertyTypes", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Property Types.", - "schema": { - "$ref": "#/definitions/propertyTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Property Types.", + "schema": { + "$ref": "#/definitions/propertyTypesDetails" } }, "204": { "description": "PropertyTypes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Property Types.OperationId:postPropertyTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -33196,15 +28822,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Property Types", + "description": "Use this API to create Property Types.OperationId:postPropertyTypes
", "operationId": "postPropertyTypes", "parameters": [ { - "description": "Request object for creating Property Types.", "name": "propertyTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating Property Types.", "schema": { "allOf": [ { @@ -33214,111 +28843,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/propertyTypes/{propertyTypeCode}": { - "put": { - "description": "Use this API to update Property Types.OperationId:putPropertyTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -33327,24 +28922,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/propertyTypes/{propertyTypeCode}": { + "put": { "summary": "Change Property Types", + "description": "Use this API to update Property Types.OperationId:putPropertyTypes
", "operationId": "putPropertyTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Property Types.", "name": "propertyTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Property Types." }, { - "description": "Request object for changing Property Types.", "name": "propertyTypesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Property Types.", "schema": { "allOf": [ { @@ -33354,109 +28954,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Property Types.OperationId:deletePropertyTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -33465,135 +29033,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Property Types", + "description": "Use this API to delete Property Types.OperationId:deletePropertyTypes
", "operationId": "deletePropertyTypes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Property Types.", "name": "propertyTypeCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Property Types." }, { + "name": "propertyTypesCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "propertyTypesCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/regionCode": { - "get": { - "description": "Use this API to return region codes based on search criteria such as fetchInactive, codes, wildCard, description.OperationId:getRegionsCode
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -33602,142 +29140,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/regionCode": { + "get": { "summary": "Get Regions Code", + "description": "Use this API to get Regions Code.OperationId:getRegionsCode
", "operationId": "getRegionsCode", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Regions Code.", - "schema": { - "$ref": "#/definitions/regionsCodeDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Regions Code.", + "schema": { + "$ref": "#/definitions/regionsCodeDetails" } }, "204": { "description": "RegionsCode not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create region codes.OperationId:postRegionsCode
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -33746,15 +29261,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Regions Code", + "description": "Use this API to create Regions Code.OperationId:postRegionsCode
", "operationId": "postRegionsCode", "parameters": [ { - "description": "Request object for creating Regions Code.", "name": "regionsCodeCriteria", "in": "body", "required": true, + "description": "Request object for creating Regions Code.", "schema": { "allOf": [ { @@ -33764,111 +29282,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/regionCode/{regionCode}": { - "put": { - "description": "Use this API to update region codes based on regionCode, regionsCodeToBeChanged.OperationId:changeRegionsCode
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -33877,24 +29361,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/regionCode/{regionCode}": { + "put": { "summary": "Change Regions Code", + "description": "Use this API to update Regions Code.OperationId:changeRegionsCode
", "operationId": "changeRegionsCode", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Regions.", "name": "regionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Regions." }, { - "description": "Request object for changing Regions Code.", "name": "regionsCodeToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Regions Code.", "schema": { "allOf": [ { @@ -33904,109 +29393,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete region codes based on regionCode.OperationId:removeRegionsCode
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -34015,125 +29472,94 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Regions Code", + "description": "Use this API to delete Regions Code.OperationId:removeRegionsCode
", "operationId": "removeRegionsCode", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Regions.", "name": "regionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Regions." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/roomAmenities": { - "get": { - "description": "Use this API to get Room Amenities.OperationId:getRoomAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -34142,142 +29568,119 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/roomAmenities": { + "get": { "summary": "Get Room Amenities", + "description": "Use this API to get Room Amenities.OperationId:getRoomAmenities
", "operationId": "getRoomAmenities", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", "name": "fetchInactive", - "in": "query" + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { + "name": "codes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Codes to be searched.", - "name": "codes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Wildcard search on the code.", "name": "wildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Description of the code.", "name": "description", - "in": "query" + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Room Amenities.", - "schema": { - "$ref": "#/definitions/roomAmenitiesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching Room Amenities.", + "schema": { + "$ref": "#/definitions/roomAmenitiesDetails" } }, "204": { "description": "RoomAmenities not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Room Amenities.OperationId:postRoomAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -34286,15 +29689,18 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "post": { "summary": "Create Room Amenities", + "description": "Use this API to create Room Amenities.OperationId:postRoomAmenities
", "operationId": "postRoomAmenities", "parameters": [ { - "description": "Request object for creating Room Amenities.", "name": "roomAmenitiesCriteria", "in": "body", "required": true, + "description": "Request object for creating Room Amenities.", "schema": { "allOf": [ { @@ -34304,111 +29710,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/roomAmenities/{roomAmenitiesId}": { - "put": { - "description": "Use this API to update Room Amenities.OperationId:putRoomAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -34417,24 +29789,29 @@ ], "tags": [ "ChainConfig" - ], + ] + } + }, + "/roomAmenities/{roomAmenitiesId}": { + "put": { "summary": "Change Room Amenities", + "description": "Use this API to update Room Amenities.OperationId:putRoomAmenities
", "operationId": "putRoomAmenities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Room Amenities.", "name": "roomAmenitiesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Room Amenities." }, { - "description": "Request object for changing Room Amenities.", "name": "roomAmenitiesToBeChanged", "in": "body", "required": true, + "description": "Request object for changing Room Amenities.", "schema": { "allOf": [ { @@ -34444,109 +29821,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete Room Amenities.OperationId:deleteRoomAmenities
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -34555,135 +29900,105 @@ ], "tags": [ "ChainConfig" - ], + ] + }, + "delete": { "summary": "Delete Room Amenities", + "description": "Use this API to delete Room Amenities.OperationId:deleteRoomAmenities
", "operationId": "deleteRoomAmenities", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of Room Amenities.", "name": "roomAmenitiesId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Room Amenities." }, { + "name": "roomAmenitiesCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "roomAmenitiesCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/settings": { - "get": { - "description": "Use this API to return OPERA controls based on search criteria such as hotelId, cROCode, parameterNameWildCard.OperationId:getOperaSettings
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -34691,131 +30006,88 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], - "summary": "Get OPERA controls", - "operationId": "getOperaSettings", + "ChainConfig" + ] + } + }, + "/services/chainConfig/cache": { + "delete": { + "summary": " clear cache", + "description": "clearCacheOperationId:deleteChainConfigServicesCache
", + "operationId": "deleteChainConfigServicesCache", "parameters": [ { - "type": "string", - "name": "hotelId", - "in": "query" - }, - { - "type": "string", - "name": "cROCode", - "in": "query" - }, - { - "type": "string", - "name": "parameterNameWildCard", - "in": "query" - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "The result element containing the requested application settings.", - "schema": { - "$ref": "#/definitions/operaSettingsDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "OperaSettings not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/telephoneBookEntries/{entryId}": { - "delete": { - "description": "Use this API to delete telephone book entries.OperationId:removeTelephoneBookEntriesWithoutHotelId
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -34823,136 +30095,87 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], - "summary": "Delete Telephone Book Entries", - "operationId": "removeTelephoneBookEntriesWithoutHotelId", + "ChainConfig" + ] + } + }, + "/services/chainConfig/status": { + "get": { + "summary": " ping", + "description": "NAOperationId:pingChainConfigServices
", + "operationId": "pingChainConfigServices", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of entry.", - "name": "entryId", - "in": "path", - "required": true - }, - { - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "idContext", - "in": "query" - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" - }, - "Location": { - "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response for Ping operation.", + "schema": { + "$ref": "#/definitions/operaVersion" } }, + "204": { + "description": "pingChainConfigServices not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/templateCodes": { - "get": { - "description": " Use this API to get Template Codes.OperationId:getTemplateCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -34961,142 +30184,87 @@ ], "tags": [ "ChainConfig" - ], - "summary": " Get Template Codes", - "operationId": "getTemplateCodes", + ] + } + }, + "/services/externalConfig/cache": { + "delete": { + "summary": " clear cache", + "description": "clearCacheOperationId:deleteExternalConfigServicesCache
", + "operationId": "deleteExternalConfigServicesCache", "parameters": [ { - "type": "boolean", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" - }, - { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Template Codes.", - "schema": { - "$ref": "#/definitions/templateCodesDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "TemplateCodes not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create Template Codes.OperationId:postTemplateCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -35104,130 +30272,87 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create Template Codes", - "operationId": "postTemplateCodes", + "ExternalConfig" + ] + } + }, + "/services/externalConfig/status": { + "get": { + "summary": " ping", + "description": "NAOperationId:pingExternalConfigServices
", + "operationId": "pingExternalConfigServices", "parameters": [ { - "description": "Request object for creating Template Codes.", - "name": "templateCodesCriteria", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/templateCodesCriteria" - } - ] - } - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "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": "pingExternalConfigServices not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/templateCodes/copy": { - "put": { - "description": "This API is used to Copy a Template Rate Category in order to create a new Template Rate Category.OperationId:copyTemplateCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -35235,129 +30360,88 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], - "summary": "Copy Template Codes", - "operationId": "copyTemplateCodes", + "ExternalConfig" + ] + } + }, + "/services/hotelConfig/cache": { + "delete": { + "summary": " clear cache", + "description": "clearCacheOperationId:deleteHotelConfigServicesCache
", + "operationId": "deleteHotelConfigServicesCache", "parameters": [ { - "name": "copyTemplateCodes", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/copyTemplateCodes" - } - ] - } - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/templateCodes/{code}": { - "put": { - "description": "Use this API to update template codes based on code, templateCodesToBeChanged.OperationId:changeTemplateCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -35365,137 +30449,87 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change Template Codes", - "operationId": "changeTemplateCodes", + "HotelConfig" + ] + } + }, + "/services/hotelConfig/status": { + "get": { + "summary": " ping", + "description": "NAOperationId:pingHotelConfigServices
", + "operationId": "pingHotelConfigServices", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Template.", - "name": "code", - "in": "path", - "required": true - }, - { - "description": "Request object for changing Template Codes.", - "name": "templateCodesToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/templateCodesToBeChanged" - } - ] - } - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "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": "pingHotelConfigServices not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete template codes based on code, templateCodes.OperationId:removeTemplateCodes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -35503,136 +30537,111 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete Template Codes", - "operationId": "removeTemplateCodes", + "HotelConfig" + ] + } + }, + "/settings": { + "get": { + "summary": "Get OPERA controls", + "description": "Use this API to return OPERA controls based on search criteria such as hotelId, cROCode, parameterNameWildCard.OperationId:getOperaSettings
", + "operationId": "getOperaSettings", "parameters": [ { + "name": "hotelId", + "in": "query", + "required": false, + "description": "Unique ID of hotel.", "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of Template.", - "name": "code", - "in": "path", - "required": true + "type": "string" }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "templateCodes", - "in": "query" + "name": "cROCode", + "in": "query", + "required": false, + "description": "This is the Central Reservation office code.", + "maxLength": 200, + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "parameterNameWildCard", + "in": "query", + "required": false, + "description": "Wildcard search parameter.", + "maxLength": 4000, + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "The result element containing the requested application settings.", + "schema": { + "$ref": "#/definitions/operaSettingsDetails" } }, + "204": { + "description": "OperaSettings not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/transportations": { - "get": { - "description": "Use this API to get transportation templates.OperationId:getTransportationTemplates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -35641,130 +30650,107 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Get transportation templates", - "operationId": "getTransportationTemplates", + ] + } + }, + "/telephoneBookEntries/{entryId}": { + "delete": { + "summary": "Delete Telephone Book Entries", + "description": "Use this API to delete Telephone Book Entries.OperationId:removeTelephoneBookEntriesWithoutHotelId
", + "operationId": "removeTelephoneBookEntriesWithoutHotelId", "parameters": [ { + "name": "entryId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of entry." + }, + { + "name": "idContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { - "maxItems": 4000, "type": "string" }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "transportationCodes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching transportation templates.", - "schema": { - "$ref": "#/definitions/transportationTemplatesDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "TransportationTemplates not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create transportation templates.OperationId:postTransportationTemplates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -35773,129 +30759,119 @@ ], "tags": [ "HotelConfig" - ], - "summary": "Create transportation templates", - "operationId": "postTransportationTemplates", + ] + } + }, + "/templateCodes": { + "get": { + "summary": " Get Template Codes", + "description": " Use this API to get Template Codes.OperationId:getTemplateCodes
", + "operationId": "getTemplateCodes", "parameters": [ { - "description": "Request object for creating transportation templates.", - "name": "transportationTemplatesCriteria", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/transportationTemplatesCriteria" - } - ] - } + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "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 Codes.", + "schema": { + "$ref": "#/definitions/templateCodesDetails" } }, + "204": { + "description": "TemplateCodes not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/transportations/{transportationCode}": { - "put": { - "description": "Use this API to update transportation templates based on transportationCode, transportationTemplatesToBeChanged.OperationId:changeTransportationTemplates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -35903,137 +30879,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], - "summary": "Change transportation templates", - "operationId": "changeTransportationTemplates", + "ChainConfig" + ] + }, + "post": { + "summary": "Create Template Codes", + "description": "Use this API to create Template Codes.OperationId:postTemplateCodes
", + "operationId": "postTemplateCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of transportation.", - "name": "transportationCode", - "in": "path", - "required": true - }, - { - "description": "Request object for modifying transportation templates.", - "name": "transportationTemplatesToBeChanged", + "name": "templateCodesCriteria", "in": "body", "required": true, + "description": "Request object for creating Template Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/transportationTemplatesToBeChanged" + "$ref": "#/definitions/templateCodesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete transportation templates based on transportationCode.OperationId:removeTransportationTemplates
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -36041,126 +30979,100 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], - "summary": "Delete transportation templates", - "operationId": "removeTransportationTemplates", + "ChainConfig" + ] + } + }, + "/templateCodes/copy": { + "put": { + "summary": "Copy Template Codes", + "description": "This API is used to Copy a Template Rate Category in order to create a new Template Rate Category.OperationId:copyTemplateCodes
", + "operationId": "copyTemplateCodes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of transportation.", - "name": "transportationCode", - "in": "path", - "required": true + "name": "copyTemplateCodes", + "in": "body", + "required": true, + "schema": { + "allOf": [ + { + "$ref": "#/definitions/copyTemplateCodes" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/userDefinedFieldGroups": { - "get": { - "description": "Use this API to get User Defined Field Groups.OperationId:getUserDefinedFieldGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -36168,131 +31080,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get User Defined Field Groups", - "operationId": "getUserDefinedFieldGroups", + "HotelConfig" + ] + } + }, + "/templateCodes/{code}": { + "put": { + "summary": "Change Template Codes", + "description": "Use this API to update Template Codes.OperationId:changeTemplateCodes
", + "operationId": "changeTemplateCodes", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Identifier for the User Defined Field Group", - "name": "groupCodes", - "in": "query" + "name": "code", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Template." }, { - "type": "string", - "description": "Specifies the user defined field description to search.", - "name": "descriptionWildCard", - "in": "query" + "name": "templateCodesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing Template Codes.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/templateCodesToBeChanged" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching User Defined Field Groups.", - "schema": { - "$ref": "#/definitions/userDefinedFieldGroupsDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "UserDefinedFieldGroups not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create User Defined Field Groups.OperationId:postUserDefinedFieldGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -36301,129 +31192,105 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create User Defined Field Groups", - "operationId": "postUserDefinedFieldGroups", + ] + }, + "delete": { + "summary": "Delete Template Codes", + "description": "Use this API to delete Template Codes.OperationId:removeTemplateCodes
", + "operationId": "removeTemplateCodes", "parameters": [ { - "description": "Request object for creating User Defined Field Groups.", - "name": "userDefinedFieldGroupsCriteria", - "in": "body", + "name": "code", + "in": "path", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/userDefinedFieldGroupsCriteria" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of Template." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "templateCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/userDefinedFieldGroups/{udfGroupCode}": { - "put": { - "description": "Use this API to update user defined field groups based on udfGroupCode, userDefinedFieldGroupsToBeChanged.OperationId:changeUserDefinedFieldGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -36432,136 +31299,105 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change User Defined Field Groups", - "operationId": "changeUserDefinedFieldGroups", + ] + } + }, + "/transportations": { + "get": { + "summary": "Get transportation templates", + "description": "Use this API to get transportation templates.OperationId:getTransportationTemplates
", + "operationId": "getTransportationTemplates", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of User Defined Field Groups.", - "name": "udfGroupCode", - "in": "path", - "required": true + "name": "transportationCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "description": "Request object for changing User Defined Field Groups.", - "name": "userDefinedFieldGroupsToBeChanged", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/userDefinedFieldGroupsToBeChanged" - } - ] - } + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching transportation templates.", + "schema": { + "$ref": "#/definitions/transportationTemplatesDetails" } }, + "204": { + "description": "TransportationTemplates not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete user defined field groups based on udfGroupCode.OperationId:removeUserDefinedFieldGroups
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -36569,126 +31405,210 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete User Defined Field Groups", - "operationId": "removeUserDefinedFieldGroups", + "HotelConfig" + ] + }, + "post": { + "summary": "Create transportation templates", + "description": "Use this API to create transportation templates.OperationId:postTransportationTemplates
", + "operationId": "postTransportationTemplates", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Code of User Defined Field Groups.", - "name": "udfGroupCode", - "in": "path", - "required": true + "name": "transportationTemplatesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating transportation templates.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/transportationTemplatesCriteria" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { + "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" + ] + } + }, + "/transportations/{transportationCode}": { + "put": { + "summary": "Change transportation templates", + "description": "Use this API to update transportation templates.OperationId:changeTransportationTemplates
", + "operationId": "changeTransportationTemplates", + "parameters": [ + { + "name": "transportationCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of transportation." + }, + { + "name": "transportationTemplatesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for modifying transportation templates.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/transportationTemplatesToBeChanged" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/userDefinedFieldValues": { - "get": { - "description": "Use this API to return User Defined Field (UDF) Values based on search criteria such as groupCode, valueCode, descriptionWildCard. The LOV Group and LOV Values functionality allows a property to create a custom group of values to be used in a specified user defined field (UDF). This functionality provides added flexibility in allowing a site to track information or details that are specific to their business and outside of the standard fields offered in OPERA Cloud.OperationId:getUserDefinedFieldValues
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -36696,136 +31616,202 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get user defined field (UDF) values", - "operationId": "getUserDefinedFieldValues", + "HotelConfig" + ] + }, + "delete": { + "summary": "Delete transportation templates", + "description": "Use this API to delete transportation templates.OperationId:removeTransportationTemplates
", + "operationId": "removeTransportationTemplates", "parameters": [ { + "name": "transportationCode", + "in": "path", + "required": true, "type": "string", - "description": "The Group Code which the User Defined Field Value belongs to.", - "name": "groupCode", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of transportation." + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + ] + } + }, + "/userDefinedFieldGroups": { + "get": { + "summary": "Get User Defined Field Groups", + "description": "Use this API to get User Defined Field Groups.OperationId:getUserDefinedFieldGroups
", + "operationId": "getUserDefinedFieldGroups", + "parameters": [ { + "name": "groupCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Identifier for the User Defined Field Group", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "valueCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Specifies the User Defined Field Value description to search.", "name": "descriptionWildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Specifies the user defined field description to search.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching User Defined Field Values.", - "schema": { - "$ref": "#/definitions/userDefinedFieldValuesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching User Defined Field Groups.", + "schema": { + "$ref": "#/definitions/userDefinedFieldGroupsDetails" } }, "204": { - "description": "UserDefinedFieldValues not found." + "description": "UserDefinedFieldGroups not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create a new User Defined Field (UDF) Value. The LOV Group and LOV Values functionality allows a property create a custom group of values to be used in a specified user defined field (UDF). This functionality provides added flexibility in allowing a site to track information or details that are specific to their business and outside of the standard fields offered in the OPERA Cloud.OperationId:postUserDefinedFieldValues
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -36834,129 +31820,98 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Create User Defined Field (UDF) Values", - "operationId": "postUserDefinedFieldValues", + ] + }, + "post": { + "summary": "Create User Defined Field Groups", + "description": "Use this API to create User Defined Field Groups.OperationId:postUserDefinedFieldGroups
", + "operationId": "postUserDefinedFieldGroups", "parameters": [ { - "description": "Request object for creating User Defined Field Values.", - "name": "userDefinedFieldValuesCriteria", + "name": "userDefinedFieldGroupsCriteria", "in": "body", "required": true, + "description": "Request object for creating User Defined Field Groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/userDefinedFieldValuesCriteria" + "$ref": "#/definitions/userDefinedFieldGroupsCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/userDefinedFieldValues/{udfValue}": { - "put": { - "description": "Use this API to update user defined field values based on udfValue, userDefinedFieldValuesToBeChanged. The LOV group and LOV values functionality allows a property create a custom group of values to be used in a specified user defined field (UDF). This functionality provides added flexibility in allowing a site to track information or details that are specific to their business and outside of the standard fields offered in the OPERA Cloud.OperationId:changeUserDefinedFieldValues
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -36965,136 +31920,109 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Change a User Defined Field Value ", - "operationId": "changeUserDefinedFieldValues", + ] + } + }, + "/userDefinedFieldGroups/{udfGroupCode}": { + "put": { + "summary": "Change User Defined Field Groups", + "description": "Use this API to update User Defined Field Groups.OperationId:changeUserDefinedFieldGroups
", + "operationId": "changeUserDefinedFieldGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Value of User Defined Field.", - "name": "udfValue", + "name": "udfGroupCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of User Defined Field Groups." }, { - "description": "Request object for changing User Defined Field Values.", - "name": "userDefinedFieldValuesToBeChanged", + "name": "userDefinedFieldGroupsToBeChanged", "in": "body", "required": true, + "description": "Request object for changing User Defined Field Groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/userDefinedFieldValuesToBeChanged" + "$ref": "#/definitions/userDefinedFieldGroupsToBeChanged" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete user defined field values based on udfValue, groupCode. The LOV group and LOV values functionality allows a property create a custom group of values to be used in a specified user defined field (UDF). This functionality provides added flexibility in allowing a site to track information or details that are specific to their business and outside of the standard fields offered in the OPERA Cloud.OperationId:removeUserDefinedFieldValues
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -37103,131 +32031,94 @@ ], "tags": [ "ChainConfig" - ], - "summary": "Delete a User Defined Field Value ", - "operationId": "removeUserDefinedFieldValues", + ] + }, + "delete": { + "summary": "Delete User Defined Field Groups", + "description": "Use this API to delete User Defined Field Groups.OperationId:removeUserDefinedFieldGroups
", + "operationId": "removeUserDefinedFieldGroups", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Value of User Defined Field.", - "name": "udfValue", + "name": "udfGroupCode", "in": "path", - "required": true - }, - { + "required": true, "type": "string", - "description": "The Group Code which the User Defined Field Value belongs to.", - "name": "groupCode", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of User Defined Field Groups." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/yieldMarketTypes": { - "get": { - "description": "Use this API to get Yield Market Types.OperationId:getYieldMarketTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -37235,137 +32126,112 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], - "summary": "Get Yield Market Types", - "operationId": "getYieldMarketTypes", + "ChainConfig" + ] + } + }, + "/userDefinedFieldValues": { + "get": { + "summary": "Get user defined field (UDF) values", + "description": "Use this API to return User Defined Field (UDF) Values based on search criteria such as groupCode, valueCode, descriptionWildCard. The LOV Group and LOV Values functionality allows a property to create a custom group of values to be used in a specified user defined field (UDF). This functionality provides added flexibility in allowing a site to track information or details that are specific to their business and outside of the standard fields offered in OPERA Cloud.OperationId:getUserDefinedFieldValues
", + "operationId": "getUserDefinedFieldValues", "parameters": [ { + "name": "groupCode", + "in": "query", + "required": false, + "description": "The Group Code which the User Defined Field Value belongs to.", + "type": "string" + }, + { + "name": "valueCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "yieldMarketTypesCodes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" + "required": false }, { - "type": "string", - "description": "Hotel Codes criteria for which the yield market type belong to.", - "name": "hotelId", - "in": "query" + "name": "descriptionWildCard", + "in": "query", + "required": false, + "description": "Specifies the User Defined Field Value description to search.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching Yield Market Types.", - "schema": { - "$ref": "#/definitions/yieldMarketTypesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching User Defined Field Values.", + "schema": { + "$ref": "#/definitions/userDefinedFieldValuesDetails" } }, "204": { - "description": "YieldMarketTypes not found." + "description": "UserDefinedFieldValues not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to update yield market types based on yieldMarketTypesToBeChanged.OperationId:changeYieldMarketTypes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -37373,128 +32239,313 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" - ], - "summary": "Change Yield Market Types", - "operationId": "changeYieldMarketTypes", + "ChainConfig" + ] + }, + "post": { + "summary": "Create User Defined Field (UDF) Values", + "description": "Use this API to create a new User Defined Field (UDF) Value. The LOV Group and LOV Values functionality allows a property create a custom group of values to be used in a specified user defined field (UDF). This functionality provides added flexibility in allowing a site to track information or details that are specific to their business and outside of the standard fields offered in the OPERA Cloud.OperationId:postUserDefinedFieldValues
", + "operationId": "postUserDefinedFieldValues", "parameters": [ { - "description": "Request object for changing existing Yield Market Types.", - "name": "yieldMarketTypesToBeChanged", + "name": "userDefinedFieldValuesCriteria", "in": "body", "required": true, + "description": "Request object for creating User Defined Field Values.", "schema": { "allOf": [ { - "$ref": "#/definitions/yieldMarketTypesToBeChanged" + "$ref": "#/definitions/userDefinedFieldValuesCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", + "$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" + ] + } + }, + "/userDefinedFieldValues/{udfValue}": { + "put": { + "summary": "Change a User Defined Field Value ", + "description": "Use this API to modify a User Defined Field Value.OperationId:changeUserDefinedFieldValues
", + "operationId": "changeUserDefinedFieldValues", + "parameters": [ + { + "name": "udfValue", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Value of User Defined Field." + }, + { + "name": "userDefinedFieldValuesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing User Defined Field Values.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/userDefinedFieldValuesToBeChanged" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$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": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ChainConfig" + ] }, - "post": { - "description": "Use this API to create Yield Market Types.OperationId:postYieldMarketTypes
", + "delete": { + "summary": "Delete a User Defined Field Value ", + "description": "Use this API to delete a User Defined Field Value.OperationId:removeUserDefinedFieldValues
", + "operationId": "removeUserDefinedFieldValues", + "parameters": [ + { + "name": "udfValue", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Value of User Defined Field." + }, + { + "name": "groupCode", + "in": "query", + "required": false, + "description": "The Group Code which the User Defined Field Value belongs to.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" ], @@ -37502,16 +32553,133 @@ "application/json;charset=UTF-8" ], "tags": [ - "HotelConfig" + "ChainConfig" + ] + } + }, + "/yieldMarketTypes": { + "get": { + "summary": "Get Yield Market Types", + "description": "Use this API to get Yield Market Types.OperationId:getYieldMarketTypes
", + "operationId": "getYieldMarketTypes", + "parameters": [ + { + "name": "yieldMarketTypesCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" + }, + { + "name": "hotelId", + "in": "query", + "required": false, + "description": "Hotel Codes criteria for which the yield market type belong to.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 Yield Market Types.", + "schema": { + "$ref": "#/definitions/yieldMarketTypesDetails" + } + }, + "204": { + "description": "YieldMarketTypes 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 Yield Market Types", + "description": "Use this API to create Yield Market Types.OperationId:postYieldMarketTypes
", "operationId": "postYieldMarketTypes", "parameters": [ { - "description": "Request object for creating new Yield Market Types.", "name": "yieldMarketTypesCriteria", "in": "body", "required": true, + "description": "Request object for creating new Yield Market Types.", "schema": { "allOf": [ { @@ -37521,548 +32689,730 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$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 Yield Market Types", + "description": "Use this API to update Yield Market Types.OperationId:changeYieldMarketTypes
", + "operationId": "changeYieldMarketTypes", + "parameters": [ + { + "name": "yieldMarketTypesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing existing Yield Market Types.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/yieldMarketTypesToBeChanged" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "HotelConfig" + ] + } + } + }, + "parameters": { + "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-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": 80, + "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": { - "aRAccountShortInfoType": { - "description": "Accounts Receivabales Account details type charged for batched posting.", + "templateAirportsDetails": { "type": "object", + "description": "Response object for fetching template airports.", "properties": { - "accountId": { - "description": "The unique ID for the Account.", - "$ref": "#/definitions/uniqueID_Type" - }, - "accountName": { - "description": "Name of the AR Account.", - "type": "string", - "maxLength": 200, - "minLength": 0 + "templateAirports": { + "description": "Collection of template airports.", + "$ref": "#/definitions/templateAirportsType" }, - "accountNo": { - "description": "The Account Number for the Account.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "status": { - "description": "The status of the account.", - "$ref": "#/definitions/aRAccountStatusType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "aRAccountStatusType": { - "description": "Type for the Account Status. Status can be restricted and a message/description added to the Account.", + "templateAirportsType": { + "type": "array", + "description": "Template airport details.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/templateAirportType" + } + }, + "templateAirportType": { "type": "object", + "description": "Base details of the airport.", "properties": { "description": { - "description": "User defined status message on the Account.", + "description": "Description of the airport.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "restricted": { - "description": "Flag to indicate if the Account is restricted.", - "type": "boolean" + "distance": { + "description": "Distance from the hotel to the airport.", + "type": "number" }, - "restriction": { - "description": "The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.", + "distanceType": { + "description": "Unit of distance for the Distance measurement.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "activityLogListType": { - "type": "object", - "properties": { - "activityLog": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/activityLogType" - } + "minLength": 0, + "maxLength": 20 }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "drivingTime": { + "description": "Driving time from the hotel to the airport.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "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" + "direction": { + "description": "Direction of the airport in relation to the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "website": { + "description": "URL of the airport's website.", + "type": "string", + "minLength": 0, + "maxLength": 100 }, - "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" + "transportationOptions": { + "description": "Transportation option available for the airport.", + "type": "array", + "maxItems": 8, + "items": { + "$ref": "#/definitions/transportationInfoType" + } }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", + "sequence": { + "description": "Sequence number for displaying the airport.", "type": "integer" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "code": { + "description": "Airport code identifying the airport.", + "type": "string", + "minLength": 0, + "maxLength": 3 } } }, - "activityLogType": { + "transportationInfoType": { "type": "object", + "description": "Information about the transportation type.", "properties": { - "actionDescription": { + "label": { + "description": "Single character label for the transportation type.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "actionType": { + "description": { + "description": "Description of the transportation type.", "type": "string", - "maxLength": 100, - "minLength": 0 + "minLength": 0, + "maxLength": 1000 }, - "croCode": { + "code": { + "description": "Code for the transportation type.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "hotelId": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "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" }, - "iPAddress": { - "description": "The IP Address of the machine that performed the activity", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "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" }, - "logDate": { - "type": "string", - "format": "date-time" + "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 }, - "logUserId": { - "type": "integer" + "method": { + "description": "HTTP method for requesting the target of the link.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "PATCH", + "OPTIONS", + "HEAD" + ] }, - "logUserName": { + "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" }, - "machineStation": { + "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" }, - "module": { + "title": { + "description": "Exact copy of the \"summary\" field on the linked operation.", "type": "string" - }, - "refActionId": { - "type": "number" } + }, + "required": [ + "href", + "rel", + "method", + "operationId" + ] + }, + "warningsType": { + "type": "array", + "description": "Used in conjunction with the Success element to define a business error.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/warningType" } }, - "additionalGuestAmountType": { + "warningType": { "type": "object", + "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", "properties": { - "ageQualifyingCode": { + "value": { "type": "string", - "enum": [ - "ADULT", - "CHILD", - "OTHER", - "CHILDBUCKET1", - "CHILDBUCKET2", - "CHILDBUCKET3", - "CHILDBUCKET4", - "CHILDBUCKET5" - ] + "description": "Property Value" }, - "amount": { - "$ref": "#/definitions/totalType" - } - } - }, - "addressInfoType": { - "description": "Provides address information.", - "type": "object", - "properties": { - "address": { - "description": "Address details for the profile.", - "$ref": "#/definitions/addressType" + "shortText": { + "description": "An abbreviated version of the error in textual format.", + "type": "string", + "maxLength": 2000 }, - "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.", + "code": { + "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "docURL": { + "description": "If present, this URL refers to an online description of the error that occurred.", "type": "string", - "maxLength": 40, - "minLength": 0 - } - } - }, - "addressSearchType": { - "description": "Address Details such as city, state, country, postal code etc.", - "type": "object", - "properties": { - "cityName": { - "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", + "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": 40, - "minLength": 0 + "maxLength": 2000 }, - "country": { - "description": "Country name (e.g., Ireland).", - "$ref": "#/definitions/countryNameType" + "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 }, - "excludeNoCity": { - "description": "When true indicates that only profiles with city will be fetched.", - "type": "boolean" + "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 }, - "postalCode": { - "description": "Post Office Code number.", + "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", - "maxLength": 15, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "state": { - "description": "State or Province name (e.g., Texas).", + "language": { + "description": "Language identification.", "type": "string", - "maxLength": 20, - "minLength": 0 + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, - "streetAddress": { - "description": "First Line of Street Address. For profile search it matches the first Address line.", + "rph": { + "description": "Reference Place Holder used as an index for this warning.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 1, + "maxLength": 8 } } }, - "addressType": { - "description": "Provides address information.", + "exceptionDetailType": { + "title": "Error Detail", + "description": "Complex type that contains error details for a REST call.", "type": "object", "properties": { - "addressLine": { - "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", - "type": "array", - "maxItems": 4, - "items": { - "type": "string", - "maxLength": 80, - "minLength": 0 - } - }, - "barCode": { - "description": "The postal barcode for the address.", + "type": { "type": "string", - "maxLength": 100, - "minLength": 0 + "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)." }, - "cityExtension": { - "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.", + "title": { "type": "string", - "maxLength": 20, - "minLength": 0 + "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, - "cityName": { - "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", - "type": "string", - "maxLength": 40, - "minLength": 0 + "status": { + "type": "integer", + "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, - "country": { - "description": "Country name (e.g., Ireland).", - "$ref": "#/definitions/countryNameType" + "detail": { + "type": "string", + "description": "Human-readable description specific to this occurrence of the problem." }, - "county": { - "description": "County or District Name (e.g., Fairfax). This is read only.", + "instance": { "type": "string", - "maxLength": 20, - "minLength": 0 + "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, - "createDateTime": { - "description": "Time stamp of the creation.", + "o:errorCode": { "type": "string", - "format": "date-time" + "description": "Application error code, which is different from HTTP error code." }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "o:errorPath": { "type": "string", - "maxLength": 200, - "minLength": 0 + "description": "Path to the problem at the resource or property level." }, - "isValidated": { - "description": "Indicator to define if the Address is validated by the Address Validation System.", - "type": "boolean" + "o:errorDetails": { + "description": "Details of the error message, consisting of a hierarchical tree structure.", + "type": "array", + "items": { + "$ref": "#/definitions/errorInstance" + } }, - "language": { - "description": "Language identification.", + "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", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "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)." }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "title": { "type": "string", - "maxLength": 200, - "minLength": 0 + "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "status": { + "type": "integer", + "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, - "postalCode": { - "description": "Post Office Code number.", + "detail": { "type": "string", - "maxLength": 15, - "minLength": 0 - }, - "primaryInd": { - "description": "When true, indicates a primary information.", - "type": "boolean" + "description": "Human-readable description specific to this occurrence of the problem." }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "instance": { "type": "string", - "format": "date", - "maxLength": 8 + "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, - "state": { - "description": "State or Province name (e.g., Texas).", + "o:errorCode": { "type": "string", - "maxLength": 20, - "minLength": 0 + "description": "Application error code, which is different from HTTP error code." }, - "type": { - "description": "Defines the type of address (e.g. home, business, other).", + "o:errorPath": { "type": "string", - "maxLength": 20, - "minLength": 0 + "description": "Path to the problem at the resource or property level." + } + }, + "required": [ + "type", + "title" + ] + }, + "templateAirportsCriteria": { + "type": "object", + "description": "Request object for creating new template airports.", + "properties": { + "templateAirports": { + "description": "Collection of template airports to be created.", + "$ref": "#/definitions/templateAirportsType" }, - "typeDescription": { - "description": "Describes the type code", - "type": "string" + "links": { + "$ref": "#/definitions/links" }, - "updateReservations": { - "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "addtionalCodeInfoType": { - "description": "Holds name of additional code information", - "type": "array", - "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", - "maxLength": 2000, - "minLength": 0 - } + "status": { + "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "properties": { + "warnings": { + "$ref": "#/definitions/warningsType" + }, + "links": { + "$ref": "#/definitions/links" } } }, - "advanceCheckInType": { - "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", + "templateAirportsToBeChanged": { "type": "object", + "description": "Request object for modifying template airports.", "properties": { - "advanceCheckedIn": { - "description": "Indicates if the reservation is marked as Advance Checked In", - "type": "boolean" + "templateAirports": { + "description": "Collection of template airports to be modified.", + "$ref": "#/definitions/templateAirportsType" }, - "eTRComments": { - "description": "ETR Comments", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "expectedReturnTime": { - "description": "Expected Return Time", - "type": "string", - "format": "date-time" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "airportType": { - "description": "Base details of the airport.", + "templateAmenitiesDetails": { "type": "object", + "description": "Response object for fetching amenities at the template level.", "properties": { - "code": { - "description": "Airport code identifying the airport.", - "type": "string", - "maxLength": 3, - "minLength": 0 + "templateAmenities": { + "description": "Collection of amenities specified at the template level.", + "$ref": "#/definitions/configTemplateAmenitiesType" + }, + "links": { + "$ref": "#/definitions/links" }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "configTemplateAmenitiesType": { + "type": "array", + "description": "This type holds a collection of amenities at the template level.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configTemplateAmenityType" + } + }, + "configTemplateAmenityType": { + "type": "object", + "description": "Base details used for amenities.", + "properties": { "description": { - "description": "Description of the airport.", + "description": "The description about amenity of the hotel.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "direction": { - "description": "Direction of the airport in relation to the hotel.", + "comments": { + "description": "The comments about amenity of the hotel.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "distance": { - "description": "Distance from the hotel to the airport.", + "featureCode": { + "description": "Specifies the feature code (aka amenity code).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "orderSequence": { + "description": "Display Order sequence.", "type": "number" }, - "distanceType": { - "description": "Unit of distance for the Distance measurement.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "amenityType": { + "description": "The type of amenity (general or meeting) selected from the list of values.", + "$ref": "#/definitions/amenityTypeType" }, - "drivingTime": { - "description": "Driving time from the hotel to the airport.", + "beginDate": { + "description": "The date the amenity is scheduled to become active.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "hotelId": { - "description": "Hotel code that the airport belongs to.", + "endDate": { + "description": "The date the amenity is scheduled to become inactive.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "sequence": { - "description": "Sequence number for displaying the airport.", - "type": "integer" - }, - "transportationOptions": { - "description": "Transportation option available for the airport.", - "type": "array", - "maxItems": 8, - "items": { - "$ref": "#/definitions/transportationInfoType" - } + "format": "date", + "maxLength": 8 }, - "website": { - "description": "URL of the airport's website.", + "newChainCode": { + "description": "The new chain code which is used in the change method.", "type": "string", - "maxLength": 100, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "airportsCriteria": { - "description": "Request object for creating new airports for hotels.", + "amenityTypeType": { + "type": "string", + "description": "Simple type for storing amenity type.", + "enum": [ + "General", + "Meeting" + ] + }, + "templateAmenitiesCriteria": { "type": "object", + "description": "Request object for creating amenities at the template level.", "properties": { - "airports": { - "description": "Collection of airports to be created.", - "$ref": "#/definitions/airportsType" + "templateAmenities": { + "description": "Collection containing details of amenities specified at the template level.", + "$ref": "#/definitions/configTemplateAmenitiesType" }, "links": { "$ref": "#/definitions/links" @@ -38072,53 +33422,29 @@ } } }, - "airportsDetails": { - "description": "Response object for fetching airports configured for hotels.", + "templateAmenitiesToBeChanged": { "type": "object", + "description": "Request object for changing amenities at the template level.", "properties": { - "airports": { - "description": "Collection of airports.", - "$ref": "#/definitions/airportsType" - }, - "count": { - "description": "Total number of rows returned", - "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" - }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "templateAmenities": { + "description": "Collection containing details of amenities specified at the template level.", + "$ref": "#/definitions/configTemplateAmenitiesType" }, "links": { "$ref": "#/definitions/links" }, - "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" - }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "airportsToBeChanged": { - "description": "Request object for modifying airports for hotels.", + "attractionClassesDetails": { "type": "object", + "description": "Response object for fetching Attraction Classes.", "properties": { - "airports": { - "description": "Collection of airports to be modified.", - "$ref": "#/definitions/airportsType" + "attractionClasses": { + "description": "Collection of Attraction Classes.", + "$ref": "#/definitions/attractionClassesType" }, "links": { "$ref": "#/definitions/links" @@ -38128,215 +33454,79 @@ } } }, - "airportsType": { - "description": "Airport details for a hotel.", + "attractionClassesType": { "type": "array", + "description": "List of Attraction Classes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/airportType" + "$ref": "#/definitions/attractionClassType" } }, - "alienInfoType": { - "description": "immigration/visa information of a foreign person.", + "attractionClassType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "alienRegistrationNo": { - "description": "Alien Registration Number.", - "type": "string" - }, - "immigrationStatus": { - "description": "Immigration Status on an Alien.", + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "visaValidityType": { - "description": "Visa Type of an Alien.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" + }, + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "alternateHotelType": { + "translationTextType2000": { "type": "object", + "description": "Contains Multiple translated texts and language codes.", "properties": { - "address": { - "$ref": "#/definitions/addressType" - }, - "alternate": { - "type": "boolean" - }, - "alternateHotelCode": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "availableRooms": { - "type": "integer" - }, - "chainCode": { - "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "chainName": { - "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", + "defaultText": { + "description": "Default text with Character length from 0 to 2000.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "channelSummaryInfo": { - "description": "Channel related information if availability request is send for a channel.", - "$ref": "#/definitions/channelSummaryInfoType" - }, - "comments": { - "description": "Comments of alternate Hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "contactNumbers": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/telephoneType" - } - }, - "currencyExchangeRates": { - "description": "Exchange Rate information for currency codes of the requested hotel.", - "$ref": "#/definitions/currencyExchangeRatesType" - }, - "direction": { - "description": "Compass direction to the attraction from the hotel (North/South, etc).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "displayOrder": { - "type": "number" - }, - "event": { - "description": "True if the hotel has any scheduled events within the requested date range.", - "type": "boolean" - }, - "hotelAmenities": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelAmenityType" - } - }, - "hotelCityCode": { - "description": "The IATA city code; for example DCA, ORD.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "hotelCodeContext": { - "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "hotelId": { - "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "hotelName": { - "description": "A text field used to communicate the proper name of the hotel.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "hotelType": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "inventoryRooms": { - "type": "integer" - }, - "maxRate": { - "$ref": "#/definitions/currencyAmountType" - }, - "minRate": { - "$ref": "#/definitions/currencyAmountType" - }, - "negotiated": { - "type": "boolean" - }, - "newAlternateHotelCode": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "rateRoomDetails": { - "description": "Any additional information like membership, restriction status, room stay information of the requested hotels etc.", - "$ref": "#/definitions/rateRoomDetailsType" - }, - "reciprocalRelationship": { - "description": "whether the alternate relationship should be applied to the alternate hotel as well. If this flag is true, not only will the AlternateHotelCode hotel be an alternate for HotelCode hotel, but HotelCode hotel will also be an alternate for AlternateHotelCode hotel.", - "type": "boolean" - }, - "relativePosition": { - "$ref": "#/definitions/relativePositionType" - }, - "sellMessages": { - "description": "Sell messages retrieved based on the Time Span criteria for all Rate Codes and Room Types of the requested hotel.", - "$ref": "#/definitions/sellMessagesType" - } - } - }, - "alternateHotelsCriteria": { - "description": "Request object for creating new Alternate Hotels for hotels.", - "type": "object", - "properties": { - "alternateHotels": { - "description": "Collection of Alternate Hotels to be created.", - "$ref": "#/definitions/alternateHotelsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "alternateHotelsToBeChanged": { - "description": "Request object for changing hotel Alternate Hotels for hotels.", - "type": "object", - "properties": { - "alternateHotels": { - "description": "Collection of Alternate Hotels to be modified.", - "$ref": "#/definitions/alternateHotelsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" + "translatedTexts": { + "description": "List of translated text and language codes.", + "$ref": "#/definitions/translationsTextType" } } }, - "alternateHotelsType": { + "translationsTextType": { "type": "array", + "description": "Language code for the translation.", "maxItems": 4000, "items": { - "$ref": "#/definitions/alternateHotelType" + "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", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + } + }, + "description": "Language code for the translation." } }, - "amenitiesCriteria": { - "description": "Request object for creating amenities at the property level.", + "attractionClassesCriteria": { "type": "object", + "description": "Request object for creating Attraction Classes.", "properties": { - "hotelAmenities": { - "description": "Collection containing details of amenities specified at the property level.", - "$ref": "#/definitions/configHotelAmenitiesType" + "attractionClasses": { + "description": "Attraction Classesto be created.", + "$ref": "#/definitions/attractionClassesType" }, "links": { "$ref": "#/definitions/links" @@ -38346,13 +33536,13 @@ } } }, - "amenitiesDetails": { - "description": "Response object for fetching amenities at the property level.", + "attractionClassesToBeChanged": { "type": "object", + "description": "Request object for changing Attraction Classes.", "properties": { - "hotelAmenities": { - "description": "Collection of amenities specified at the property level.", - "$ref": "#/definitions/configHotelAmenitiesType" + "attractionClasses": { + "description": "Attraction Classesto be changed.", + "$ref": "#/definitions/attractionClassesType" }, "links": { "$ref": "#/definitions/links" @@ -38362,13 +33552,13 @@ } } }, - "amenitiesToBeChanged": { - "description": "Request object for changing amenities at the property level.", + "attractionTemplatesDetails": { "type": "object", + "description": "Response object for information regarding attraction templates.", "properties": { - "hotelAmenities": { - "description": "Collection containing details of amenities specified at the property level.", - "$ref": "#/definitions/configHotelAmenitiesType" + "attractionTemplates": { + "description": "Collection of attraction templates and their information.", + "$ref": "#/definitions/attractionTemplatesType" }, "links": { "$ref": "#/definitions/links" @@ -38378,298 +33568,285 @@ } } }, - "amenityTypeType": { - "description": "Simple type for storing amenity type.", - "type": "string", - "enum": [ - "General", - "Meeting" - ] - }, - "amountDeterminationType": { - "description": "Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.", - "type": "string", - "enum": [ - "Inclusive", - "Exclusive" - ] + "attractionTemplatesType": { + "type": "array", + "description": "Collection of attraction templates.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/attractionTemplateType" + } }, - "amountType": { - "description": "Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.", + "attractionTemplateType": { "type": "object", + "description": "Information about the attractions near the hotel.", "properties": { - "additionalGuestAmounts": { - "description": "Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/additionalGuestAmountType" - } + "name": { + "description": "Attraction name for the hotel.", + "$ref": "#/definitions/translationTextType2000" }, - "base": { - "description": "The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.", - "$ref": "#/definitions/totalType" + "type": { + "description": "The type of the attraction.", + "type": "string", + "minLength": 0, + "maxLength": 60 }, - "discount": { - "description": "Discount percentage and/or Amount, code and textual reason for discount", - "$ref": "#/definitions/discountType" + "class": { + "description": "The class of the attraction.", + "type": "string", + "minLength": 0, + "maxLength": 60 }, - "effectiveRate": { - "description": "The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time", - "$ref": "#/definitions/totalType" + "generalDirections": { + "description": "Directions to the attraction from the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "end": { - "description": "The ending value of the date range.", + "relativePosition": { + "$ref": "#/definitions/relativePositionType" + }, + "address": { + "description": "Address of the attraction.", + "$ref": "#/definitions/addressType" + }, + "website": { + "description": "Website for the attraction.", + "$ref": "#/definitions/uRLType" + }, + "priceRange": { + "description": "Price range for the attraction.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 40 }, - "requiredPoints": { - "description": "The Points contains the number of points required to book a particular room type.", - "$ref": "#/definitions/pointsType" + "operationHours": { + "description": "Price range for the attraction.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "shareDistributionInstruction": { - "description": "Last rate share distribution instruction applied on share reservation daily rate segment.", - "$ref": "#/definitions/shareDistributionInstructionType" + "displaySeq": { + "description": "Display sequence of the attraction.", + "type": "integer" }, - "shareRatePercentage": { - "description": "Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.", - "type": "number", - "maximum": 100, - "minimum": 0 + "code": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "start": { - "description": "The starting value of the date range.", + "region": { + "description": "The region in which this attraction is located.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "inactiveDate": { + "description": "The date the record was marked as inactive.", "type": "string", "format": "date", "maxLength": 8 }, - "total": { - "description": "The total amount charged for this rate including additional occupant amounts and fees.", - "$ref": "#/definitions/totalType" - } - } - }, - "anonymizationStatusType": { - "description": "Guest has been anonymized.", - "type": "string", - "enum": [ - "Requested", - "Anonymized" - ] - }, - "anonymizationType": { - "description": "Provides information about guest's anonymization status.", - "type": "object", - "properties": { - "anonymizationDate": { - "description": "Date and Time when the guest was anonymized.", - "type": "string", - "format": "date-time" + "latitude": { + "type": "number", + "minimum": -90, + "maximum": 90 }, - "anonymizationStatus": { - "description": "Status of anonymization such as Requested or Anonymized.", - "$ref": "#/definitions/anonymizationStatusType" + "longitude": { + "description": "The longitude of the location from which the organism or observation was collected, expressed in decimal degrees. Positive values are East of the Greenwich Meridian, negative values are West of the Greenwich Meridian.", + "type": "number", + "minimum": -180, + "maximum": 180 } } }, - "applicationSettingConversionType": { - "type": "string", - "enum": [ - "Default", - "Parameter" - ] - }, - "applicationSettingGroupType": { - "description": "This element simply groups the different Application Functions.", + "relativePositionType": { "type": "object", + "description": "Defines the position of an entity in relation to another entity (e.g. from an airport to a hotel, the relationship is dependent on use).", "properties": { - "appSettings": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/applicationSettingType" - } + "distance": { + "description": "Defines the distance between two points.", + "type": "number" }, - "groupDisplayName": { + "distanceType": { + "description": "The unit of measure in a code format.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "groupName": { + "drivingTime": { + "description": "The driving time in a free text format.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "applicationSettingLevelType": { - "type": "string", - "enum": [ - "Global", - "Hotel", - "Cro" - ] - }, - "applicationSettingSimpleType": { - "description": "Internal settings that is mainly used to get a quick information on the type.", + "addressType": { "type": "object", + "description": "Provides address information.", "properties": { - "configurations": { - "description": "This element is used for additional items (Key-Value-Pair) that has relevance to the operation.", + "isValidated": { + "description": "Indicator to define if the Address is validated by the Address Validation System.", + "type": "boolean" + }, + "addressLine": { + "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", "type": "array", - "maxItems": 4000, + "maxItems": 4, "items": { - "$ref": "#/definitions/applicationSettingSimpleType" + "type": "string", + "minLength": 0, + "maxLength": 80 } }, - "levelCode": { + "cityName": { + "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "levelType": { - "$ref": "#/definitions/applicationSettingLevelType" - }, - "name": { + "postalCode": { + "description": "Post Office Code number.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 15 }, - "value": { + "cityExtension": { + "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.", "type": "string", - "maxLength": 2000, - "minLength": 0 - } - } - }, - "applicationSettingType": { - "description": "Internal settings that can be of a certain valueType.", - "type": "object", - "properties": { - "conversionType": { - "description": "Represents whether the value is OXI Parameter or Conversion code default.", - "$ref": "#/definitions/applicationSettingConversionType" + "minLength": 0, + "maxLength": 20 }, - "description": { + "county": { + "description": "County or District Name (e.g., Fairfax). This is read only.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "displayName": { + "state": { + "description": "State or Province name (e.g., Texas).", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "editAllowed": { - "type": "boolean" + "country": { + "description": "Country name (e.g., Ireland).", + "$ref": "#/definitions/countryNameType" }, - "hotelId": { - "description": "Each configuration item will come with a HotelCode which will help the configuration to specify what context the update has to be. Eg. _Global,ORS,'CRO', etc.", + "language": { + "description": "Language identification.", "type": "string", - "maxLength": 20, - "minLength": 0 + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, - "levelCode": { + "type": { + "description": "Defines the type of address (e.g. home, business, other).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "levelType": { - "$ref": "#/definitions/applicationSettingLevelType" + "typeDescription": { + "description": "Describes the type code", + "type": "string" }, - "name": { - "type": "string", - "maxLength": 80, - "minLength": 0 + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" }, - "scope": { + "updateReservations": { + "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.", + "type": "boolean" + }, + "barCode": { + "description": "The postal barcode for the address.", "type": "string", - "enum": [ - "P", - "G", - "Ch", - "C" - ] + "minLength": 0, + "maxLength": 100 }, - "sequence": { - "type": "number" + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" }, - "settings": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/baseApplicationSettingType" - } + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "shortDescription": { + "lastModifyDateTime": { + "description": "Time stamp of last modification.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "format": "date-time" }, - "type": { - "$ref": "#/definitions/applicationSettingTypeType" + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "countryNameType": { + "type": "object", + "description": "Code for a country or a nationality.", + "properties": { "value": { "type": "string", - "maxLength": 2000, - "minLength": 0 + "description": "Used for Character Strings, length 0 to 200.", + "minLength": 0, + "maxLength": 200 }, - "valueType": { + "code": { + "description": "Code for a country or a nationality.", "type": "string", - "enum": [ - "Yn", - "Integer", - "String", - "SingleSelectLov", - "MultiSelectLov", - "ShuttleLov", - "Custom", - "Double", - "Secure" - ] - }, - "wildCardMatch": { - "description": "A flag which indicate whether a wild card search should be made.", - "type": "boolean" + "minLength": 0, + "maxLength": 20 } } }, - "applicationSettingTypeType": { - "type": "string", - "enum": [ - "Function", - "Parameter", - "Setting" - ] - }, - "attractionClassType": { - "description": "Contains Common Master configuration detail.", + "uRLType": { "type": "object", + "description": "Web site address, in IETF(The Internet Engineering Task Force) specified format.", "properties": { - "code": { - "description": "Common Master unique code.", + "value": { "type": "string", - "maxLength": 40, - "minLength": 0 + "description": "Property Value" }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "type": { + "description": "Defines the purpose of the URL address, such as personal, business, public, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "displayOrder": { - "description": "Common Master record sequence number.", + "typeDescription": { + "description": "Describes the Type code", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", "type": "number" } } }, - "attractionClassesCriteria": { - "description": "Request object for creating Attraction Classes.", + "attractionTemplatesCriteria": { "type": "object", + "description": "Request object for creating a new attraction code template.", "properties": { - "attractionClasses": { - "description": "Attraction Classesto be created.", - "$ref": "#/definitions/attractionClassesType" + "attractionTemplates": { + "description": "Attraction template details to be created.", + "$ref": "#/definitions/attractionTemplatesType" }, "links": { "$ref": "#/definitions/links" @@ -38679,14 +33856,14 @@ } } }, - "attractionClassesDetails": { - "description": "Response object for fetching Attraction Classes.", + "attractionTemplatesToBeChanged": { "type": "object", + "description": "Request object for modifying the existing attraction attraction templates.", "properties": { - "attractionClasses": { - "description": "Collection of Attraction Classes.", - "$ref": "#/definitions/attractionClassesType" - }, + "attractionTemplates": { + "description": "Attraction template group details to be changed.", + "$ref": "#/definitions/attractionTemplatesType" + }, "links": { "$ref": "#/definitions/links" }, @@ -38695,13 +33872,13 @@ } } }, - "attractionClassesToBeChanged": { - "description": "Request object for changing Attraction Classes.", + "brandCodesDetails": { "type": "object", + "description": "Response object for fetching Brand Codes.", "properties": { - "attractionClasses": { - "description": "Attraction Classesto be changed.", - "$ref": "#/definitions/attractionClassesType" + "brandCodes": { + "description": "Collection of Brand Codes.", + "$ref": "#/definitions/brandCodesType" }, "links": { "$ref": "#/definitions/links" @@ -38711,217 +33888,320 @@ } } }, - "attractionClassesType": { - "description": "List of Attraction Classes.", + "brandCodesType": { "type": "array", + "description": "List of Brand Codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/attractionClassType" + "$ref": "#/definitions/brandCodeType" } }, - "attractionCodeType": { - "description": "Information about the attractions near the hotel.", + "brandCodeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "address": { - "description": "Address of the attraction.", - "$ref": "#/definitions/addressType" - }, - "class": { - "description": "The class of the attraction.", - "type": "string", - "maxLength": 60, - "minLength": 0 - }, "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "displaySeq": { - "description": "Display sequence of the attraction.", - "type": "integer" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "generalDirections": { - "description": "Directions to the attraction from the hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" + } + } + }, + "brandCodesCriteria": { + "type": "object", + "description": "Request object for creating Brand Codes.", + "properties": { + "brandCodes": { + "description": "Brand Codes to be created.", + "$ref": "#/definitions/brandCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "brandCodesToBeChanged": { + "type": "object", + "description": "Request object for changing Brand Codes.", + "properties": { + "brandCodes": { + "description": "Brand Codes to be changed.", + "$ref": "#/definitions/brandCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "hotelCalendarDetails": { + "type": "object", + "description": "Response object for fetching calendar entries for a hotel.", + "properties": { + "hotelCalendar": { + "description": "Collection of hotel level calendar entries.", + "$ref": "#/definitions/hotelCalendarType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "hotelCalendarType": { + "type": "object", + "description": "Represents the calendar with individual days having corresponding entries (day type, event, etc.) for a hotel.", + "properties": { + "calendarDay": { + "description": "Entries for a specific calendar day.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelCalendarDayType" + } }, "hotelId": { - "description": "Hotel Code for attraction.", + "description": "Indicates a specific hotel for which the calendar is being represented.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "hotelCalendarDayType": { + "type": "object", + "description": "Details of calendar entries for a specific day for a specific hotel.", + "properties": { + "dayType": { + "description": "Details of Day Type of that calendar day.", + "$ref": "#/definitions/hotelCalendarDayTypeType" }, - "inactiveDate": { - "description": "The date the record was marked as inactive.", + "events": { + "description": "Details of an event on that calendar day.", + "$ref": "#/definitions/hotelCalendarEventsType" + }, + "date": { + "description": "Indicates a specific hotel for which the calendar is being represented.", "type": "string", "format": "date", "maxLength": 8 + } + } + }, + "hotelCalendarDayTypeType": { + "type": "object", + "description": "Details of Day Type.", + "properties": { + "code": { + "description": "Code of the Day Type", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "latitude": { - "type": "number", - "maximum": 90, - "minimum": -90 - }, - "longitude": { - "description": "The longitude of the location from which the organism or observation was collected, expressed in decimal degrees. Positive values are East of the Greenwich Meridian, negative values are West of the Greenwich Meridian.", - "type": "number", - "maximum": 180, - "minimum": -180 - }, - "name": { - "description": "Attraction name for the hotel.", - "$ref": "#/definitions/translationTextType2000" - }, - "operationHours": { - "description": "Price range for the attraction.", + "description": { + "description": "Description of the Day Type.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "priceRange": { - "description": "Price range for the attraction.", + "color": { + "description": "Associated color for the selected Day Type.", + "$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" + ] + }, + "hotelCalendarEventsType": { + "type": "array", + "description": "Details of hotel events", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelCalendarEventType" + } + }, + "hotelCalendarEventType": { + "type": "object", + "description": "Details of event.", + "properties": { + "code": { + "description": "Code for a specific event.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "region": { - "description": "The region in which this attraction is located.", + "description": { + "description": "Description for a specific event.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "chainDetails": { + "type": "object", + "description": "Response object for fetching Chain.", + "properties": { + "chains": { + "description": "A collection of chain records including address of the chain.", + "$ref": "#/definitions/chainConfigInfoType" }, - "relativePosition": { - "$ref": "#/definitions/relativePositionType" + "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" }, - "type": { - "description": "The type of the attraction.", - "type": "string", - "maxLength": 60, - "minLength": 0 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "website": { - "description": "Website for the attraction.", - "$ref": "#/definitions/uRLType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "attractionCodesType": { - "description": "Collection of hotel level alert codes with attached alert types.", + "chainConfigInfoType": { "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/attractionCodeType" + "$ref": "#/definitions/chainDetailInfoType" } }, - "attractionTemplateType": { - "description": "Information about the attractions near the hotel.", + "chainDetailInfoType": { "type": "object", "properties": { - "address": { - "description": "Address of the attraction.", - "$ref": "#/definitions/addressType" - }, - "class": { - "description": "The class of the attraction.", + "chainCode": { "type": "string", - "maxLength": 60, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "code": { + "chainName": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "displaySeq": { - "description": "Display sequence of the attraction.", - "type": "integer" + "chainDesc": { + "type": "string" }, - "generalDirections": { - "description": "Directions to the attraction from the hotel.", + "shareProfilesYn": { + "description": "Flag to check if chain allows share Profiles.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "inactiveDate": { - "description": "The date the record was marked as inactive.", + "aspYn": { + "description": "Flag to check if chain has ASP.", "type": "string", - "format": "date", - "maxLength": 8 - }, - "latitude": { - "type": "number", - "maximum": 90, - "minimum": -90 + "minLength": 0, + "maxLength": 1 }, - "longitude": { - "description": "The longitude of the location from which the organism or observation was collected, expressed in decimal degrees. Positive values are East of the Greenwich Meridian, negative values are West of the Greenwich Meridian.", - "type": "number", - "maximum": 180, - "minimum": -180 + "chainAddress": { + "$ref": "#/definitions/addressType" }, - "name": { - "description": "Attraction name for the hotel.", - "$ref": "#/definitions/translationTextType2000" + "phone": { + "description": "The phone number of the chain.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "operationHours": { - "description": "Price range for the attraction.", + "fax": { + "description": "The fax number of the chain.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "priceRange": { - "description": "Price range for the attraction.", + "email": { + "description": "The email address of the chain.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "region": { - "description": "The region in which this attraction is located.", + "startDate": { + "description": "This represents the begin date of Chain.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "relativePosition": { - "$ref": "#/definitions/relativePositionType" + "endDate": { + "description": "This represents the end date of chain.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "type": { - "description": "The type of the attraction.", + "frequentFlierCardsAcceptYn": { + "description": "Flag to check if chain accepts Frequent Flier Cards.", "type": "string", - "maxLength": 60, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "website": { - "description": "Website for the attraction.", - "$ref": "#/definitions/uRLType" - } - } - }, - "attractionTemplatesCriteria": { - "description": "Request object for creating a new attraction code template.", - "type": "object", - "properties": { - "attractionTemplates": { - "description": "Attraction template details to be created.", - "$ref": "#/definitions/attractionTemplatesType" + "bookingConditions": { + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "links": { - "$ref": "#/definitions/links" + "loyaltyProgram": { + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "marketingText": { + "type": "string", + "minLength": 0, + "maxLength": 4000 } } }, - "attractionTemplatesDetails": { - "description": "Response object for information regarding attraction templates.", + "chainToBeChanged": { "type": "object", + "description": "Request object for changing Chain.", "properties": { - "attractionTemplates": { - "description": "Collection of attraction templates and their information.", - "$ref": "#/definitions/attractionTemplatesType" + "chains": { + "description": "A collection of chain records including address of the chain.", + "$ref": "#/definitions/chainConfigInfoType" }, "links": { "$ref": "#/definitions/links" @@ -38931,13 +34211,13 @@ } } }, - "attractionTemplatesToBeChanged": { - "description": "Request object for modifying the existing attraction attraction templates.", + "communicationMethodsEntDetailsDetails": { "type": "object", + "description": "Response object for fetching Communication Methods Ent Details.", "properties": { - "attractionTemplates": { - "description": "Attraction template group details to be changed.", - "$ref": "#/definitions/attractionTemplatesType" + "communicationMethodsEntDetails": { + "description": "Collection of Communication Methods Ent Details.", + "$ref": "#/definitions/communicationMethodsEntDetailsType" }, "links": { "$ref": "#/definitions/links" @@ -38947,37 +34227,41 @@ } } }, - "attractionTemplatesType": { - "description": "Collection of attraction templates.", + "communicationMethodsEntDetailsType": { "type": "array", + "description": "List of Communication Methods Ent Details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/attractionTemplateType" + "$ref": "#/definitions/communicationMethodsEntDetailType" } }, - "attractionsCriteria": { - "description": "Request object for creating a new group of attractions.", + "communicationMethodsEntDetailType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "attractions": { - "description": "Group of attractions to be created.", - "$ref": "#/definitions/attractionCodesType" + "code": { + "description": "Common Master unique code.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "links": { - "$ref": "#/definitions/links" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "attractionsDetails": { - "description": "Response object for information regarding attraction.", + "communicationMethodsEntDetailsCriteria": { "type": "object", + "description": "Request object for creating Communication Methods Ent Details.", "properties": { - "attractions": { - "description": "Collection of attractions and their information.", - "$ref": "#/definitions/attractionCodesType" + "communicationMethodsEntDetails": { + "description": "Communication Methods Ent Detailsto be created.", + "$ref": "#/definitions/communicationMethodsEntDetailsType" }, "links": { "$ref": "#/definitions/links" @@ -38987,13 +34271,13 @@ } } }, - "attractionsToBeChanged": { - "description": "Request object for modifying an existing attraction.", + "communicationMethodsEntDetailsToBeChanged": { "type": "object", + "description": "Request object for changing Communication Methods Ent Details.", "properties": { - "attractions": { - "description": "Attraction group to be changed.", - "$ref": "#/definitions/attractionCodesType" + "communicationMethodsEntDetails": { + "description": "Communication Methods Ent Detailsto be changed.", + "$ref": "#/definitions/communicationMethodsEntDetailsType" }, "links": { "$ref": "#/definitions/links" @@ -39003,362 +34287,268 @@ } } }, - "authorizationRuleType": { - "description": "Configured rule for computing the amount to authorize.", + "configActivityLogDetails": { "type": "object", + "description": "Response object for fetching configuration activity log.", "properties": { - "amount": { - "description": "The amount applicable to the authorization rule.", - "$ref": "#/definitions/currencyAmountType" + "activityLog": { + "description": "Contains list of the activity logs.", + "$ref": "#/definitions/activityLogListType" }, - "code": { - "description": "The authorization rule code.", - "type": "integer", - "pattern": "[0-9]{1,9}" + "links": { + "$ref": "#/definitions/links" }, - "percent": { - "description": "A percentage value if the authorization rule is percentage based.", - "type": "number" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "authorizerInfoType": { - "description": "Authorizer Information", + "activityLogListType": { "type": "object", "properties": { - "authorizerId": { - "$ref": "#/definitions/uniqueID_Type" + "activityLog": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/activityLogType" + } }, - "authorizerName": { - "description": "Full name of the authorizer.", - "type": "string", - "maxLength": 100, - "minLength": 0 + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "authorizerRateCode": { - "description": "Rate code of the authorizer.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "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" }, - "authorizerUserName": { - "description": "Application user name of the authorizer", - "type": "string", - "maxLength": 40, - "minLength": 0 + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "inheritAuthorizerRateCode": { - "description": "Indicates whether user has the choice to have reservation inherit rate code from the authorizer.", + "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" } } }, - "awardId": { - "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).", + "activityLogType": { "type": "object", "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.", + "hotelId": { "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "idContext": { - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "module": { + "type": "string" + }, + "logDate": { "type": "string", - "maxLength": 80, - "minLength": 0 + "format": "date-time" }, - "idExtension": { - "description": "Additional identifying value assigned by the creating system.", + "refActionId": { + "type": "number" + }, + "logUserId": { "type": "integer" }, - "instance": { - "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", + "logUserName": { + "type": "string" + }, + "machineStation": { + "type": "string" + }, + "croCode": { "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "actionType": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 100 }, - "url": { - "description": "URL that identifies the location associated with the record identified by the UniqueID.", - "type": "string" + "actionDescription": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "iPAddress": { + "description": "The IP Address of the machine that performed the activity", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "deviceCode": { + "description": "The selected device code", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "awardVouchersType": { - "description": "This stores the Membership Awards code applied on the reservation.", - "type": "array", - "maxItems": 5, - "items": { - "type": "object", - "properties": { - "awardCode": { - "description": "Membership Award code applied on the reservation.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "voucherNo": { - "description": "Membership Award number.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - } - }, - "baseApplicationSettingType": { - "description": "Internal settings that can be of a certain valueType.", + "createConfigActivityLogCriteria": { "type": "object", + "description": "Request object for creating Config Activity Logs.", "properties": { - "conversionType": { - "description": "Represents whether the value is OXI Parameter or Conversion code default.", - "$ref": "#/definitions/applicationSettingConversionType" - }, - "description": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "displayName": { - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "editAllowed": { - "type": "boolean" - }, - "hotelId": { - "description": "Each configuration item will come with a HotelCode which will help the configuration to specify what context the update has to be. Eg. _Global,ORS,'CRO', etc.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "name": { - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "scope": { - "type": "string", - "enum": [ - "P", - "G", - "Ch", - "C" - ] - }, - "sequence": { - "type": "number" - }, - "shortDescription": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "type": { - "$ref": "#/definitions/applicationSettingTypeType" - }, - "value": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "valueType": { - "type": "string", - "enum": [ - "Yn", - "Integer", - "String", - "SingleSelectLov", - "MultiSelectLov", - "ShuttleLov", - "Custom", - "Double", - "Secure" - ] + "configActivities": { + "description": "Confic Activity Logs to be created.", + "$ref": "#/definitions/configActivitiesType" }, - "wildCardMatch": { - "description": "A flag which indicate whether a wild card search should be made.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "basicEmailType": { - "description": "Email address", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "configActivitiesType": { + "type": "array", + "description": "Changes log record to import/Export/Delete customization operations.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configActivityType" + } }, - "bedTaxReportingType": { - "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", + "configActivityType": { "type": "object", + "description": "Changes log record to import/Export/Delete customization operations.", "properties": { - "taxRegistrationNo": { - "description": "Tax Registration Number for Maldives Bed Tax Reporting.", - "type": "number" - }, - "taxableDays": { - "description": "Number of days for which the Maldives tax is applicable.", - "type": "integer" - }, - "visaExpiryDate": { - "description": "Visa Expiration Date used for Maldives Bed Tax Reporting", + "actionType": { + "description": "Action Type: MDS_IMP, MDS_EXP, MDS_DEL, MDS_EXP_UNENC, MDS_IMP_UNENC.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "visaIssueDate": { - "description": "Visa Issue Date used for Maldives Bed Tax Reporting.", + "actionDescription": { + "description": "action, layer, org name, user name and screen name or file name or path.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 200 }, - "visaNumber": { - "description": "Visa number used for Maldives Bed Tax Reporting", + "hotelId": { + "description": "Code that uniquely identifies the hotel belonging to the organization.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "benefitType": { - "description": "Basic information about membership benefit.", + "corporateBusinessUnitsDetails": { "type": "object", + "description": "Response object for fetching Corporate Business Units.", "properties": { - "code": { - "description": "Benefit code associated with a membership.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "corporateBusinessUnits": { + "description": "Collection of Corporate Business Units.", + "$ref": "#/definitions/corporateBusinessUnitsType" }, - "inactive": { - "description": "Indicates whether membership benefit is active or inactive.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "message": { - "description": "Processing message for membership benefit.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "benefitsType": { - "description": "Basic information about membership benefit.", + "corporateBusinessUnitsType": { "type": "array", + "description": "List of Corporate Business Units.", "maxItems": 4000, "items": { - "$ref": "#/definitions/benefitType" + "$ref": "#/definitions/corporateBusinessUnitType" } }, - "billingPrivilegesType": { - "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", + "corporateBusinessUnitType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "allowAutoCheckin": { - "description": "Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.", - "type": "boolean" - }, - "autoSettlement": { - "description": "Indicates if the is a candidate for auto folio settlement.", - "type": "boolean" - }, - "autoSettlementFreq": { - "description": "The interval of days between each auto folio settlement.", - "type": "integer" - }, - "autoSettlementType": { - "description": "The folio settlement type for auto folio settlement.", + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "creditLimitAutoPay": { - "description": "Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.", - "type": "boolean" + "minLength": 0, + "maxLength": 40 }, - "directBillAuthorized": { - "description": "If Direct bill is authorized this will hold User ID who authorized it.", - "type": "boolean" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "folioCloseDate": { - "description": "Date when folio was closed. This works with PostStayCharging flag.", - "type": "string", - "format": "date", - "maxLength": 8 + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" + } + } + }, + "corporateBusinessUnitsCriteria": { + "type": "object", + "description": "Request object for creating Corporate Business Units.", + "properties": { + "corporateBusinessUnits": { + "description": "Corporate Business Units to be created.", + "$ref": "#/definitions/corporateBusinessUnitsType" }, - "postStayCharging": { - "description": "Indicates if the reservation has charging privileges after checkout.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "postingRestriction": { - "description": "Flag used by interface program during check in.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "corporateBusinessUnitsToBeChanged": { + "type": "object", + "description": "Request object for changing Corporate Business Units.", + "properties": { + "corporateBusinessUnits": { + "description": "Corporate Business Units to be changed.", + "$ref": "#/definitions/corporateBusinessUnitsType" }, - "preStayCharging": { - "description": "Indicates if the reservation has charging privileges before arrival.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "scheduledCheckout": { - "description": "Indicates if the guest is scheduled for automatic check out.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "corporateDepartmentCodesDetails": { + "type": "object", + "description": "Response object for fetching Corporate Department Codes.", + "properties": { + "corporateDepartmentCodes": { + "description": "Collection of Corporate Department Codes.", + "$ref": "#/definitions/corporateDepartmentCodesType" }, - "scheduledCheckoutTime": { - "description": "Time of automatic check out if guest is schedule for automatic check out.", - "type": "string", - "format": "date", - "maxLength": 8 + "links": { + "$ref": "#/definitions/links" }, - "videoCheckout": { - "description": "Indicates if the guest can do video checkout", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "blockIdList": { - "description": "Unique Id that references an object uniquely in the system.", + "corporateDepartmentCodesType": { "type": "array", + "description": "List of Corporate Department Codes.", "maxItems": 4000, "items": { - "$ref": "#/definitions/uniqueID_Type" + "$ref": "#/definitions/corporateDepartmentCodeType" } }, - "bookingChannelType": { + "corporateDepartmentCodeType": { "type": "object", - "properties": { - "channelCode": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "channelName": { - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "channelType": { - "type": "string", - "maxLength": 240, - "minLength": 0 - } - } - }, - "brandCodeType": { "description": "Contains Common Master configuration detail.", - "type": "object", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -39370,13 +34560,13 @@ } } }, - "brandCodesCriteria": { - "description": "Request object for creating Brand Codes.", + "corporateDepartmentCodesCriteria": { "type": "object", + "description": "Request object for creating Corporate Department Codes.", "properties": { - "brandCodes": { - "description": "Brand Codes to be created.", - "$ref": "#/definitions/brandCodesType" + "corporateDepartmentCodes": { + "description": "Corporate Department Codes to be created.", + "$ref": "#/definitions/corporateDepartmentCodesType" }, "links": { "$ref": "#/definitions/links" @@ -39386,13 +34576,13 @@ } } }, - "brandCodesDetails": { - "description": "Response object for fetching Brand Codes.", + "corporateDepartmentCodesToBeChanged": { "type": "object", + "description": "Request object for changing Corporate Department Codes.", "properties": { - "brandCodes": { - "description": "Collection of Brand Codes.", - "$ref": "#/definitions/brandCodesType" + "corporateDepartmentCodes": { + "description": "Corporate Department Codes to be changed.", + "$ref": "#/definitions/corporateDepartmentCodesType" }, "links": { "$ref": "#/definitions/links" @@ -39402,13 +34592,13 @@ } } }, - "brandCodesToBeChanged": { - "description": "Request object for changing Brand Codes.", + "corporateDivisionsDetails": { "type": "object", + "description": "Response object for fetching Corporate Divisions.", "properties": { - "brandCodes": { - "description": "Brand Codes to be changed.", - "$ref": "#/definitions/brandCodesType" + "corporateDivisions": { + "description": "Collection of Corporate Divisions.", + "$ref": "#/definitions/corporateDivisionsType" }, "links": { "$ref": "#/definitions/links" @@ -39418,187 +34608,57 @@ } } }, - "brandCodesType": { - "description": "List of Brand Codes.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/brandCodeType" - } - }, - "cardNumberTypeType": { - "description": "Simple type for indicating if credit card number is tokenized.", - "type": "string", - "enum": [ - "CardNumber", - "Token" - ] - }, - "cardProcessingType": { - "type": "string", - "enum": [ - "Eft", - "Manual" - ] - }, - "cardReIssueType": { - "description": "Request to re issue a new card.", - "type": "string", - "enum": [ - "Pending", - "NotApplicable", - "Requested" - ] - }, - "cardTypeType": { - "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.", - "type": "string", - "enum": [ - "Ab", - "Am", - "Ax", - "Cb", - "Dc", - "Ds", - "Dt", - "Ec", - "Er", - "Jc", - "Jl", - "Mc", - "Nb", - "So", - "St", - "Sw", - "Va", - "Xy", - "Zz", - "Cp", - "Cu" - ] - }, - "chainConfigInfoType": { + "corporateDivisionsType": { "type": "array", + "description": "List of Corporate Divisions.", "maxItems": 4000, "items": { - "$ref": "#/definitions/chainDetailInfoType" + "$ref": "#/definitions/corporateDivisionType" } }, - "chainDetailInfoType": { + "corporateDivisionType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "aspYn": { - "description": "Flag to check if chain has ASP.", - "type": "string", - "maxLength": 1, - "minLength": 0 - }, - "bookingConditions": { - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "chainAddress": { - "$ref": "#/definitions/addressType" - }, - "chainCode": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "chainDesc": { - "type": "string" - }, - "chainName": { - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "email": { - "description": "The email address of the chain.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "endDate": { - "description": "This represents the end date of chain.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "fax": { - "description": "The fax number of the chain.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "frequentFlierCardsAcceptYn": { - "description": "Flag to check if chain accepts Frequent Flier Cards.", - "type": "string", - "maxLength": 1, - "minLength": 0 - }, - "loyaltyProgram": { - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "marketingText": { - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "phone": { - "description": "The phone number of the chain.", + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "shareProfilesYn": { - "description": "Flag to check if chain allows share Profiles.", - "type": "string", - "maxLength": 1, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "startDate": { - "description": "This represents the begin date of Chain.", - "type": "string", - "format": "date", - "maxLength": 8 + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "chainDetails": { - "description": "Response object for fetching Chain.", + "corporateDivisionsCriteria": { "type": "object", + "description": "Request object for creating Corporate Divisions.", "properties": { - "chains": { - "description": "A collection of chain records including address of the chain.", - "$ref": "#/definitions/chainConfigInfoType" - }, - "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" + "corporateDivisions": { + "description": "Corporate Divisions to be created.", + "$ref": "#/definitions/corporateDivisionsType" }, "links": { "$ref": "#/definitions/links" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "chainToBeChanged": { - "description": "Request object for changing Chain.", + "corporateDivisionsToBeChanged": { "type": "object", + "description": "Request object for changing Corporate Divisions.", "properties": { - "chains": { - "description": "A collection of chain records including address of the chain.", - "$ref": "#/definitions/chainConfigInfoType" + "corporateDivisions": { + "description": "Corporate Divisions to be changed.", + "$ref": "#/definitions/corporateDivisionsType" }, "links": { "$ref": "#/definitions/links" @@ -39608,417 +34668,319 @@ } } }, - "changeRelationsType": { - "description": "Detailed information regarding the changes made to relationships for the profile.", + "corporateOperatingUnitsDetails": { "type": "object", + "description": "Response object for fetching Corporate Operating Units.", "properties": { - "id": { - "description": "Relationship identifier.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "relation": { - "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "relationDescription": { - "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).", - "type": "string", - "maxLength": 200, - "minLength": 0 + "corporateOperatingUnits": { + "description": "Collection of Corporate Operating Units.", + "$ref": "#/definitions/corporateOperatingUnitsType" }, - "targetRelation": { - "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "targetRelationDescription": { - "description": "Displays the description of the target relation(Target Profile).", - "type": "string", - "maxLength": 200, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "channelSummaryInfoType": { - "description": "Depicts channel information such as the type and code.", + "corporateOperatingUnitsType": { + "type": "array", + "description": "List of Corporate Operating Units.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/corporateOperatingUnitType" + } + }, + "corporateOperatingUnitType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "bookingChannel": { - "$ref": "#/definitions/bookingChannelType" + "code": { + "description": "Common Master unique code.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "messageId": { - "description": "Indicates the transaction identifier.", - "type": "string" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "summaryOnly": { - "description": "Used to indicate whether to return summarized or detailed rate room information.", - "type": "boolean" + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "characterUDFType": { - "description": "Used to hold user defined field of Character/String Type.", + "corporateOperatingUnitsCriteria": { "type": "object", + "description": "Request object for creating Corporate Operating Units.", "properties": { - "alternateName": { - "description": "Label of user defined field used by vendors or customers.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "corporateOperatingUnits": { + "description": "Corporate Operating Units to be created.", + "$ref": "#/definitions/corporateOperatingUnitsType" }, - "name": { - "description": "Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "value": { - "description": "Value of user defined field.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "characterUDFsType": { - "description": "Used to hold collection of user defined fields of Character/String Type.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/characterUDFType" + "corporateOperatingUnitsToBeChanged": { + "type": "object", + "description": "Request object for changing Corporate Operating Units.", + "properties": { + "corporateOperatingUnits": { + "description": "Corporate Operating Units to be changed.", + "$ref": "#/definitions/corporateOperatingUnitsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "childAgeType": { - "description": "Defines Child's Age.", + "templateCountriesDetails": { "type": "object", + "description": "Response object for fetching template Countries.", "properties": { - "age": { - "description": "Age of a child in years.", - "type": "integer" + "templateCountries": { + "description": "Collection of template Countries.", + "$ref": "#/definitions/templateCountriesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "childAgesType": { - "description": "Age of a child in years.", + "templateCountriesType": { "type": "array", + "description": "Template of country details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/childAgeType" + "$ref": "#/definitions/templateCountryType" } }, - "childBucketsType": { - "description": "Defines children counts with Age Qualifying Group(Child Bucket) classification.", + "templateCountryType": { "type": "object", + "description": "Base details of the country", "properties": { - "bucket1Count": { - "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).", - "type": "integer" + "name": { + "description": "Name for the country.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "bucket2Count": { - "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).", - "type": "integer" + "statisticCode": { + "description": "Statistic code for the country.", + "type": "string", + "minLength": 0, + "maxLength": 3 }, - "bucket3Count": { - "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).", - "type": "integer" + "guestAddressFormat": { + "description": "Guest Address format Codes for confirmation letter.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "bucket4Count": { - "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).", - "type": "integer" + "addressDoctorMode": { + "description": "Defines the mode used to invoke address doctor service.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "bucket5Count": { - "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).", - "type": "integer" - } - } - }, - "cityHotelInfoType": { - "type": "object", - "properties": { - "hotelId": { - "description": "Hotels under this Marketing City.", + "mainGroup": { + "description": "Main Group of Country. Used in statistic reports.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "name": { - "description": "Hotel Name for the Hotel Code.", + "regionCode": { + "description": "Regin to which the Country belongs.", + "type": "string", + "minLength": 0, + "maxLength": 3 + }, + "isoCode": { + "description": "ISO standard code for country.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "isoName": { + "description": "ISO standard name for country.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "displaySequence": { + "description": "Sequence number for displaying the countries.", + "type": "number" + }, + "printSequence": { + "description": "Print Sequence number for report.", + "type": "number" + }, + "displayFlag": { + "description": "Indicates if the country flag should be displayed.", + "type": "boolean" + }, + "countryCode": { + "description": "Country code identifying the country.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "codeDescriptionType": { - "description": "This contains a generic code and description information.", + "templateCountriesCriteria": { "type": "object", + "description": "Request object for creating new template Countries.", "properties": { - "code": { - "description": "Code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "templateCountries": { + "description": "Collection of template of Countries to be created.", + "$ref": "#/definitions/templateCountriesType" }, - "description": { - "description": "description.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "codeInfoType": { + "countryGuestTypesDetails": { "type": "object", + "description": "Response object for fetching Philippines Country Guest Types.", "properties": { - "addtionalCodeInfo": { - "$ref": "#/definitions/addtionalCodeInfoType" - }, - "code": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "countryGuestTypes": { + "description": "Collection of Philippines Country Guest Types.", + "$ref": "#/definitions/countryGuestTypesType" }, - "description": { - "type": "string", - "maxLength": 80, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "hotelId": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "codeListType": { + "countryGuestTypesType": { "type": "array", + "description": "List of Philippines Country specific Guest Types.", "maxItems": 4000, "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "$ref": "#/definitions/countryGuestTypeType" } }, - "codeType": { - "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "colorType": { - "description": "Color configuration type. This color configuration provides a visual category of entities.", - "type": "string", - "enum": [ - "Red", - "DarkRed", - "Green", - "DarkGreen", - "LightGreen", - "Orange", - "White", - "Yellow", - "DarkYellow", - "Purple", - "Brown", - "Gray", - "Aqua", - "Chocolate", - "Blue", - "LightBlue", - "DarkBlue", - "Cyan", - "DarkCyan", - "Magenta", - "DarkMagenta", - "Black" - ] - }, - "commentInfoType": { - "description": "Comment related to the profile/reservation.", + "countryGuestTypeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "comment": { - "description": "Comment details for the comment. It will be empty in case of delete comment.", - "$ref": "#/definitions/commentType" - }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "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", - "maxLength": 80, - "minLength": 0 - }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", + "code": { + "description": "Common Master unique code.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 40 }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "commentType": { - "description": "An indication of a new paragraph for a sub-section of a formatted text message.", + "countryGuestTypesCriteria": { "type": "object", + "description": "Request object for creating Country Guest Types.", "properties": { - "actionDate": { - "description": "Indicates at which date an action described in the comment must be taken.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "actionType": { - "description": "Specifies type of action described in the comments.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "commentTitle": { - "description": "Specifies Comment's Title.", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "confidential": { - "description": "When true, the comment may be confidential.", - "type": "boolean" - }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "hotelId": { - "description": "If specified comment belongs to the Hotel, otherwise it is a global comment.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "image": { - "description": "An image for this paragraph.", - "type": "string" - }, - "internal": { - "description": "When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.", - "type": "boolean" - }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "countryGuestTypes": { + "description": "Philippines Country Guest Types to be created.", + "$ref": "#/definitions/countryGuestTypesType" }, - "notificationLocation": { - "description": "Notification Location associated with the Note.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "overrideInternal": { - "description": "When true, the note internal could be modified.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "countryGuestTypesToBeChanged": { + "type": "object", + "description": "Request object for changing Philippines Country Guest Types.", + "properties": { + "countryGuestTypes": { + "description": "Philippines Country Guest Types to be changed.", + "$ref": "#/definitions/countryGuestTypesType" }, - "protectDescription": { - "description": "When true, the note title will be populated from the note type description and couldn't be modified.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "templateCountriesToBeChanged": { + "type": "object", + "description": "Request object for modifying template Countries.", + "properties": { + "templateCountries": { + "description": "Collection of template of Countries to be modified.", + "$ref": "#/definitions/templateCountriesType" }, - "text": { - "description": "Formatted text content.", - "$ref": "#/definitions/formattedTextTextType" + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "Specifies type of the comment.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "countryMainGroupsDetails": { + "type": "object", + "description": "Response object for fetching Country Main Groups.", + "properties": { + "countryMainGroups": { + "description": "Collection of Country Main Groups.", + "$ref": "#/definitions/countryMainGroupsType" }, - "typeDescription": { - "description": "Comment type Description.", - "type": "string", - "maxLength": 200, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "url": { - "description": "A URL for this paragraph.", - "type": "string" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "commissionPaymentMethods": { - "description": "Check", - "type": "string", - "enum": [ - "Cent", - "Eft", - "Chk" - ] - }, - "commissionPayoutToType": { - "type": "string", - "enum": [ - "TravelAgent", - "Source", - "TravelAgentSource", - "None" - ] + "countryMainGroupsType": { + "type": "array", + "description": "List of Country Main Groups.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/countryMainGroupType" + } }, - "communicationMethodsEntDetailType": { - "description": "Contains Common Master configuration detail.", + "countryMainGroupType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -40030,13 +34992,13 @@ } } }, - "communicationMethodsEntDetailsCriteria": { - "description": "Request object for creating Communication Methods Ent Details.", + "countryMainGroupsCriteria": { "type": "object", + "description": "Request object for creating Country Main Groups.", "properties": { - "communicationMethodsEntDetails": { - "description": "Communication Methods Ent Detailsto be created.", - "$ref": "#/definitions/communicationMethodsEntDetailsType" + "countryMainGroups": { + "description": "Country Main Groups to be created.", + "$ref": "#/definitions/countryMainGroupsType" }, "links": { "$ref": "#/definitions/links" @@ -40046,13 +35008,13 @@ } } }, - "communicationMethodsEntDetailsDetails": { - "description": "Response object for fetching Communication Methods Ent Details.", + "countryMainGroupsToBeChanged": { "type": "object", + "description": "Request object for changing Country Main Groups.", "properties": { - "communicationMethodsEntDetails": { - "description": "Collection of Communication Methods Ent Details.", - "$ref": "#/definitions/communicationMethodsEntDetailsType" + "countryMainGroups": { + "description": "Country Main Groups to be changed.", + "$ref": "#/definitions/countryMainGroupsType" }, "links": { "$ref": "#/definitions/links" @@ -40062,13 +35024,28 @@ } } }, - "communicationMethodsEntDetailsToBeChanged": { - "description": "Request object for changing Communication Methods Ent Details.", + "currencyExchangeRatesDetails": { "type": "object", + "description": "Response with the list of currency codes and their exchange rates for each property requested.", "properties": { - "communicationMethodsEntDetails": { - "description": "Communication Methods Ent Detailsto be changed.", - "$ref": "#/definitions/communicationMethodsEntDetailsType" + "exchangeRates": { + "description": "List of currency codes with their exchange rates.", + "type": "array", + "items": { + "type": "object", + "properties": { + "exchangeInfo": { + "description": "Exchange Rate information for a currency code.", + "type": "array", + "items": { + "$ref": "#/definitions/currencyExchangeRateType" + } + }, + "hotelId": { + "$ref": "#/definitions/codeType" + } + } + } }, "links": { "$ref": "#/definitions/links" @@ -40078,184 +35055,141 @@ } } }, - "communicationMethodsEntDetailsType": { - "description": "List of Communication Methods Ent Details.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/communicationMethodsEntDetailType" - } - }, - "communicationStatusType": { - "description": "Enum to denote the Status of Readiness messages sent to Guest Devices.", - "type": "string", - "enum": [ - "Pending", - "Completed", - "Failed", - "Sent", - "Received", - "Cancelled", - "PendingAvailability" - ] - }, - "companyInfoType": { - "description": "Company Information of the Profile.", + "currencyExchangeRateType": { "type": "object", + "description": "Currency code configuration.", "properties": { - "department": { - "description": "Department of the Profile.", + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "legalCompany": { - "description": "Legal Company.", + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 10 }, - "position": { - "description": "Business Title or Position of the profile.", + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "type": "integer" + }, + "description": { + "description": "Description of the currency code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 + }, + "exchangeRate": { + "description": "Exchange Rate for the currency code. Exchange rate is based on the current business date of the property.", + "$ref": "#/definitions/currencyAmountType" } } }, - "companyType": { + "currencyAmountType": { "type": "object", + "description": "A monetary value expressed with a currency code.", "properties": { - "alternateLanguage": { - "description": "Alternate Language of the company.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "alternateName": { - "description": "Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "blacklist": { - "description": "This element tells if profile is blacklisted or not.", - "type": "boolean" + "amount": { + "description": "A monetary amount.", + "type": "number" }, - "businessLocale": { - "description": "A jurisdiction(Territory) in which a company is authorized to do business.", + "currencyCode": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "businessTitle": { - "description": "Business Title.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "commissionCode": { - "description": "Commission code of the company.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "companyName": { - "description": "Name of the company.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "companyName2": { - "description": "Second Name of the company.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "companyName3": { - "description": "Third Name of the company.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "corporateIdType": { - "description": "The type of corporate ID", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "creditRating": { - "description": "Credit Rating of the company.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 3, + "maxLength": 3 + } + } + }, + "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 + }, + "templateDayTypeCodesDetails": { + "type": "object", + "description": "Response object for fetching template day type codes.", + "properties": { + "templateDayTypeCodes": { + "description": "Collection of template level day type codes.", + "$ref": "#/definitions/templateDayTypeCodesType" }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "templateDayTypeCodesType": { + "type": "array", + "description": "Details for day type code at template level.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/templateDayTypeCodeType" + } + }, + "templateDayTypeCodeType": { + "type": "object", + "description": "Base structure for Day Type Code at both template and hotel levels.", + "properties": { + "code": { + "description": "Code of a Day Type.", "type": "string", - "maxLength": 10, - "minLength": 0 - }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", - "type": "integer" - }, - "iATAInfo": { - "description": "IATA Information of the profile.", - "$ref": "#/definitions/iATAInfoType" + "minLength": 0, + "maxLength": 20 }, - "language": { - "description": "Language identification.", + "description": { + "description": "Description of a Day Type.", "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "minLength": 0, + "maxLength": 100 }, - "nationality": { - "description": "Nationality code identification", - "type": "string", - "maxLength": 20, - "minLength": 0 + "multiplier": { + "description": "Value by which the rates will be multiplied on a day.", + "type": "number" }, - "nationalityDescription": { - "description": "Nationality code description", - "type": "string", - "maxLength": 80, - "minLength": 0 + "adder": { + "description": "Value that will be added to rate on a day.", + "type": "number" }, - "vipDescription": { - "description": "Description of the VIP status.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "color": { + "description": "Color used to represent Day Type.", + "$ref": "#/definitions/colorType" }, - "vipStatus": { - "description": "VIP status of the company.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "sellSequence": { + "description": "Sell sequence for a Day Type.", + "type": "number" } } }, - "configActivitiesType": { - "description": "Changes log record to import/Export/Delete customization operations.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/configActivityType" + "templateDayTypeCodesToBeChanged": { + "type": "object", + "description": "Request object for modifying template day type codes.", + "properties": { + "templateDayTypeCodes": { + "description": "Collection of template day type codes to be changed.", + "$ref": "#/definitions/templateDayTypeCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "configActivityLogDetails": { - "description": "Response object for fetching configuration activity log.", + "templateDayTypeCodesCriteria": { "type": "object", + "description": "Request object for creating new template day type codes.", "properties": { - "activityLog": { - "description": "Contains list of the activity logs.", - "$ref": "#/definitions/activityLogListType" + "templateDayTypeCodes": { + "description": "Collection of template day type codes to be created.", + "$ref": "#/definitions/templateDayTypeCodesType" }, "links": { "$ref": "#/definitions/links" @@ -40265,259 +35199,230 @@ } } }, - "configActivityType": { - "description": "Changes log record to import/Export/Delete customization operations.", + "setDayTypes": { "type": "object", + "description": "Request object for setting day type for specified date range.", "properties": { - "actionDescription": { - "description": "action, layer, org name, user name and screen name or file name or path.", - "type": "string", - "maxLength": 200, - "minLength": 0 + "hotelDayTypes": { + "description": "Collection of day type entries to be created for specified date range.", + "$ref": "#/definitions/hotelDayTypesType" }, - "actionType": { - "description": "Action Type: MDS_IMP, MDS_EXP, MDS_DEL, MDS_EXP_UNENC, MDS_IMP_UNENC.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "hotelId": { - "description": "Code that uniquely identifies the hotel belonging to the organization.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "configHotelAmenitiesType": { - "description": "This type holds a collection of amenities at the property level.", + "hotelDayTypesType": { "type": "array", + "description": "Collection of type details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/configHotelAmenityType" + "$ref": "#/definitions/hotelDayTypeType" } }, - "configHotelAmenityType": { - "description": "Base details used for amenities.", + "hotelDayTypeType": { "type": "object", + "description": "Details of Day Type to be used to set day types for a hotel.", "properties": { - "amenityType": { - "description": "The type of amenity (general or meeting) selected from the list of values.", - "$ref": "#/definitions/amenityTypeType" - }, - "beginDate": { - "description": "The date the amenity is scheduled to become active.", + "hotelId": { + "description": "Day type code selected.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "comments": { - "description": "The comments about amenity of the hotel.", + "dayTypeCode": { + "description": "Day type code selected.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "The description about amenity of the hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "dateRange": { + "description": "Date Range with days of week where the range update has to be applied.", + "$ref": "#/definitions/timeSpanDaysOfWeekType" + } + } + }, + "timeSpanDaysOfWeekType": { + "type": "object", + "description": "Container for Time span with days of week.", + "properties": { + "timeSpan": { + "$ref": "#/definitions/timeSpanType" }, - "endDate": { - "description": "The date the amenity is scheduled to become inactive.", - "type": "string", - "format": "date", - "maxLength": 8 + "sunday": { + "type": "boolean" }, - "featureCode": { - "description": "Specifies the feature code (aka amenity code).", - "type": "string", - "maxLength": 20, - "minLength": 0 + "monday": { + "type": "boolean" }, - "hotelId": { - "description": "Specifies the hotel code for which the amenity is specified.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "tuesday": { + "type": "boolean" }, - "hours": { - "description": "The hours of operation of the amenity in the hotel.", - "type": "string", - "maxLength": 1000, - "minLength": 0 + "wednesday": { + "type": "boolean" }, - "newAmenityCode": { - "description": "The new amenity code which is used in the change method.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "thursday": { + "type": "boolean" }, - "newBeginDate": { - "description": "The new date the amenity is scheduled to become active.", + "friday": { + "type": "boolean" + }, + "saturday": { + "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 }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" - }, - "priceRange": { - "description": "The price range of the amenity in the hotel.", + "endDate": { "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date", + "maxLength": 8 + }, + "duration": { + "type": "string" } } }, - "configLanguageType": { - "description": "This gives detailed information about a language.", + "defaultNoteDetails": { "type": "object", + "description": "Response object for fetching Default Application Note text.", "properties": { - "description": { - "description": "Description gives the full text language name associated with the code.", - "$ref": "#/definitions/translationTextType50" - }, - "languageCode": { - "description": "Language Code is a user definable code that identifies a language.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "locale": { - "description": "Geographic, political or cultural region.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "defaultNote": { + "description": "Default Application Note text details.", + "$ref": "#/definitions/defaultNoteTextDetailType" }, - "localeDescription": { - "description": "Description for the locale.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "reportDateLanguage": { - "description": "Report Date Language if filled will represent correctly in the report language date elements that might be spelled out, like the day-of-week or the month.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "defaultNoteTextDetailType": { + "type": "object", + "description": "Default Note Text Information Type.", + "properties": { + "hotelId": { + "description": "Indicates the Property for which the Default Note Text is specified.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "translationLanguageCode": { - "description": "Translation Language Code is required for the Translation Studio program to display language into which object has been translated.", + "defaultNoteText": { + "description": "Default Note Text if Note Type has default note.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "useAsAlternateLanguage": { - "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", - "type": "boolean" + "minLength": 0, + "maxLength": 2000 } } }, - "configLanguagesType": { - "description": "This type holds a collection of languages.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/configLanguageType" + "departmentsDetails": { + "type": "object", + "description": "Response object for fetching departments.", + "properties": { + "departments": { + "description": "Type contains departments.", + "$ref": "#/definitions/departmentsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "configTemplateAmenitiesType": { - "description": "This type holds a collection of amenities at the template level.", + "departmentsType": { "type": "array", + "description": "Collection of departments.", "maxItems": 4000, "items": { - "$ref": "#/definitions/configTemplateAmenityType" + "$ref": "#/definitions/departmentType" } }, - "configTemplateAmenityType": { - "description": "Base details used for amenities.", + "departmentType": { "type": "object", + "description": "Type provides department information.", "properties": { - "amenityType": { - "description": "The type of amenity (general or meeting) selected from the list of values.", - "$ref": "#/definitions/amenityTypeType" - }, - "beginDate": { - "description": "The date the amenity is scheduled to become active.", + "hotelId": { + "description": "Property Code where the department belongs to.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "comments": { - "description": "The comments about amenity of the hotel.", + "departmentCode": { + "description": "Department Code.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 10 }, - "description": { - "description": "The description about amenity of the hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "departmentName": { + "description": "Description of the department.", + "$ref": "#/definitions/translationTextType30" }, - "endDate": { - "description": "The date the amenity is scheduled to become inactive.", - "type": "string", - "format": "date", - "maxLength": 8 + "displaySequence": { + "description": "Display Sequence for the department.", + "type": "integer" }, - "featureCode": { - "description": "Specifies the feature code (aka amenity code).", + "email": { + "description": "Department email address.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "newChainCode": { - "description": "The new chain code which is used in the change method.", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "translationTextType30": { + "type": "object", + "description": "Contains Multiple translated texts and language codes.", + "properties": { + "defaultText": { + "description": "Default text with Character length from 0 to 30.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 30 }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "translatedTexts": { + "description": "List of translated text and language codes.", + "$ref": "#/definitions/translationsTextType" } } }, - "copyConfigurationCodeType": { - "description": "Information needed to copy configuration code from one property to the other.", + "departmentsCriteria": { "type": "object", + "description": "Request object for creating new departments.", "properties": { - "code": { - "description": "Source hotel code from which code is to be copied from.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "departments": { + "description": "Departments to be created.", + "$ref": "#/definitions/departmentsType" }, - "sourceHotelCode": { - "description": "Code that is to be copied.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "targetHotelCode": { - "description": "Property to which configuration code type to be copied to.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 - } + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "copyDepartments": { + "departmentsToBeChanged": { "type": "object", + "description": "Request object for updating departments.", "properties": { "departments": { - "description": "List of the departments to be copied.", - "type": "array", - "items": { - "$ref": "#/definitions/copyConfigurationCodeType" - } + "description": "Departments to be modified.", + "$ref": "#/definitions/departmentsType" }, "links": { "$ref": "#/definitions/links" @@ -40527,13 +35432,13 @@ } } }, - "copyHotelDetails": { - "description": "Request object for copying template hotel details to hotel(s).", + "hotelCategoriesDetails": { "type": "object", + "description": "Response object for fetching Hotel Categories.", "properties": { - "copyInstructions": { - "description": "List of the template hotel details to be copied to hotel(s).", - "$ref": "#/definitions/copyHotelDetailsType" + "hotelCategories": { + "description": "Collection of Hotel Categories.", + "$ref": "#/definitions/hotelCategoriesType" }, "links": { "$ref": "#/definitions/links" @@ -40543,27 +35448,41 @@ } } }, - "copyHotelDetailsType": { - "description": "Instructions for copying template hotel details to hotel(s).", + "hotelCategoriesType": { + "type": "array", + "description": "List of Hotel Categories.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelCategoryType" + } + }, + "hotelCategoryType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "hotels": { - "description": "Hotel codes to copy the template hotel details to.", - "$ref": "#/definitions/codeListType" + "code": { + "description": "Common Master unique code.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "templateHotelDetails": { - "description": "Template hotel details to be copied to the hotel(s).", - "$ref": "#/definitions/templateHotelDetailsIDType" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" + }, + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "copyMarketingCities": { - "description": "Request object for copying template marketing cities to hotel(s).", + "hotelCategoriesCriteria": { "type": "object", + "description": "Request object for creating Hotel Categories.", "properties": { - "copyInstructions": { - "description": "List of the template marketing city(s) to be copied to hotel(s).", - "$ref": "#/definitions/copyMarketingCitiesType" + "hotelCategories": { + "description": "Hotel Categories to be created.", + "$ref": "#/definitions/hotelCategoriesType" }, "links": { "$ref": "#/definitions/links" @@ -40573,321 +35492,115 @@ } } }, - "copyMarketingCitiesType": { - "description": "Copy instructions for template marketing cities to hotel(s).", + "hotelCategoriesToBeChanged": { "type": "object", + "description": "Request object for changing Hotel Categories.", "properties": { - "hotelCodes": { - "description": "Hotel codes to copy the marketing city templates to.", - "$ref": "#/definitions/codeListType" + "hotelCategories": { + "description": "Hotel Categories to be changed.", + "$ref": "#/definitions/hotelCategoriesType" }, - "templateMarketingCities": { - "description": "Marketing city template to be copied to the hotel(s).", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/templateMarketingCityInfoType" - } + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "copyTemplateCodes": { + "templateHotelDetailsDetails": { "type": "object", + "description": "Response object for fetching hotel details at the template level.", "properties": { - "codes": { - "description": "List of template codes to be copied.", - "$ref": "#/definitions/codeListType" - }, - "hotelCodes": { - "description": "List of hotel codes for which the template needs to be copied.", - "$ref": "#/definitions/hotelCodeListType" + "templateHotelDetails": { + "description": "Collection of hotel details specified at the template level.", + "$ref": "#/definitions/templateHotelDetailsType" }, "links": { "$ref": "#/definitions/links" }, - "templateName": { - "description": "Template name to be copied.", - "$ref": "#/definitions/copyTemplateType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "copyTemplateType": { - "description": "Template name for template copy operation. Eg: RateCategory", - "type": "string", - "enum": [ - "RateCategory", - "PromotionCode", - "RateClass", - "DepositPolicy", - "CancellationPolicy", - "GuaranteeCode", - "MarketCode", - "MarketGroup", - "SourceCode", - "SourceGroup", - "RoomType", - "RoomClass", - "CustomNumbers", - "AlertCode", - "AttractionCode", - "Transportation", - "RoomCondition", - "RateSeason", - "Amenity", - "TransactionCode", - "CompTransactionCode", - "PkgForecastGroup", - "RoomMaintenance", - "DayTypeCode", - "TurnawayCodes", - "EventCode", - "MessageCode", - "Airport", - "OutOfService", - "Floor", - "TransactionGroup", - "LocatorCode", - "RoomFeatures", - "JobTitle", - "DeviceLocations", - "ShiftDropLocations", - "HousekeepingTasks" - ] - }, - "copyYieldAdjustmentCodes": { - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - }, - "yieldAdjustmentCodes": { - "description": "List of the Yield AdjustmentCodes to be copied.", - "type": "array", - "items": { - "$ref": "#/definitions/copyConfigurationCodeType" - } - } - } - }, - "copyYieldCategories": { - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - }, - "yieldCategories": { - "description": "List of the Yield Category to be copied.", - "type": "array", - "items": { - "$ref": "#/definitions/copyConfigurationCodeType" - } - } - } - }, - "corporateBusinessUnitType": { - "description": "Contains Common Master configuration detail.", - "type": "object", - "properties": { - "code": { - "description": "Common Master unique code.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" - }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "corporateBusinessUnitsCriteria": { - "description": "Request object for creating Corporate Business Units.", - "type": "object", - "properties": { - "corporateBusinessUnits": { - "description": "Corporate Business Units to be created.", - "$ref": "#/definitions/corporateBusinessUnitsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "corporateBusinessUnitsDetails": { - "description": "Response object for fetching Corporate Business Units.", - "type": "object", - "properties": { - "corporateBusinessUnits": { - "description": "Collection of Corporate Business Units.", - "$ref": "#/definitions/corporateBusinessUnitsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "corporateBusinessUnitsToBeChanged": { - "description": "Request object for changing Corporate Business Units.", - "type": "object", - "properties": { - "corporateBusinessUnits": { - "description": "Corporate Business Units to be changed.", - "$ref": "#/definitions/corporateBusinessUnitsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "corporateBusinessUnitsType": { - "description": "List of Corporate Business Units.", + "templateHotelDetailsType": { "type": "array", + "description": "Collection of template level hotel details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/corporateBusinessUnitType" + "$ref": "#/definitions/templateHotelDetailType" } }, - "corporateDepartmentCodeType": { - "description": "Contains Common Master configuration detail.", + "templateHotelDetailType": { "type": "object", + "description": "Base details used for storing information about a hotel detail.", "properties": { "code": { - "description": "Common Master unique code.", + "description": "Specifies the hotel detail code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" - }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "corporateDepartmentCodesCriteria": { - "description": "Request object for creating Corporate Department Codes.", - "type": "object", - "properties": { - "corporateDepartmentCodes": { - "description": "Corporate Department Codes to be created.", - "$ref": "#/definitions/corporateDepartmentCodesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "corporateDepartmentCodesDetails": { - "description": "Response object for fetching Corporate Department Codes.", - "type": "object", - "properties": { - "corporateDepartmentCodes": { - "description": "Collection of Corporate Department Codes.", - "$ref": "#/definitions/corporateDepartmentCodesType" - }, - "links": { - "$ref": "#/definitions/links" + "description": "Specifies the hotel detail description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "corporateDepartmentCodesToBeChanged": { - "description": "Request object for changing Corporate Department Codes.", - "type": "object", - "properties": { - "corporateDepartmentCodes": { - "description": "Corporate Department Codes to be changed.", - "$ref": "#/definitions/corporateDepartmentCodesType" + "category": { + "description": "Specifies the hotel detail category.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "sequence": { + "description": "Specifies the sorting sequence number for the hotel detail.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "templateHotelDetailValues": { + "description": "Collection of values which are associated with the hotel detail.", + "$ref": "#/definitions/templateHotelDetailValuesType" } } }, - "corporateDepartmentCodesType": { - "description": "List of Corporate Department Codes.", + "templateHotelDetailValuesType": { "type": "array", + "description": "Collection of template level hotel detail values.", "maxItems": 4000, "items": { - "$ref": "#/definitions/corporateDepartmentCodeType" + "$ref": "#/definitions/templateHotelDetailValueType" } }, - "corporateDivisionType": { - "description": "Contains Common Master configuration detail.", + "templateHotelDetailValueType": { "type": "object", + "description": "This type holds the base information of the hotel detail value which will be associated with a hotel detail.", "properties": { "code": { - "description": "Common Master unique code.", + "description": "Specifies the hotel detail value code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" - }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "corporateDivisionsCriteria": { - "description": "Request object for creating Corporate Divisions.", - "type": "object", - "properties": { - "corporateDivisions": { - "description": "Corporate Divisions to be created.", - "$ref": "#/definitions/corporateDivisionsType" - }, - "links": { - "$ref": "#/definitions/links" + "description": "Specifies the description of the hotel detail value.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "sequence": { + "description": "Specifies the sorting sequence number for the hotel detail value.", + "type": "integer" } } }, - "corporateDivisionsDetails": { - "description": "Response object for fetching Corporate Divisions.", + "templateHotelDetailsCriteria": { "type": "object", + "description": "Request object for creating hotel details at the template level.", "properties": { - "corporateDivisions": { - "description": "Collection of Corporate Divisions.", - "$ref": "#/definitions/corporateDivisionsType" + "templateHotelDetails": { + "description": "Collection containing information of hotel details to be created at the template level.", + "$ref": "#/definitions/templateHotelDetailsType" }, "links": { "$ref": "#/definitions/links" @@ -40897,13 +35610,13 @@ } } }, - "corporateDivisionsToBeChanged": { - "description": "Request object for changing Corporate Divisions.", + "templateHotelDetailsToBeChanged": { "type": "object", + "description": "Request object for changing hotel details at the template level.", "properties": { - "corporateDivisions": { - "description": "Corporate Divisions to be changed.", - "$ref": "#/definitions/corporateDivisionsType" + "templateHotelDetails": { + "description": "Collection containing information of hotel details to be changed at the template level.", + "$ref": "#/definitions/templateHotelDetailsType" }, "links": { "$ref": "#/definitions/links" @@ -40913,41 +35626,13 @@ } } }, - "corporateDivisionsType": { - "description": "List of Corporate Divisions.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/corporateDivisionType" - } - }, - "corporateOperatingUnitType": { - "description": "Contains Common Master configuration detail.", - "type": "object", - "properties": { - "code": { - "description": "Common Master unique code.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" - }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "corporateOperatingUnitsCriteria": { - "description": "Request object for creating Corporate Operating Units.", + "copyHotelDetails": { "type": "object", + "description": "Request object for copying template hotel details to hotel(s).", "properties": { - "corporateOperatingUnits": { - "description": "Corporate Operating Units to be created.", - "$ref": "#/definitions/corporateOperatingUnitsType" + "copyInstructions": { + "description": "List of the template hotel details to be copied to hotel(s).", + "$ref": "#/definitions/copyHotelDetailsType" }, "links": { "$ref": "#/definitions/links" @@ -40957,93 +35642,61 @@ } } }, - "corporateOperatingUnitsDetails": { - "description": "Response object for fetching Corporate Operating Units.", + "copyHotelDetailsType": { "type": "object", + "description": "Instructions for copying template hotel details to hotel(s).", "properties": { - "corporateOperatingUnits": { - "description": "Collection of Corporate Operating Units.", - "$ref": "#/definitions/corporateOperatingUnitsType" - }, - "links": { - "$ref": "#/definitions/links" + "hotels": { + "description": "Hotel codes to copy the template hotel details to.", + "$ref": "#/definitions/codeListType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "templateHotelDetails": { + "description": "Template hotel details to be copied to the hotel(s).", + "$ref": "#/definitions/templateHotelDetailsIDType" } } }, - "corporateOperatingUnitsToBeChanged": { - "description": "Request object for changing Corporate Operating Units.", - "type": "object", - "properties": { - "corporateOperatingUnits": { - "description": "Corporate Operating Units to be changed.", - "$ref": "#/definitions/corporateOperatingUnitsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "codeListType": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 } }, - "corporateOperatingUnitsType": { - "description": "List of Corporate Operating Units.", + "templateHotelDetailsIDType": { "type": "array", + "description": "Collection of template level hotel detail identifiers.", "maxItems": 4000, "items": { - "$ref": "#/definitions/corporateOperatingUnitType" + "$ref": "#/definitions/templateHotelDetailIDType" } }, - "countriesDetails": { - "description": "Response object for fetching Countries.", + "templateHotelDetailIDType": { "type": "object", + "description": "Base details used for uniquely identifying a hotel detail.", "properties": { - "count": { - "description": "Total number of rows returned", - "type": "integer" - }, - "countries": { - "description": "Collection of Countries.", - "$ref": "#/definitions/countriesType" - }, - "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" - }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" - }, - "links": { - "$ref": "#/definitions/links" - }, - "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" - }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "code": { + "description": "Specifies the hotel detail code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "category": { + "description": "Specifies the hotel detail category.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "countriesToBeChanged": { - "description": "Request object for modifying Countries for hotels.", + "hotelsDetails": { "type": "object", + "description": "Response object for fetching lists of Property summary information.", "properties": { - "countries": { - "description": "Collection of Countries to be modified.", - "$ref": "#/definitions/countriesType" + "hotelSummaryInfoList": { + "$ref": "#/definitions/hotelsSummaryType" }, "links": { "$ref": "#/definitions/links" @@ -41053,73 +35706,70 @@ } } }, - "countriesType": { - "description": "Country details.", + "hotelsSummaryType": { "type": "array", + "description": "Lists of Hotel summary information.", "maxItems": 4000, "items": { - "$ref": "#/definitions/countryType" + "$ref": "#/definitions/hotelSummaryType" } }, - "countryGuestTypeType": { - "description": "Contains Common Master configuration detail.", + "hotelSummaryType": { "type": "object", + "description": "A brief summary of information about a hotel.", "properties": { - "code": { - "description": "Common Master unique code.", + "hotelId": { + "description": "Code identifying the hotel.", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "minLength": 0, + "maxLength": 20 }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "countryGuestTypesCriteria": { - "description": "Request object for creating Country Guest Types.", - "type": "object", - "properties": { - "countryGuestTypes": { - "description": "Philippines Country Guest Types to be created.", - "$ref": "#/definitions/countryGuestTypesType" + "hotelName": { + "description": "The name of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "links": { - "$ref": "#/definitions/links" + "activeDate": { + "description": "Date when the hotel becomes valid for use.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "countryGuestTypesDetails": { - "description": "Response object for fetching Philippines Country Guest Types.", - "type": "object", - "properties": { - "countryGuestTypes": { - "description": "Collection of Philippines Country Guest Types.", - "$ref": "#/definitions/countryGuestTypesType" + "inactiveDate": { + "description": "Date when the hotel becomes invalid for use.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "links": { - "$ref": "#/definitions/links" + "chainCode": { + "description": "Hotels Chain Code. This attribute uniquely assign Hotel to a single chain.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "propertyType": { + "description": "Property Type Description. The property type defined for the hotel", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "countryGuestTypesToBeChanged": { - "description": "Request object for changing Philippines Country Guest Types.", + "hotelDetails": { "type": "object", + "description": "Response object for fetching Property configuration information.", "properties": { - "countryGuestTypes": { - "description": "Philippines Country Guest Types to be changed.", - "$ref": "#/definitions/countryGuestTypesType" + "hotelConfigInfo": { + "description": "Hotel configuration information.", + "$ref": "#/definitions/hotelInfoType" + }, + "masterInfoList": { + "description": "Refer to Generic common types document.", + "type": "array", + "items": { + "$ref": "#/definitions/masterInfoType" + } }, "links": { "$ref": "#/definitions/links" @@ -41129,1527 +35779,1419 @@ } } }, - "countryGuestTypesType": { - "description": "List of Philippines Country specific Guest Types.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/countryGuestTypeType" - } - }, - "countryMainGroupType": { - "description": "Contains Common Master configuration detail.", + "hotelInfoType": { "type": "object", + "description": "Contains the basic configuration information about a Hotel.", "properties": { - "code": { - "description": "Common Master unique code.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "primaryDetails": { + "description": "Primary Information of the hotel.", + "type": "object", + "properties": { + "legalOwner": { + "description": "Legal owner of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "countryMainGroupsCriteria": { - "description": "Request object for creating Country Main Groups.", - "type": "object", - "properties": { - "countryMainGroups": { - "description": "Country Main Groups to be created.", - "$ref": "#/definitions/countryMainGroupsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "countryMainGroupsDetails": { - "description": "Response object for fetching Country Main Groups.", - "type": "object", - "properties": { - "countryMainGroups": { - "description": "Collection of Country Main Groups.", - "$ref": "#/definitions/countryMainGroupsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "countryMainGroupsToBeChanged": { - "description": "Request object for changing Country Main Groups.", - "type": "object", - "properties": { - "countryMainGroups": { - "description": "Country Main Groups to be changed.", - "$ref": "#/definitions/countryMainGroupsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "countryMainGroupsType": { - "description": "List of Country Main Groups.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/countryMainGroupType" - } - }, - "countryNameType": { - "description": "Code for a country or a nationality.", - "type": "object", - "properties": { - "code": { - "description": "Code for a country or a nationality.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "value": { - "description": "Used for Character Strings, length 0 to 200.", - "type": "string", - "maxLength": 200, - "minLength": 0 - } - } - }, - "countryType": { - "description": "Base details of the country.", - "type": "object", - "properties": { - "addressDoctorMode": { - "description": "Defines the mode used to invoke address doctor service.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "countryCode": { - "description": "Country code identifying the country.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "displayFlag": { - "description": "Indicates if the country flag should be displayed.", - "type": "boolean" - }, - "displaySequence": { - "description": "Sequence number for displaying the countries.", - "type": "number" - }, - "guestAddressFormat": { - "description": "Guest Address format Codes for confirmation letter.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "hotelId": { - "description": "Hotel code the country belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "isoCode": { - "description": "ISO standard code for country.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "isoName": { - "description": "ISO standard name for country.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "mainGroup": { - "description": "Main Group of Country. Used in statistic reports.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "name": { - "description": "Name for the country.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "printSequence": { - "description": "Print Sequence number for report.", - "type": "number" - }, - "regionCode": { - "description": "Regin to which the Country belongs.", - "type": "string", - "maxLength": 3, - "minLength": 0 - }, - "statisticCode": { - "description": "Statistic code for the country.", - "type": "string", - "maxLength": 3, - "minLength": 0 - } - } - }, - "createConfigActivityLogCriteria": { - "description": "Request object for creating Config Activity Logs.", - "type": "object", - "properties": { - "configActivities": { - "description": "Confic Activity Logs to be created.", - "$ref": "#/definitions/configActivitiesType" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "creditCardTypeType": { - "description": "Contains Common Master configuration detail.", - "type": "object", - "properties": { - "code": { - "description": "Common Master unique code.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "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", - "maxLength": 20, - "minLength": 0 - } - } - }, - "creditCardTypesCriteria": { - "description": "Request object for creating Credit Card Types.", - "type": "object", - "properties": { - "creditCardTypes": { - "description": "Credit Card Types to be created.", - "$ref": "#/definitions/creditCardTypesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "creditCardTypesDetails": { - "description": "Response object for fetching Credit Card Types.", - "type": "object", - "properties": { - "creditCardTypes": { - "description": "Collection of Credit Card Types.", - "$ref": "#/definitions/creditCardTypesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "creditCardTypesToBeChanged": { - "description": "Request object for changing Credit Card Types.", - "type": "object", - "properties": { - "creditCardTypes": { - "description": "Credit Card Types to be changed.", - "$ref": "#/definitions/creditCardTypesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "creditCardTypesType": { - "description": "List of Credit Card Types.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/creditCardTypeType" - } - }, - "currencyAmountType": { - "description": "A monetary value expressed with a currency code.", - "type": "object", - "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", - "maxLength": 3, - "minLength": 3 - } - } - }, - "currencyExchangeRateType": { - "description": "Currency code configuration.", - "type": "object", - "properties": { - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", - "type": "string", - "maxLength": 10, - "minLength": 0 - }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", - "type": "integer" + "generalInformation": { + "description": "General Information of the hotel.", + "type": "object", + "properties": { + "hotelType": { + "description": "The type of the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomCount": { + "description": "The total number of rooms in the Hotel.", + "type": "integer" + }, + "bedCount": { + "description": "The total number of beds in the Hotel.", + "type": "integer" + }, + "floorCount": { + "description": "The total number of floors of the Hotel.", + "type": "integer" + }, + "checkInTime": { + "description": "The official check in time of the Hotel.", + "type": "string", + "format": "date-time" + }, + "checkOutTime": { + "description": "The official check out time of the Hotel.", + "type": "string", + "format": "date-time" + }, + "hotelInfoWebsite": { + "description": "URL where property information is located.", + "$ref": "#/definitions/uRLType" + }, + "longitude": { + "description": "Longitude of the hotel.", + "type": "number" + }, + "latitude": { + "description": "Latitude of the hotel.", + "type": "number" + }, + "baseLanguage": { + "description": "The base language of the Hotel.", + "$ref": "#/definitions/languageType" + } + } }, - "description": { - "description": "Description of the currency code.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "accommodationDetails": { + "description": "Accommodation Details of the hotel.", + "type": "object", + "properties": { + "singleRooms": { + "description": "The number of Single Rooms of the Hotel.", + "type": "integer" + }, + "doubleRooms": { + "description": "The number of Double Rooms of the Hotel.", + "type": "integer" + }, + "twinRooms": { + "description": "The number of Twin Rooms of the Hotel.", + "type": "integer" + }, + "familyRooms": { + "description": "The number of Family Rooms of the Hotel.", + "type": "integer" + }, + "connectingRooms": { + "description": "The number of Connecting Rooms of the Hotel.", + "type": "integer" + }, + "accessibleRooms": { + "description": "The number of Accessible Rooms of the Hotel.", + "type": "integer" + }, + "nonSmokingRooms": { + "description": "The number of Non-Smoking Rooms of the Hotel.", + "type": "integer" + }, + "maxAdultsInFamilyRoom": { + "description": "Maximum Adults for Family Room Type.", + "type": "integer" + }, + "maxChildrenInFamilyRoom": { + "description": "Maximum Children for Family Room Type.", + "type": "integer" + }, + "guestRoomFloors": { + "description": "The total number of the Guest Room Floors.", + "type": "integer" + }, + "guestRoomElevators": { + "description": "The number of Guest Room Elevators.", + "type": "integer" + }, + "suites": { + "description": "The number of Suites of the Hotel.", + "type": "integer" + }, + "executiveFloorNo": { + "description": "The floor number of Executive Floors of the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "roomAmenties": { + "description": "The information about the Room Amenities.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "shopDescription": { + "description": "The Description of the shops in the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } }, - "exchangeRate": { - "description": "Exchange Rate for the currency code. Exchange rate is based on the current business date of the property.", - "$ref": "#/definitions/currencyAmountType" - } - } - }, - "currencyExchangeRatesDetails": { - "description": "Response with the list of currency codes and their exchange rates for each property requested.", - "type": "object", - "properties": { - "exchangeRates": { - "description": "List of currency codes with their exchange rates.", - "type": "array", - "items": { - "type": "object", - "properties": { - "exchangeInfo": { - "description": "Exchange Rate information for a currency code.", - "type": "array", - "items": { - "$ref": "#/definitions/currencyExchangeRateType" + "propertyControls": { + "description": "Property controls information configuration of the hotel.", + "type": "object", + "properties": { + "sellControls": { + "description": "The sell controls information configuration of the hotel.", + "type": "object", + "properties": { + "startDate": { + "description": "Date when the hotel become valid for use.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "description": "The end date of the hotel.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "hotelId": { + "description": "The hotel code.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "currencyFormatting": { + "description": "Currency Formatting information configuration of the hotel.", + "type": "object", + "properties": { + "currencyCode": { + "description": "The base currency code for this hotel..", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencyFormat": { + "description": "Format for the local currency.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "currencySymbol": { + "description": "Symbol to designate the default currency of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "decimalPositions": { + "description": "Number of decimal positions used for this currency type.", + "type": "integer" + } + } + }, + "cateringCurrencyFormatting": { + "description": "Catering Currency Formatting information configuration of the hotel.", + "type": "object", + "properties": { + "currencyCode": { + "description": "The base currency code for this hotel..", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencyFormat": { + "description": "Format for the local currency.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "dateTimeFormatting": { + "description": "Date Time Formatting information configuration of the hotel", + "type": "object", + "properties": { + "longDateFormat": { + "description": "Long date format of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "shortDateFormat": { + "description": "Short date format of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "timeFormat": { + "description": "Time format for the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "timeZoneRegion": { + "description": "Time zone region of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "applicationMode": { + "description": "Application Mode information configuration of the hotel.", + "type": "object", + "properties": { + "configurationMode": { + "description": "The hotel's configuration mode if applicable.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "countryMode": { + "description": "The hotel's country code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "expHotelCode": { + "description": "Hotel Code used for third party exports.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "touristNumber": { + "description": "The Tourist Number of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "mbsSupported": { + "description": "Indicates if the hotel uses MBS (Marriott Business Services).", + "type": "boolean" } - }, - "hotelId": { - "$ref": "#/definitions/codeType" } } } }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "currencyExchangeRatesType": { - "description": "Exchange Rate information for a currency code.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/currencyExchangeRateType" - } - }, - "currentRoomInfoType": { - "description": "Room information of the reservation for the current day.", - "type": "object", - "properties": { - "assignedByAI": { - "description": "Represents the room was assigned by AI Room Assignment.", - "type": "boolean" - }, - "roomDescription": { - "description": "Current room description.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "roomId": { - "description": "Current room number.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "roomType": { - "description": "Current room type.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "roomViewCode": { - "description": "Represents the room view code like City view, River view, Ocean view etc.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "suggestedRoomNumbers": { - "description": "Suggested room numbers.", - "$ref": "#/definitions/codeListType" - }, - "upgradedByAI": { - "description": "Represents the room was upgraded by AI Room Assignment.", - "type": "boolean" - } - } - }, - "customerType": { - "description": "Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.", - "type": "object", - "properties": { - "alienInfo": { - "description": "Immigration/visa information of a foreign person.", - "$ref": "#/definitions/alienInfoType" + "communication": { + "description": "Communication information of the hotel.", + "type": "object", + "properties": { + "phoneNumber": { + "description": "The direct dial phone number of the hotel.", + "$ref": "#/definitions/telephoneType" + }, + "tollFreeNumber": { + "description": "Toll free phone number of the hotel.", + "$ref": "#/definitions/telephoneType" + }, + "faxNumber": { + "description": "Fax phone number of the hotel.", + "$ref": "#/definitions/telephoneType" + }, + "emailAddress": { + "description": "Email address of the hotel.", + "$ref": "#/definitions/basicEmailType" + }, + "webPage": { + "description": "The web address of the hotel.", + "$ref": "#/definitions/uRLType" + } + } }, - "anonymization": { - "description": "Provides information about the guest's anonymization status", - "$ref": "#/definitions/anonymizationType" + "address": { + "description": "Provides address information.", + "type": "object", + "properties": { + "isValidated": { + "description": "Indicator to define if the Address is validated by the Address Validation System.", + "type": "boolean" + }, + "addressLine": { + "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", + "type": "array", + "maxItems": 4, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 80 + } + }, + "cityName": { + "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "postalCode": { + "description": "Post Office Code number.", + "type": "string", + "minLength": 0, + "maxLength": 15 + }, + "cityExtension": { + "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "county": { + "description": "County or District Name (e.g., Fairfax). This is read only.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "state": { + "description": "State or Province name (e.g., Texas).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "country": { + "description": "Country name (e.g., Ireland).", + "$ref": "#/definitions/countryNameType" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "type": { + "description": "Defines the type of address (e.g. home, business, other).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "typeDescription": { + "description": "Describes the type code", + "type": "string" + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "updateReservations": { + "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.", + "type": "boolean" + }, + "barCode": { + "description": "The postal barcode for the address.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" + }, + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "regionCode": { + "description": "The region code of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } }, - "birthCountry": { - "description": "Country of birth.", - "$ref": "#/definitions/countryNameType" + "hotelRestaurants": { + "description": "Names of restaurants which can be found in the Hotel.", + "$ref": "#/definitions/hotelRestaurantsType" }, - "birthDate": { - "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", - "type": "string", - "format": "date", - "maxLength": 8 + "hotelRateRanges": { + "description": "The rate ranges which are offered by the hotels.", + "$ref": "#/definitions/hotelRateRangesType" }, - "birthDateMasked": { - "description": "Indicates the date of birth as masked.", - "type": "string" + "alternateHotels": { + "description": "Informations about alternative hotels provided by the Hotel.", + "$ref": "#/definitions/alternateHotelsType" }, - "birthPlace": { - "description": "Place of birth.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "hotelContacts": { + "description": "The contacts information the hotels.", + "$ref": "#/definitions/hotelContactsType" }, - "blacklist": { - "description": "This element tells if profile is blacklisted or not.", - "type": "boolean" + "hotelEventSpaces": { + "description": "Even Space information of the hotel.", + "$ref": "#/definitions/hotelEventSpacesType" }, - "businessTitle": { - "description": "Business Title.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "hotelNotes": { + "description": "List of notes for the hotel.", + "$ref": "#/definitions/hotelNotesType" }, - "citizenCountry": { - "description": "Name of the (self-professed) country that is claimed for citizenship.", - "$ref": "#/definitions/countryNameType" + "hotelCorporateInformations": { + "$ref": "#/definitions/hotelCorporateInformationsType" }, - "companyInfo": { - "description": "Company Information of the Profile.", - "$ref": "#/definitions/companyInfoType" + "attractions": { + "description": "List of Attractions for the hotel.", + "$ref": "#/definitions/hotelAttractionsType" }, - "creditRating": { - "description": "Credit Rating of the customer.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "meetingRooms": { + "description": "List of Meeting Rooms for the hotel.", + "$ref": "#/definitions/meetingRoomsType" }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", + "chainCode": { + "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "hotelId": { + "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", "type": "string", - "maxLength": 10, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "customerValue": { - "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", + "hotelCityCode": { + "description": "The IATA city code; for example DCA, ORD.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", - "type": "integer" + "minLength": 0, + "maxLength": 40 }, - "gender": { - "description": "Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.", + "hotelName": { + "description": "A text field used to communicate the proper name of the hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "identifications": { - "description": "List of identification of the customer.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "identificationInfo": { - "description": "Collection of detailed information on the identification of the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/identificationInfoType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } - } + "hotelCodeContext": { + "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "language": { - "description": "Language identification.", + "chainName": { + "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "minLength": 0, + "maxLength": 80 + } + } + }, + "languageType": { + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "telephoneType": { + "type": "object", + "description": "Information on a telephone number for the customer.", + "properties": { + "phoneTechType": { + "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "legalCompany": { - "description": "Name Of the company the individual is associated with.", + "phoneUseType": { + "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "nationality": { - "description": "Nationality code identification", + "phoneUseTypeDescription": { + "description": "Description of the PhoneUseType code", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "nationalityDescription": { - "description": "Nationality code description", + "phoneNumber": { + "description": "Telephone number assigned to a single location.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "personName": { - "description": "Detailed name information for the customer.", - "type": "array", - "maxItems": 5, - "items": { - "$ref": "#/definitions/personNameType" - } + "extension": { + "description": "Extension to reach a specific party at the phone number.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "privateProfile": { - "description": "This element tells profile is property exclusive or not.", + "primaryInd": { + "description": "When true, indicates a primary information.", "type": "boolean" }, - "profession": { - "description": "Profession of a person.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" }, - "vipDescription": { - "description": "Description of the VIP status.", + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "format": "date-time" }, - "vipStatus": { - "description": "VIP status of the customer.", + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "dateUDFType": { - "description": "Used to hold user defined field of Date Type.", - "type": "object", - "properties": { - "alternateName": { - "description": "Label of user defined field used by vendors or customers.", + "minLength": 0, + "maxLength": 200 + }, + "lastModifyDateTime": { + "description": "Time stamp of last modification.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "format": "date-time" }, - "name": { - "description": "Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "value": { - "description": "Value of user defined field.", + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", "format": "date", "maxLength": 8 } } }, - "dateUDFsType": { - "description": "Used to hold collection of user defined fields of Date Type.", + "basicEmailType": { + "type": "string", + "description": "Email address", + "minLength": 0, + "maxLength": 2000 + }, + "hotelRestaurantsType": { "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/dateUDFType" + "$ref": "#/definitions/hotelRestaurantType" } }, - "defaultNoteDetails": { - "description": "Response object for fetching Default Application Note text.", + "hotelRestaurantType": { "type": "object", + "description": "Information about the Restaurants in the hotel.", "properties": { - "defaultNote": { - "description": "Default Application Note text details.", - "$ref": "#/definitions/defaultNoteTextDetailType" + "restaurantName": { + "description": "The name of the Restaurant.", + "type": "string", + "minLength": 0, + "maxLength": 1000 }, - "links": { - "$ref": "#/definitions/links" + "restaurantType": { + "description": "The Type of Restaurant.", + "type": "string", + "minLength": 0, + "maxLength": 1000 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "defaultNoteTextDetailType": { - "description": "Default Note Text Information Type.", - "type": "object", - "properties": { - "defaultNoteText": { - "description": "Default Note Text if Note Type has default note.", + "hours": { + "description": "The Hours of Operation of the Restaurant.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 1000 }, - "hotelId": { - "description": "Indicates the Property for which the Default Note Text is specified.", + "priceRange": { + "description": "The price range of the Restaurant.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "defaultNoteTextsDetailType": { - "description": "Collection of individual Default Note Text details.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/defaultNoteTextDetailType" - } - }, - "departmentType": { - "description": "Type provides department information.", - "type": "object", - "properties": { - "departmentCode": { - "description": "Department Code.", + "minLength": 0, + "maxLength": 40 + }, + "comments": { + "description": "Comments about the Restaurant.", "type": "string", - "maxLength": 10, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "departmentName": { - "description": "Description of the department.", - "$ref": "#/definitions/translationTextType30" + "category": { + "description": "The category that the Restaurant belongs to.", + "$ref": "#/definitions/restaurantCategoryType" }, - "displaySequence": { - "description": "Display Sequence for the department.", - "type": "integer" + "timeSpan": { + "description": "The Start Date and End Date of the Restaurant.", + "$ref": "#/definitions/timeSpanType" }, - "email": { - "description": "Department email address.", + "newRestaurantCode": { + "description": "The new Restaurant Code which is used in the change method.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "restaurantCode": { "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "orderBy": { + "type": "integer" }, "hotelId": { - "description": "Property Code where the department belongs to.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "departmentsCriteria": { - "description": "Request object for creating new departments.", - "type": "object", - "properties": { - "departments": { - "description": "Departments to be created.", - "$ref": "#/definitions/departmentsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "restaurantCategoryType": { + "type": "string", + "description": "Simple type for Hotel Restaurant.", + "enum": [ + "Restaurant", + "Retail" + ] + }, + "hotelRateRangesType": { + "type": "array", + "description": "Lists of rate ranges of the hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelRateRangeType" } }, - "departmentsDetails": { - "description": "Response object for fetching departments.", + "hotelRateRangeType": { "type": "object", + "description": "The rate rage information of the hotel.", "properties": { - "departments": { - "description": "Type contains departments.", - "$ref": "#/definitions/departmentsType" + "timeSpan": { + "description": "The Start Date and End Date of the Hotel rate range.", + "$ref": "#/definitions/timeSpanType" }, - "links": { - "$ref": "#/definitions/links" + "minRate": { + "description": "Minimum Rate offered by the hotel.", + "type": "number" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "departmentsToBeChanged": { - "description": "Request object for updating departments.", - "type": "object", - "properties": { - "departments": { - "description": "Departments to be modified.", - "$ref": "#/definitions/departmentsType" + "maxRate": { + "description": "Maximum Rate offered by the hotel.", + "type": "number" }, - "links": { - "$ref": "#/definitions/links" + "currencyCode": { + "description": "The base currency code for rate range(The currency code used by the hotel which the rate range belongs to).", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "departmentsType": { - "description": "Collection of departments.", + "alternateHotelsType": { "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/departmentType" + "$ref": "#/definitions/alternateHotelType" } }, - "directBillingType": { - "description": "This is the preconfigured routing instruction type.", + "alternateHotelType": { "type": "object", "properties": { - "aRNumber": { - "description": "Hotel Code for which the details of direct billing is provided for a profile.", + "address": { + "$ref": "#/definitions/addressType" + }, + "contactNumbers": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/telephoneType" + } + }, + "minRate": { + "$ref": "#/definitions/currencyAmountType" + }, + "maxRate": { + "$ref": "#/definitions/currencyAmountType" + }, + "relativePosition": { + "$ref": "#/definitions/relativePositionType" + }, + "hotelAmenities": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelAmenityType" + } + }, + "event": { + "description": "True if the hotel has any scheduled events within the requested date range.", + "type": "boolean" + }, + "rateRoomDetails": { + "description": "Any additional information like membership, restriction status, room stay information of the requested hotels etc.", + "$ref": "#/definitions/rateRoomDetailsType" + }, + "channelSummaryInfo": { + "description": "Channel related information if availability request is send for a channel.", + "$ref": "#/definitions/channelSummaryInfoType" + }, + "sellMessages": { + "description": "Sell messages retrieved based on the Time Span criteria for all Rate Codes and Room Types of the requested hotel.", + "$ref": "#/definitions/sellMessagesType" + }, + "currencyExchangeRates": { + "description": "Exchange Rate information for currency codes of the requested hotel.", + "$ref": "#/definitions/currencyExchangeRatesType" + }, + "chainCode": { + "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "hotelId": { - "description": "Hotel Code for which the details of direct billing is provided for a profile.", + "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelCityCode": { + "description": "The IATA city code; for example DCA, ORD.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "hotelName": { + "description": "A text field used to communicate the proper name of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "hotelCodeContext": { + "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "chainName": { + "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "hotelType": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "negotiated": { + "type": "boolean" + }, + "alternate": { + "type": "boolean" + }, + "displayOrder": { + "type": "number" + }, + "inventoryRooms": { + "type": "integer" + }, + "availableRooms": { + "type": "integer" + }, + "comments": { + "description": "Comments of alternate Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "direction": { + "description": "Compass direction to the attraction from the hotel (North/South, etc).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "reciprocalRelationship": { + "description": "whether the alternate relationship should be applied to the alternate hotel as well. If this flag is true, not only will the AlternateHotelCode hotel be an alternate for HotelCode hotel, but HotelCode hotel will also be an alternate for AlternateHotelCode hotel.", + "type": "boolean" + }, + "alternateHotelCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "newAlternateHotelCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "directionType": { - "description": "Direction details to get into Hotel.", + "hotelAmenityType": { "type": "object", "properties": { "description": { - "description": "Description about the Hotel direction.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "title": { - "description": "Title of Hotel direction.", + "code": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "type": { "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 + }, + "displayOrder": { + "type": "number" } } }, - "directionsType": { - "description": "Collection of direction details to get into Hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/directionType" + "rateRoomDetailsType": { + "type": "object", + "properties": { + "memberships": { + "description": "Detail regarding customer loyalty program.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipSearchType" + } + }, + "restrictionType": { + "description": "Indicates the restriction types if hotel is not available.", + "$ref": "#/definitions/masterRestrictionStatusesType" + }, + "roomStays": { + "description": "Room stay information.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomStayType" + } + } } }, - "discountType": { - "description": "Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.", + "membershipSearchType": { "type": "object", + "description": "Identifies criteria for searching frequent customer reward program.", "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", - "maxLength": 3, - "minLength": 3 + "membershipId": { + "description": "Membership ID criteria.", + "type": "string" }, - "discountCode": { - "description": "Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).", - "type": "string", - "maxLength": 20, - "minLength": 0 + "membershipLevel": { + "description": "Membership Level criteria.", + "$ref": "#/definitions/codeListType" }, - "discountReason": { - "type": "string", - "maxLength": 2000, - "minLength": 0 + "membershipType": { + "description": "Membership Type criteria.", + "$ref": "#/definitions/codeListType" }, - "percent": { - "description": "Percentage discount.", - "type": "number" + "associatedReservationsOnly": { + "description": "If this is true,the reservations which has membership information associated will be resulted .", + "type": "boolean" } } }, - "downgradeType": { - "description": "Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.", - "type": "string", - "enum": [ - "Grace", - "Never", - "Period" - ] - }, - "eCertificateConsumeSourceType": { - "description": "Indicates that OPERA E-Certificate is consumed by hotelPMS.", + "masterRestrictionStatusesType": { "type": "string", "enum": [ - "Central", - "Web", - "Hotel" + "Closed", + "ClosedForArrival", + "ClosedForDeparture", + "MinimumStayThrough", + "MaximumStayThrough", + "MinimumLengthOfStay", + "MaximumLengthOfStay", + "LOSNotAvailable", + "MinimumAdvanceBooking", + "MaximumAdvanceBooking", + "Open", + "OpenForArrival", + "OpenForDeparture", + "Hurdle", + "MinimumOccupancy", + "MaximumOccupancy", + "RateStrategy", + "RateDetailsNotSet", + "InventoryItemNotAvailable", + "RankRestriction", + "MaximumAuth", + "InventoryNotAvailable", + "RoomClassNotAvailable", + "RoomTypeNotAvailable", + "BlockSellLimit", + "OnRequest" ] }, - "eCertificateConsumptionType": { - "description": "E-Certificates details.", + "roomStayType": { "type": "object", "properties": { - "authorizationCode": { - "description": "Authorization code for consumption.", - "type": "string", - "maxLength": 100, - "minLength": 0 + "registrationNumber": { + "description": "Registration Number of the reservation for the current day.", + "$ref": "#/definitions/uniqueID_Type" }, - "date": { - "description": "Date the certificate was consumed.", - "type": "string", - "format": "date", - "maxLength": 8 + "currentRoomInfo": { + "description": "Room information of the reservation for the current day.", + "$ref": "#/definitions/currentRoomInfoType" }, - "email": { - "description": "Email of the person who consumed the certificate.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "roomRates": { + "description": "A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomRateType" + } }, - "firstName": { - "description": "First name of the person who consumed the certificate.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "guestCounts": { + "$ref": "#/definitions/guestCountsType" }, - "hotelId": { - "description": "Property where certificate was consumed for.", + "arrivalDate": { "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date" }, - "locationType": { - "description": "Consumption location type.", + "departureDate": { "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date" }, - "middleName": { - "description": "Middle name of the person who consumed the certificate.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "expectedTimes": { + "description": "The Expected Arrival and Departure Times.", + "$ref": "#/definitions/resExpectedTimesType" }, - "referenceId": { - "description": "Any reference like reservation no etc against which the certificate was consumed.", - "$ref": "#/definitions/uniqueID_Type" + "originalTimeSpan": { + "description": "The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.", + "$ref": "#/definitions/timeSpanType" }, - "serviceDate": { - "description": "Date on which the service is due (arrival date in case of reservation).", - "type": "string", - "format": "date", - "maxLength": 8 + "guarantee": { + "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.", + "$ref": "#/definitions/resGuaranteeType" }, - "source": { - "description": "Source of consumption.", - "$ref": "#/definitions/eCertificateConsumeSourceType" + "promotion": { + "description": "Promotions applied to the reservation to get the promotional rate.", + "$ref": "#/definitions/promotionType" }, - "surname": { - "description": "Last name of the person who consumed the certificate..", + "suiteWith": { + "description": "Connecting Rooms.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "userName": { - "description": "Application user who created the consumption.", + "total": { + "description": "The total amount charged for the Room Stay.", + "$ref": "#/definitions/totalType" + }, + "totalPoints": { + "description": "The total number of Points charged for the Room Stay.", + "$ref": "#/definitions/pointsType" + }, + "multiValueAttrs": { + "description": "Informative indicators indicating different values of an attribute exists over the stay.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "maxLength": 2000 + } + }, + "upsellInfo": { + "description": "Indicates Upsell Information to be applied on Reservation.", + "$ref": "#/definitions/upsellInfoType" + }, + "mobileNotifications": { + "description": "Denotes the status of Room Ready and Key Ready messages.", + "$ref": "#/definitions/resMobileNotificationsType" + }, + "roomNumberLocked": { + "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.", + "type": "boolean" + }, + "printRate": { + "description": "This control whether rate info will be printed in confirmation letter.", + "type": "boolean" + }, + "ownerReservationType": { + "description": "Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation.", + "$ref": "#/definitions/ownerResTypeType" + }, + "primaryShareType": { + "description": "This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed.", + "$ref": "#/definitions/primaryShareTypeType" + }, + "remoteCheckInAllowed": { + "description": "Indicates whether the reservation is pre-registered for internet check-in or not.", + "type": "boolean" + }, + "bookingMedium": { + "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "userNotes": { - "description": "Any notes on the certificate entered at time of consumption.", + "bookingMediumDescription": { + "description": "Description of the booking medium.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 + }, + "availableUpsellOfferCount": { + "description": "Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request", + "type": "integer" } } }, - "eCertificateGenerationType": { - "description": "E-Certificates details.", + "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": { - "generationDetail": { - "description": "Reason for which e-certificate was generated.", + "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", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "referenceValue": { - "description": "Type of value that is in the certificate.valid values are membership_level.", + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "ruleId": { - "description": "Key to identify the generation rule id.", - "$ref": "#/definitions/uniqueID_Type" + "minLength": 0, + "maxLength": 40 } } }, - "eCertificateInfoType": { - "description": "E-Certificates details.", + "currentRoomInfoType": { "type": "object", + "description": "Room information of the reservation for the current day.", "properties": { - "awardCode": { - "description": "Award type to which the certificate is linked to.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "benefitSummary": { - "description": "Summary of Benefits attached to this ECertificate.", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "certificateType": { - "description": "User defined certificate code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "cost": { - "description": "Cost of certificate.", - "$ref": "#/definitions/currencyAmountType" - }, - "description": { - "description": "Description about the certificate.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "hotels": { - "description": "Hotel to which certificate is attached to.", - "type": "object", - "properties": { - "code": { - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 - } - }, - "scope": { - "description": "Scope of e-cert: global,single property or multi property.", - "$ref": "#/definitions/eCertificateScopeType" - } - } - }, - "label": { - "description": "Label for the certificate.", + "roomType": { + "description": "Current room type.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "longDescription": { - "description": "Detail description about the certificate.", + "roomId": { + "description": "Current room number.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "maxExtensionAllowed": { - "description": "Number of times e-certificate can be extended.", - "type": "integer" + "suggestedRoomNumbers": { + "description": "Suggested room numbers.", + "$ref": "#/definitions/codeListType" }, - "membershipType": { - "description": "Membership type to which the certificate is linked to.", + "roomDescription": { + "description": "Current room description.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "promotionCode": { - "description": "Promotion code to which certificate is attached to.", + "roomViewCode": { + "description": "Represents the room view code like City view, River view, Ocean view etc.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "usageCriteria": { - "$ref": "#/definitions/eCertificateUsageCriteriaType" + "minLength": 0, + "maxLength": 40 }, - "value": { - "description": "Value of the certificate for the guest.", - "$ref": "#/definitions/currencyAmountType" + "assignedByAI": { + "description": "Represents the room was assigned by AI Room Assignment.", + "type": "boolean" }, - "voucherBenefitCode": { - "description": "Voucher benefit code attached to the certificate.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "upgradedByAI": { + "description": "Represents the room was upgraded by AI Room Assignment.", + "type": "boolean" } } }, - "eCertificateIssueSourceType": { - "description": "Indicates that OPERA E-Certificate is issued by external system.", - "type": "string", - "enum": [ - "Opera", - "Web", - "Interface" - ] - }, - "eCertificateIssueType": { - "description": "Indicates that guest purchased OPERA E-Certificate.", - "type": "string", - "enum": [ - "Assigned", - "OptedIn", - "Purchased" - ] - }, - "eCertificateScopeType": { - "description": "Indicates that OPERA E-Certificate is available for a specific list of hotels.", - "type": "string", - "enum": [ - "Global", - "Hotel", - "MultiHotel" - ] - }, - "eCertificateStatusType": { - "description": "Indicates that OPERA E-Certificate is reserved.", - "type": "string", - "enum": [ - "Cancelled", - "Consumed", - "Deleted", - "Expired", - "Issued", - "Reserved" - ] - }, - "eCertificateType": { - "description": "E-Certificates details.", + "roomRateType": { "type": "object", "properties": { - "awardId": { - "description": "AwardID.", - "$ref": "#/definitions/awardId" + "total": { + "$ref": "#/definitions/totalType" }, - "awardPoints": { - "description": "Award points if any in case of certificate use membership award.", - "type": "integer" + "totalPoints": { + "$ref": "#/definitions/pointsType" }, - "cancelRequestDate": { - "description": "Date on which the cancellation was requested.", - "type": "string", - "format": "date", - "maxLength": 8 + "rates": { + "$ref": "#/definitions/ratesType" }, - "certificateId": { - "description": "System generated unique certificate id.", - "type": "integer" + "packages": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/packageElementType" + } }, - "certificateNo": { - "description": "Printed certificate no. This has to be unique.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "stayProfiles": { + "description": "Profile associated with the room Stay.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationProfileType" + } }, - "consumptionDetail": { - "$ref": "#/definitions/eCertificateConsumptionType" + "guestCounts": { + "description": "A collection of Guest Counts associated with the room rate.", + "$ref": "#/definitions/guestCountsType" }, - "databaseId": { - "description": "External reference from which the record is created.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "taxFreeGuestCounts": { + "description": "A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.", + "$ref": "#/definitions/guestCountsType" }, - "eCertificateInfo": { - "$ref": "#/definitions/eCertificateInfoType" + "awards": { + "description": "Membership Awards code applied on the reservation.", + "$ref": "#/definitions/resAwardsType" }, - "expiryDate": { - "description": "Date of expiry.", - "type": "string", - "format": "date", - "maxLength": 8 + "foreignExchange": { + "description": "Exchange Type information for the postings.", + "$ref": "#/definitions/foreignExchangeType" }, - "extensionCount": { - "description": "Number of times e-certificate is already extended.", - "type": "integer" + "reservationBlock": { + "description": "Key information about the block for this reservation.", + "$ref": "#/definitions/reservationBlockType" }, - "generationDetail": { - "$ref": "#/definitions/eCertificateGenerationType" + "roomRateInfo": { + "description": "Information about the Room Rate Combination.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "inLieuSequence": { - "description": "Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.", - "type": "integer" + "mealPlans": { + "description": "Meal plan codes for rate plan code.", + "$ref": "#/definitions/mealPlansType" }, - "inactiveDate": { - "description": "Date the record was marked as inactive.", + "roomType": { "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "issueDate": { - "description": "Date when certificate was issued.", + "ratePlanCode": { "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "issueType": { - "description": "Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p).", - "$ref": "#/definitions/eCertificateIssueType" + "promotionCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "newExpiryDate": { - "description": "New Date of expiry to extend e-certificate.", + "start": { + "description": "The starting value of the date range.", "type": "string", "format": "date", "maxLength": 8 }, - "originalCertificateNo": { - "description": "In case of in lieu of certificate this will contain the original certificate no.", + "end": { + "description": "The ending value of the date range.", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "originalVoucherNo": { - "description": "In case of in lieu of certificate this will contain the original voucher no.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "availability": { + "description": "Used to specify an availability status for the room rate. When available value could be either not specified or \"Available\".", + "$ref": "#/definitions/roomRateAvailReasonType" }, - "printed": { - "description": "Print status of the certificate.", + "suppressRate": { "type": "boolean" }, - "profileId": { - "description": "NameId.", - "$ref": "#/definitions/profileId" - }, - "source": { - "description": "Source of e-certificate.", - "$ref": "#/definitions/eCertificateIssueSourceType" - }, - "status": { - "description": "Status of the certificate.", - "$ref": "#/definitions/eCertificateStatusType" - }, - "voucherNo": { - "description": "System generated unique voucher number.", + "marketCode": { + "description": "The code that relates to the market being sold to (e.g., the corporate market, packages).", "type": "string", - "maxLength": 40, - "minLength": 0 - } - } - }, - "eCertificateUsageCriteriaType": { - "description": "E-Certificates details.", - "type": "object", - "properties": { - "benefit": { - "description": "Indicates to attach a rate code to the e-certificate as a benefit.", - "type": "boolean" - }, - "cancelAllowed": { - "description": "Identify if cancel is allowed or not.", - "type": "boolean" - }, - "generateInLieuCertificate": { - "description": "Identify if in lieu of certificate can be generated or not.", - "type": "boolean" - }, - "hotel": { - "description": "Indicates if web certificate can be consumed in hotel.", - "type": "boolean" + "minLength": 0, + "maxLength": 20 }, - "reservation": { - "description": "Indicates if certificate is to be used against reservation or not.", - "type": "boolean" + "marketCodeDescription": { + "description": "Description of the market code.", + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "verifyCertificateNo": { - "description": "Specify if the certificate number verification is required at time of consumption or not.", - "type": "boolean" + "sourceCode": { + "description": "To specify where the business came from e.g. radio, newspaper ad, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "web": { - "description": "Indicates if web certificate can be consumed in OWS.", - "type": "boolean" + "sourceCodeDescription": { + "description": "Description of the source of business.", + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "webAllowed": { - "description": "Indicates if certificate consumption allowable on the web.", - "type": "boolean" - } - } - }, - "eCertificatesType": { - "description": "List of e-certificates for the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/eCertificateType" - } - }, - "emailInfoType": { - "description": "Information on an email for the customer.", - "type": "object", - "properties": { - "email": { - "description": "eMail deatils for the profile.", - "$ref": "#/definitions/emailType" + "numberOfUnits": { + "description": "The number of rooms.", + "type": "integer" }, - "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.", + "roomId": { + "description": "A string value representing the unique identification of a room.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 - } - } - }, - "emailType": { - "description": "Information on an email for the customer.", - "type": "object", - "properties": { - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" + "pseudoRoom": { + "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.", + "type": "boolean" }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "roomTypeCharged": { + "description": "Room Type used for the Rate calculation.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "emailAddress": { - "description": "Defines the e-mail address.", + "commissionCode": { + "description": "Commission Code applicable for commission calculation for Travel Agent/Company.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "emailFormat": { - "description": "Supported Email format.", - "type": "string", - "enum": [ - "Html", - "Text" - ] + "commissionable": { + "description": "Indicates Commission is applicable for commission calculation for Travel Agent/Company.", + "type": "boolean" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "maxLength": 200, - "minLength": 0 + "houseUseOnly": { + "description": "Indicates this reservation is for House use.", + "type": "boolean" }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "complimentary": { + "description": "Indicates this reservation rate is complimentary.", + "type": "boolean" }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "inventoryLender": { + "description": "Indicates whether the room type inventory was taken from the allotment or House availability.", + "type": "string" }, - "primaryInd": { - "description": "When true, indicates a primary information.", + "fixedRate": { + "description": "Fixed Rate Indicator.", "type": "boolean" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 + "barRanking": { + "description": "Best Available rates ranking.", + "type": "integer" }, - "type": { - "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve).", + "rateGroup": { + "description": "For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "typeDescription": { - "description": "Describes the Type code", - "type": "string", - "maxLength": 2000, - "minLength": 0 - } - } - }, - "errorInstance": { - "description": "Complex type that contains error instance details for a REST call.", - "type": "object", - "title": "Error Instance Details", - "required": [ - "type", - "title" - ], - "properties": { - "detail": { - "description": "Human-readable description specific to this occurrence of the problem.", - "type": "string" + "discountAllowed": { + "description": "Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.", + "type": "boolean" }, - "instance": { - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.", - "type": "string" + "bogoDiscount": { + "description": "Indicates if the Rate Code has BOGO(Bye one Get one) indicator.", + "type": "boolean" }, - "o:errorCode": { - "description": "Application error code, which is different from HTTP error code.", - "type": "string" + "rateLevel": { + "description": "Rate plan type like Corporate,Regular,Military,Weekend etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "o:errorPath": { - "description": "Path to the problem at the resource or property level.", - "type": "string" + "commissionPercentage": { + "description": "Indicates commission percentage used by the rate plan.", + "type": "integer" }, - "status": { - "description": "HTTP status code for this occurrence of the problem, set by the origin server.", + "commissionAmount": { + "description": "Indicates commission amount used by the rate plan.", "type": "integer" }, - "title": { - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.", - "type": "string" + "credentialsRequired": { + "description": "If true, indicates that credentials is required to sell the rate code.", + "type": "boolean" }, - "type": { - "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).", - "type": "string" + "taxIncluded": { + "description": "If true, indicates if tax is included in the rate code.", + "type": "boolean" + }, + "rateDescription": { + "description": "Rate code description.", + "type": "string", + "minLength": 0, + "maxLength": 4000 } } }, - "eventSpaceMaxOccupanciesType": { - "description": "List of event space max occupancy.", - "type": "array", - "maxItems": 5, - "items": { - "type": "integer" - } - }, - "exceptionDetailType": { - "description": "Complex type that contains error details for a REST call.", + "totalType": { "type": "object", - "title": "Error Detail", - "required": [ - "type", - "title" - ], + "description": "The total amount charged for the service including additional amounts and fees.", "properties": { - "detail": { - "description": "Human-readable description specific to this occurrence of the problem.", - "type": "string" - }, - "instance": { - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.", - "type": "string" - }, - "links": { - "$ref": "#/definitions/links" - }, - "o:errorCode": { - "description": "Application error code, which is different from HTTP error code.", - "type": "string" + "taxes": { + "description": "A collection of taxes.", + "$ref": "#/definitions/taxesType" }, - "o:errorDetails": { - "description": "Details of the error message, consisting of a hierarchical tree structure.", - "type": "array", - "items": { - "$ref": "#/definitions/errorInstance" - } + "fees": { + "description": "A collection of fees or service charges.", + "$ref": "#/definitions/feesType" }, - "o:errorPath": { - "description": "Path to the problem at the resource or property level.", - "type": "string" + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "status": { - "description": "HTTP status code for this occurrence of the problem, set by the origin server.", - "type": "integer" + "amountBeforeTax": { + "description": "The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).", + "type": "number" }, - "title": { - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.", - "type": "string" + "amountAfterTax": { + "description": "The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).", + "type": "number" }, - "type": { - "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).", - "type": "string" - } - } - }, - "externalReferenceType": { - "description": "This type contains unique information of external reference.", - "type": "object", - "properties": { - "id": { - "description": "Unique ID of external reference.", + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "idContext": { - "description": "ID context for external reference.", + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 10 }, - "idExtension": { - "description": "ID extension for external reference.", + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", "type": "integer" - } - } - }, - "externalReferencesType": { - "description": "This type contains unique information of external reference.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/externalReferenceType" - } - }, - "facilityCodeType": { - "description": "Facility Housekeeping Code, its description and quantity.", - "type": "object", - "properties": { - "code": { - "description": "Facility code value.", - "type": "string", - "maxLength": 20, - "minLength": 0 }, - "description": { - "description": "Facility Code.", + "code": { + "description": "Type of charge.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "quantity": { - "description": "Signifies the quantity.", - "type": "integer" + "rateOverride": { + "description": "When true indicates that the rate amount has been overridden.", + "type": "boolean" } } }, - "facilityCodesType": { - "description": "List of the facility codes.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/facilityCodeType" - } - }, - "facilityTaskType": { - "description": "Information regarding facility task on a reservation.", + "taxesType": { "type": "object", + "description": "A collection of taxes.", "properties": { - "date": { - "description": "The Date on which the task is applicable.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "supplies": { - "description": "Supplies associated with the task.", - "$ref": "#/definitions/facilityCodesType" + "tax": { + "description": "An individual tax.", + "type": "array", + "maxItems": 99, + "items": { + "$ref": "#/definitions/taxType" + } }, - "task": { - "description": "The Task Code.", - "$ref": "#/definitions/housekeepingTaskCodeType" - } - } - }, - "feeType": { - "description": "Applicable service charges or fees.", - "type": "object", - "properties": { "amount": { "description": "A monetary amount.", "type": "number" }, - "code": { - "description": "Code identifying the fee (e.g.,agency fee, municipality fee).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, "currencyCode": { "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", "type": "string", - "maxLength": 3, - "minLength": 3 - }, + "minLength": 3, + "maxLength": 3 + } + } + }, + "taxType": { + "type": "object", + "description": "Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.", + "properties": { "description": { "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, "type": { "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).", "$ref": "#/definitions/amountDeterminationType" - } - } - }, - "feesType": { - "description": "A collection of fees or service charges.", - "type": "object", - "properties": { + }, + "code": { + "description": "Code identifying the fee (e.g.,agency fee, municipality fee).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "amount": { "description": "A monetary amount.", "type": "number" @@ -42657,9 +37199,23 @@ "currencyCode": { "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", "type": "string", - "maxLength": 3, - "minLength": 3 - }, + "minLength": 3, + "maxLength": 3 + } + } + }, + "amountDeterminationType": { + "type": "string", + "description": "Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.", + "enum": [ + "Inclusive", + "Exclusive" + ] + }, + "feesType": { + "type": "object", + "description": "A collection of fees or service charges.", + "properties": { "fee": { "description": "An individual fee or service charge.", "type": "array", @@ -42667,4404 +37223,4142 @@ "items": { "$ref": "#/definitions/feeType" } + }, + "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 } } }, - "folioTextsType": { - "description": "This stores the description for the type of tax calculation especially with tax exemption, etc.", - "type": "array", - "maxItems": 2, - "items": { - "type": "object", - "properties": { - "row": { - "description": "Row number of the additional text.", - "type": "integer" - }, - "text": { - "description": "Additional text field to display on the folio.", - "type": "string", - "maxLength": 50, - "minLength": 0 - } - } - } - }, - "foreignExchangeType": { - "description": "Foreign Exchange info.", + "feeType": { "type": "object", + "description": "Applicable service charges or fees.", "properties": { - "effectiveDate": { - "description": "Effective Exchange date for the foreign currency posting.", + "description": { "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 2000 }, "type": { - "description": "Exchange Type for the postings.", + "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).", + "$ref": "#/definitions/amountDeterminationType" + }, + "code": { + "description": "Code identifying the fee (e.g.,agency fee, municipality fee).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "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", - "maxLength": 20, - "minLength": 0 + "minLength": 3, + "maxLength": 3 } } }, - "formattedTextTextType": { - "description": "Provides text and indicates whether it is formatted or not.", + "pointsType": { "type": "object", + "description": "The Redeem Points contains the number of points required to book a room type.", "properties": { - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "value": { - "description": "Property Value", + "awardsType": { + "description": "Awards type for the award type rate code.", "type": "string" + }, + "points": { + "description": "No of points required to book this Room Stay.", + "type": "integer" } } }, - "futureListType": { - "description": "A collection of reservation history details attached to Profiles.", + "ratesType": { "type": "object", + "description": "Individual rate amount.", "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "reservationInfo": { - "description": "Additional reservation information attached to the profile . Eg : Future reservation details", + "rate": { + "description": "The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/reservationInfoType" + "$ref": "#/definitions/amountType" } }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "rateRange": { + "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/rateRangeType" + } } } }, - "gdsNegotiatedInfoType": { - "description": "This provides information for a channel negotiated rate.", + "amountType": { "type": "object", + "description": "Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.", "properties": { - "accessCode": { - "description": "The GDS negotiated rate code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "base": { + "description": "The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.", + "$ref": "#/definitions/totalType" }, - "end": { - "description": "The ending value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 + "additionalGuestAmounts": { + "description": "Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/additionalGuestAmountType" + } }, - "inactive": { - "description": "The GDS Negotiated Rate is inactive or not", - "type": "boolean" + "discount": { + "description": "Discount percentage and/or Amount, code and textual reason for discount", + "$ref": "#/definitions/discountType" }, - "order": { - "description": "The sell order.", - "type": "integer" + "shareRatePercentage": { + "description": "Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "shareDistributionInstruction": { + "description": "Last rate share distribution instruction applied on share reservation daily rate segment.", + "$ref": "#/definitions/shareDistributionInstructionType" + }, + "total": { + "description": "The total amount charged for this rate including additional occupant amounts and fees.", + "$ref": "#/definitions/totalType" + }, + "requiredPoints": { + "description": "The Points contains the number of points required to book a particular room type.", + "$ref": "#/definitions/pointsType" + }, + "effectiveRate": { + "description": "The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time", + "$ref": "#/definitions/totalType" }, "start": { "description": "The starting value of the date range.", "type": "string", "format": "date", "maxLength": 8 - } - } - }, - "gdsNegotiatedType": { - "description": "This holds a list of GdsNegotiatedInfoType.", - "type": "object", - "properties": { - "bookingChannelCode": { - "description": "Booking Channel Code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "channelRatePlanCode": { - "description": "Channel Room Type.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "gdsNegotiatedInfoList": { - "description": "List of channel negotiated rates for the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/gdsNegotiatedInfoType" - } - }, - "hotelId": { - "description": "Hotel Code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "generalNoteType": { - "description": "General note/information about the Hotel.", - "type": "object", - "properties": { - "note": { - "description": "The body of the note.", - "type": "string", - "maxLength": 4000, - "minLength": 0 }, - "title": { - "description": "The note's title.", + "end": { + "description": "The ending value of the date range.", "type": "string", - "maxLength": 200, - "minLength": 0 + "format": "date", + "maxLength": 8 } } }, - "generalNotesType": { - "description": "Collection of general notes about the Hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/generalNoteType" - } - }, - "genericHotelCodeCodeListType": { - "description": "List of HotelCode and Code combinations.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/genericHotelCodeCodeType" - } - }, - "genericHotelCodeCodeType": { - "description": "Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.", + "additionalGuestAmountType": { "type": "object", "properties": { - "code": { - "description": "Configuration code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "amount": { + "$ref": "#/definitions/totalType" }, - "hotelId": { - "description": "Hotel where the code is configured.", + "ageQualifyingCode": { "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "givenNameType": { - "description": "Given name, first name or names", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "guestCountsType": { - "description": "A collection of GuestCount by age group.", - "type": "object", - "properties": { - "adults": { - "description": "Defines the number of Adults.", - "type": "integer" - }, - "childAges": { - "description": "Defines Children's Ages. Number of children ages mentioned may mot match with children counts.", - "$ref": "#/definitions/childAgesType" - }, - "childBuckets": { - "description": "Defines children counts with Age Qualifying Group(Child Bucket#1) classification.", - "$ref": "#/definitions/childBucketsType" - }, - "children": { - "description": "Defines the number of Children.", - "type": "integer" + "enum": [ + "ADULT", + "CHILD", + "OTHER", + "CHILDBUCKET1", + "CHILDBUCKET2", + "CHILDBUCKET3", + "CHILDBUCKET4", + "CHILDBUCKET5" + ] } } }, - "guestHousekeepingServiceRequestType": { - "description": "Possible values for the Guest Service Status.", - "type": "string", - "enum": [ - "DoNotDisturb", - "MakeUpRoom", - "NoStatusSelected" - ] - }, - "guestLastStayInfoType": { - "description": "Contains last stay related details of the guest.", + "discountType": { "type": "object", + "description": "Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.", "properties": { - "lastStayDate": { - "description": "Guest's last stay date.", + "discountReason": { "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 2000 }, - "lastStayRate": { - "description": "The Rate amount of the guest's last stay.", - "$ref": "#/definitions/currencyAmountType" + "percent": { + "description": "Percentage discount.", + "type": "number" }, - "lastStayRoom": { - "description": "Room Number where the guest stayed.", + "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", - "maxLength": 20, - "minLength": 0 + "minLength": 3, + "maxLength": 3 }, - "totalStay": { - "description": "The total number of previous stay of the guest.", - "type": "integer" + "discountCode": { + "description": "Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "historyListType": { - "description": "A collection of reservation history details attached to Profiles.", + "shareDistributionInstructionType": { + "type": "string", + "description": "The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -> Full Rate for each Sharer. SPLIT-> Split the Rate amount between Sharer Reservations. ENTIRE -> This Sharer will get the total amount of the rate code for all the Sharer Reservations.", + "enum": [ + "Full", + "Entire", + "Split", + "CustomSplit" + ] + }, + "rateRangeType": { "type": "object", + "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.", "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "reservationInfo": { - "description": "Additional reservation information attached to the profile . Eg : History reservation details", + "base": { + "description": "The base amount charged for the accommodation or service.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/reservationInfoType" + "$ref": "#/definitions/totalType" } }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "rateChange": { + "description": "Rate Change Indicator.", + "type": "boolean" } } }, - "hotelAirportType": { - "description": "Airport details of the Hotel", + "packageElementType": { "type": "object", "properties": { - "airportCode": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "description": { - "description": "Description of the airport", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "direction": { - "description": "Directions from the airport to the Hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "amount": { + "$ref": "#/definitions/currencyAmountType" }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "allowance": { + "$ref": "#/definitions/currencyAmountType" }, - "relativePosition": { - "$ref": "#/definitions/relativePositionType" + "description": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + } }, - "transportationList": { - "description": "List of Transportation available from Airport to Hotel.", - "$ref": "#/definitions/transportationCodeListType" - } - } - }, - "hotelAirportsType": { - "description": "Collection of Airport details of the Hotel", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelAirportType" - } - }, - "hotelAmenityType": { - "type": "object", - "properties": { - "code": { + "startDate": { "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "description": { + "endDate": { "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "displayOrder": { - "type": "number" + "format": "date", + "maxLength": 8 }, - "type": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - } - } - }, - "hotelAttractionType": { - "description": "Information about the attractions near the hotel.", - "type": "object", - "properties": { - "address": { - "description": "Address of the attraction.", - "$ref": "#/definitions/addressType" + "packageCode": { + "type": "string" }, - "class": { - "description": "The class of the attraction.", - "type": "string", - "maxLength": 60, - "minLength": 0 + "calculationRule": { + "type": "string" }, - "code": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "postingRhythm": { + "type": "string" }, - "displaySeq": { - "description": "Display sequence of the attraction.", + "quantity": { "type": "integer" }, - "generalDirections": { - "description": "Directions to the attraction from the hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "includedInRate": { + "type": "boolean" }, - "name": { - "description": "Attraction name for the hotel.", - "$ref": "#/definitions/translationTextType2000" + "addRateSeprateLine": { + "type": "boolean" }, - "operationHours": { - "description": "Price range for the attraction.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "addRateCombinedLine": { + "type": "boolean" }, - "priceRange": { - "description": "Price range for the attraction.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "startTime": { + "type": "string" }, - "relativePosition": { - "$ref": "#/definitions/relativePositionType" + "endTime": { + "type": "string" }, - "type": { - "description": "The type of the attraction.", - "type": "string", - "maxLength": 60, - "minLength": 0 + "sellSeparate": { + "type": "boolean" + } + } + }, + "reservationProfileType": { + "type": "object", + "properties": { + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", + "$ref": "#/definitions/profileIdList" }, - "website": { - "description": "Website for the attraction.", - "$ref": "#/definitions/uRLType" + "profile": { + "description": "Provides detailed information regarding either a company or a customer profile.", + "$ref": "#/definitions/profileType" + }, + "reservationProfileType": { + "$ref": "#/definitions/resProfileTypeType" } } }, - "hotelAttractionsType": { + "profileIdList": { "type": "array", + "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { - "$ref": "#/definitions/hotelAttractionType" + "$ref": "#/definitions/uniqueID_Type" } }, - "hotelBanquetSpaceType": { - "description": "Defines the Banquet and Meeting Area of the Hotel", + "profileType": { "type": "object", + "description": "Type provides the detailed information about the profile and its children.", "properties": { - "banquetArea": { - "description": "Defines the BanquetArea of the Hotel", - "type": "string", - "maxLength": 50, - "minLength": 0 + "customer": { + "description": "Detailed customer information for this profile.", + "$ref": "#/definitions/customerType" }, - "banquetSeats": { - "type": "integer" + "company": { + "description": "Detailed company information for this profile.", + "$ref": "#/definitions/companyType" }, - "meetingArea": { - "description": "Defines the Meeting Area of the hotel", - "type": "number" + "profileImage": { + "description": "The profile image.", + "$ref": "#/definitions/imageSetType" }, - "meetingRooms": { - "type": "integer" + "addresses": { + "description": "List of customer addresses.", + "type": "object", + "properties": { + "addressInfo": { + "description": "Collection of Detailed information on an address for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/addressInfoType" + } + }, + "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" + } + } }, - "unitOfMeasureCode": { - "description": "The unit of measure in a code format.", + "businessSegments": { + "description": "Business/Market Segment associated to the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "territory": { + "description": "Territory associated to the profile.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "hotelBrochureDetails": { - "description": "Response object for fetching Basic Property information.", - "type": "object", - "properties": { - "hotelBrochure": { - "$ref": "#/definitions/hotelBrochureType" + "minLength": 0, + "maxLength": 40 }, - "links": { - "$ref": "#/definitions/links" + "traceCode": { + "description": "Trace Code associated to the profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "hotelBrochureType": { - "description": "Contains the basic configuration information about a Hotel.", - "type": "object", - "properties": { - "accommodationDetails": { - "description": "Accommodation Details of the hotel.", + "ownerCode": { + "description": "Owner Code associated to the profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "influenceCode": { + "description": "Influence Code associated to the profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "telephones": { + "description": "List of Telephone Number Information", "type": "object", "properties": { - "accessibleRooms": { - "description": "The number of Accessible Rooms of the Hotel.", + "telephoneInfo": { + "description": "Collection of Detailed information on telephone/fax for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/telephoneInfoType" + } + }, + "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" }, - "connectingRooms": { - "description": "The number of Connecting Rooms of the Hotel.", + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "emails": { + "description": "List of email address for the customer.", + "type": "object", + "properties": { + "emailInfo": { + "description": "Collection of Detailed information on an eMail address for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/emailInfoType" + } + }, + "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" }, - "doubleRooms": { - "description": "The number of Double Rooms of the Hotel.", + "count": { + "description": "Total number of rows returned", "type": "integer" + } + } + }, + "uRLs": { + "description": "List of Information on a URL for the customer.", + "type": "object", + "properties": { + "uRLInfo": { + "description": "Collection of Detailed information on web url/address for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uRLInfoType" + } }, - "executiveFloorNo": { - "description": "The floor number of Executive Floors of the Hotel.", - "type": "string", - "maxLength": 1000, - "minLength": 0 + "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" }, - "familyRooms": { - "description": "The number of Family Rooms of the Hotel.", + "totalResults": { + "description": "Total number of rows queried", "type": "integer" }, - "guestRoomElevators": { - "description": "The number of Guest Room Elevators.", + "count": { + "description": "Total number of rows returned", "type": "integer" + } + } + }, + "comments": { + "description": "List of Notes for the customer.", + "type": "object", + "properties": { + "commentInfo": { + "description": "Collection of Detailed information on comments for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/commentInfoType" + } }, - "guestRoomFloors": { - "description": "The total number of the Guest Room Floors.", + "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" }, - "maxAdultsInFamilyRoom": { - "description": "Maximum Adults for Family Room Type.", + "count": { + "description": "Total number of rows returned", "type": "integer" + } + } + }, + "profileDeliveryMethods": { + "description": "List of Delivery methods configured against a Property for this Profile.", + "type": "object", + "properties": { + "profileDeliveryMethod": { + "description": "Collection of delivery methods for this Profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileDeliveryMethod" + } }, - "maxChildrenInFamilyRoom": { - "description": "Maximum Children for Family Room Type.", + "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" }, - "nonSmokingRooms": { - "description": "The number of Non-Smoking Rooms of the Hotel.", + "count": { + "description": "Total number of rows returned", "type": "integer" + } + } + }, + "profileMemberships": { + "description": "List of loyalty program(s) the profile is subscribed to.", + "type": "object", + "properties": { + "profileMembership": { + "description": "Collection of Detailed information on memberships for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileMembershipType" + } }, - "roomAmenties": { - "description": "The information about the Room Amenities.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "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" }, - "shopDescription": { - "description": "The Description of the shops in the Hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "preferenceCollection": { + "description": "List of customer preferences.", + "type": "object", + "properties": { + "preferenceType": { + "description": "Collection of Detailed information on preferences of the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/preferenceTypeType" + } + }, + "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" + } + } + }, + "keywords": { + "description": "List of customer keywords.", + "type": "object", + "properties": { + "keyword": { + "description": "Collection of keywords attached to the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/keywordType" + } + }, + "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" + } + } + }, + "negotiatedRates": { + "description": "List of profile negotiated rates.", + "type": "object", + "properties": { + "negotiatedRate": { + "description": "Collection of Detailed information on profile negotiated rates.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/negotiatedType" + } }, - "singleRooms": { - "description": "The number of Single Rooms of the Hotel.", - "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" }, - "suites": { - "description": "The number of Suites of the Hotel.", + "totalResults": { + "description": "Total number of rows queried", "type": "integer" }, - "twinRooms": { - "description": "The number of Twin Rooms of the Hotel.", + "count": { + "description": "Total number of rows returned", "type": "integer" } } }, - "address": { - "description": "Provides address information.", + "gdsNegotiatedRates": { + "description": "List of channel negotiated rates that this profile has been assigned to.", "type": "object", "properties": { - "addressLine": { - "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", + "gdsNegotiatedRate": { + "description": "Collection of Detailed information on channel negotiated rates for the profile.", "type": "array", - "maxItems": 4, + "maxItems": 4000, "items": { - "type": "string", - "maxLength": 80, - "minLength": 0 + "$ref": "#/definitions/gdsNegotiatedType" } }, - "barCode": { - "description": "The postal barcode for the address.", - "type": "string", - "maxLength": 100, - "minLength": 0 - }, - "cityExtension": { - "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "cityName": { - "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "country": { - "description": "Country name (e.g., Ireland).", - "$ref": "#/definitions/countryNameType" - }, - "county": { - "description": "County or District Name (e.g., Fairfax). This is read only.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "isValidated": { - "description": "Indicator to define if the Address is validated by the Address Validation System.", - "type": "boolean" - }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" - }, - "postalCode": { - "description": "Post Office Code number.", - "type": "string", - "maxLength": 15, - "minLength": 0 - }, - "primaryInd": { - "description": "When true, indicates a primary information.", + "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" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "regionCode": { - "description": "The region code of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "state": { - "description": "State or Province name (e.g., Texas).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "type": { - "description": "Defines the type of address (e.g. home, business, other).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "typeDescription": { - "description": "Describes the type code", - "type": "string" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "updateReservations": { - "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.", - "type": "boolean" + "count": { + "description": "Total number of rows returned", + "type": "integer" } } }, - "alternateHotels": { - "description": "Informations about alternative hotels provided by the Hotel.", - "$ref": "#/definitions/alternateHotelsType" - }, - "attractions": { - "description": "List of Attractions for the hotel.", - "$ref": "#/definitions/hotelAttractionsType" - }, - "baseLanguage": { - "description": "The base language of the Hotel.", - "$ref": "#/definitions/languageType" - }, - "chainCode": { - "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "chainName": { - "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", - "type": "string", - "maxLength": 80, - "minLength": 0 + "profileIndicators": { + "description": "Indicators of additional information attached to the profile", + "$ref": "#/definitions/indicatorsType" }, - "communication": { - "description": "Communication information of the hotel.", + "relationships": { + "description": "Contains a collection of profiles that have a relationship with this profile.", "type": "object", "properties": { - "emailAddress": { - "description": "Email address of the hotel.", - "$ref": "#/definitions/basicEmailType" - }, - "faxNumber": { - "description": "Fax phone number of the hotel.", - "$ref": "#/definitions/telephoneType" + "relationship": { + "description": "A collection of the profiles that have a relationship with this profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/relationshipInfoType" + } }, - "phoneNumber": { - "description": "The direct dial phone number of the hotel.", - "$ref": "#/definitions/telephoneType" + "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" }, - "tollFreeNumber": { - "description": "Toll free phone number of the hotel.", - "$ref": "#/definitions/telephoneType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "webPage": { - "description": "The web address of the hotel.", - "$ref": "#/definitions/uRLType" + "count": { + "description": "Total number of rows returned", + "type": "integer" } } }, - "currentTime": { - "description": "The time when login hotel brochure.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "directions": { - "description": "Instructions and direction to help reaching the Hotel.", - "$ref": "#/definitions/directionsType" - }, - "generalInformation": { - "description": "General Information of the hotel.", + "relationshipsSummary": { + "description": "Contains a collection of profiles that have a relationship with this profile.", "type": "object", "properties": { - "baseLanguage": { - "description": "The base language of the Hotel.", - "$ref": "#/definitions/languageType" - }, - "bedCount": { - "description": "The total number of beds in the Hotel.", - "type": "integer" - }, - "checkInTime": { - "description": "The official check in time of the Hotel.", - "type": "string", - "format": "date-time" + "relationship": { + "description": "A collection of the profiles summary that have a relationship with this profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/relationshipInfoSummaryType" + } }, - "checkOutTime": { - "description": "The official check out time of the Hotel.", - "type": "string", - "format": "date-time" + "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" }, - "floorCount": { - "description": "The total number of floors of the Hotel.", + "totalResults": { + "description": "Total number of rows queried", "type": "integer" }, - "hotelInfoWebsite": { - "description": "URL where property information is located.", - "$ref": "#/definitions/uRLType" - }, - "hotelType": { - "description": "The type of the Hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "latitude": { - "description": "Latitude of the hotel.", - "type": "number" - }, - "longitude": { - "description": "Longitude of the hotel.", - "type": "number" - }, - "roomCount": { - "description": "The total number of rooms in the Hotel.", + "count": { + "description": "Total number of rows returned", "type": "integer" } } }, - "generalNotes": { - "description": "General Notes provided about the Hotel.", - "$ref": "#/definitions/generalNotesType" + "reservationInfoList": { + "description": "Collection of Detailed information on history and future reservations associated with the profile.", + "$ref": "#/definitions/reservationHistoryFutureInfoType" }, - "hotelAirports": { - "description": "Informations about different airports near by.", - "$ref": "#/definitions/hotelAirportsType" + "stayReservationInfoList": { + "description": "Collection of Detailed information on history and future reservations associated with the profile.", + "$ref": "#/definitions/reservationStayHistoryFutureInfoType" }, - "hotelAttractions": { - "description": "Information about attractive places that can be found around the Hotel.", - "$ref": "#/definitions/hotelAttractionsType" + "lastStayInfo": { + "description": "Information on last stay of the profile.", + "$ref": "#/definitions/lastStayInfoType" }, - "hotelCityCode": { - "description": "The IATA city code; for example DCA, ORD.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "profileAccessType": { + "description": "Detailed information on access type associated with the profile.", + "$ref": "#/definitions/profileAccessType" }, - "hotelCodeContext": { - "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "profileRestrictions": { + "description": "Detailed information on restrictions associated with the profile.", + "$ref": "#/definitions/profileRestrictions" }, - "hotelConferenceFacilities": { - "description": "Information about the conference rooms in the Hotel.", - "$ref": "#/definitions/hotelConferenceFacilitiesType" + "mailingActions": { + "description": "Contains collection of mailing action list associated with the profile", + "$ref": "#/definitions/mailingActionsType" }, - "hotelContacts": { - "description": "The contacts information the hotels.", - "$ref": "#/definitions/hotelContactsType" + "privacyInfo": { + "description": "Contains privacy related information associated with the profile", + "$ref": "#/definitions/privacyInfoType" }, - "hotelCorporateInformations": { - "$ref": "#/definitions/hotelCorporateInformationsType" + "cashiering": { + "description": "Contains cashiering related details for the profile", + "$ref": "#/definitions/profileCashieringType" }, - "hotelEventSpaces": { - "description": "Even Space information of the hotel.", - "$ref": "#/definitions/hotelEventSpacesType" + "commissionInfoList": { + "description": "Contains commission related details for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileCommissionType" + } }, - "hotelFeatures": { - "description": "Lists of features provided by the Hotel", - "$ref": "#/definitions/hotelFeaturesType" + "userDefinedFields": { + "description": "Collections of user defined fields.", + "$ref": "#/definitions/userDefinedFieldsType" }, - "hotelId": { - "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", + "webUserAccounts": { + "description": "List of Web User Accounts of the profile.", + "$ref": "#/definitions/webUserAccountsType" + }, + "taxInfo": { + "description": "Profile information about tax.", + "$ref": "#/definitions/profileTaxInfoType" + }, + "salesInfo": { + "description": "Sales information of the profiles.", + "$ref": "#/definitions/salesInfoType" + }, + "eCertificates": { + "description": "E-Certificate assosiated with the profile.", + "$ref": "#/definitions/eCertificatesType" + }, + "subscriptions": { + "description": "List of profile subscriptions.", + "$ref": "#/definitions/profileSubscriptionListType" + }, + "localizationGuestType": { + "description": "Localization Guest Type assocaited to the profile.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "hotelMiscellaneousInformation": { - "description": "General user defined information provided about the Hotel.", - "$ref": "#/definitions/hotelUserDefinedFieldsType" + "eligibleForFiscalFolio": { + "description": "Eligible for Fiscal Folio/Payload generation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "hotelName": { - "description": "A text field used to communicate the proper name of the hotel.", + "profileType": { + "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", + "$ref": "#/definitions/profileTypeType" + }, + "statusCode": { + "description": "Status of the profile. Active/Inactive", + "$ref": "#/definitions/profileStatusType" + }, + "registeredProperty": { + "description": "Hotel which this profile is registered with. This attribute is not used for configuration.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "hotelNotes": { - "description": "List of notes for the hotel.", - "$ref": "#/definitions/hotelNotesType" + "requestForHotel": { + "description": "Hotel which this profile is to be registered. This attribute is only used during creation of profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "hotelPackages": { - "description": "Packages and offers offered by the Hotel.", - "$ref": "#/definitions/hotelPackagesType" + "protectedBy": { + "description": "What level this profile is protected.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "hotelRateRanges": { - "description": "The rate ranges which are offered by the hotels.", - "$ref": "#/definitions/hotelRateRangesType" + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" }, - "hotelRestaurants": { - "description": "Names of restaurants which can be found in the Hotel.", - "$ref": "#/definitions/hotelRestaurantsType" + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "hotelTransportations": { - "description": "List of different transportation companies around the Hotel.", - "$ref": "#/definitions/hotelTransportationsType" + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" }, - "meetingRooms": { - "description": "List of Meeting Rooms for the hotel.", - "$ref": "#/definitions/meetingRoomsType" + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "primaryDetails": { - "description": "Primary Information of the hotel.", - "type": "object", - "properties": { - "legalOwner": { - "description": "Legal owner of the hotel.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 }, - "propertyControls": { - "description": "Property controls information configuration of the hotel.", - "type": "object", - "properties": { - "applicationMode": { - "description": "Application Mode information configuration of the hotel.", - "type": "object", - "properties": { - "configurationMode": { - "description": "The hotel's configuration mode if applicable.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "countryMode": { - "description": "The hotel's country code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "expHotelCode": { - "description": "Hotel Code used for third party exports.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "mbsSupported": { - "description": "Indicates if the hotel uses MBS (Marriott Business Services).", - "type": "boolean" - }, - "touristNumber": { - "description": "The Tourist Number of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "cateringCurrencyFormatting": { - "description": "Catering Currency Formatting information configuration of the hotel.", - "type": "object", - "properties": { - "currencyCode": { - "description": "The base currency code for this hotel..", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencyFormat": { - "description": "Format for the local currency.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "currencyFormatting": { - "description": "Currency Formatting information configuration of the hotel.", - "type": "object", - "properties": { - "currencyCode": { - "description": "The base currency code for this hotel..", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencyFormat": { - "description": "Format for the local currency.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "currencySymbol": { - "description": "Symbol to designate the default currency of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "decimalPositions": { - "description": "Number of decimal positions used for this currency type.", - "type": "integer" - } - } - }, - "dateTimeFormatting": { - "description": "Date Time Formatting information configuration of the hotel", - "type": "object", - "properties": { - "longDateFormat": { - "description": "Long date format of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "shortDateFormat": { - "description": "Short date format of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "timeFormat": { - "description": "Time format for the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "timeZoneRegion": { - "description": "Time zone region of the hotel.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "sellControls": { - "description": "The sell controls information configuration of the hotel.", - "type": "object", - "properties": { - "endDate": { - "description": "The end date of the hotel.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "hotelId": { - "description": "The hotel code.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "startDate": { - "description": "Date when the hotel become valid for use.", - "type": "string", - "format": "date", - "maxLength": 8 - } - } - } - } + "markAsRecentlyAccessed": { + "description": "Mark this profile as recently accessed.", + "type": "boolean" + }, + "markForHistory": { + "description": "\"true\" setting marks the profile to be kept from being purged, once the profile is marked inactive.", + "type": "boolean" + }, + "hasCommission": { + "description": "Populates true if the profile has commission configured false otherwise.", + "type": "boolean" + }, + "inheritedNegRates": { + "description": "Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.", + "type": "boolean" } } }, - "hotelCalendarDayType": { - "description": "Details of calendar entries for a specific day for a specific hotel.", + "customerType": { "type": "object", + "description": "Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.", "properties": { - "date": { - "description": "Indicates a specific hotel for which the calendar is being represented.", + "personName": { + "description": "Detailed name information for the customer.", + "type": "array", + "maxItems": 5, + "items": { + "$ref": "#/definitions/personNameType" + } + }, + "anonymization": { + "description": "Provides information about the guest's anonymization status", + "$ref": "#/definitions/anonymizationType" + }, + "citizenCountry": { + "description": "Name of the (self-professed) country that is claimed for citizenship.", + "$ref": "#/definitions/countryNameType" + }, + "identifications": { + "description": "List of identification of the customer.", + "type": "object", + "properties": { + "identificationInfo": { + "description": "Collection of detailed information on the identification of the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/identificationInfoType" + } + }, + "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" + } + } + }, + "profession": { + "description": "Profession of a person.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "alienInfo": { + "description": "Immigration/visa information of a foreign person.", + "$ref": "#/definitions/alienInfoType" + }, + "birthCountry": { + "description": "Country of birth.", + "$ref": "#/definitions/countryNameType" + }, + "legalCompany": { + "description": "Name Of the company the individual is associated with.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "companyInfo": { + "description": "Company Information of the Profile.", + "$ref": "#/definitions/companyInfoType" + }, + "businessTitle": { + "description": "Business Title.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "gender": { + "description": "Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "birthDate": { + "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", "type": "string", "format": "date", "maxLength": 8 }, - "dayType": { - "description": "Details of Day Type of that calendar day.", - "$ref": "#/definitions/hotelCalendarDayTypeType" + "birthDateMasked": { + "description": "Indicates the date of birth as masked.", + "type": "string" }, - "events": { - "description": "Details of an event on that calendar day.", - "$ref": "#/definitions/hotelCalendarEventsType" - } - } - }, - "hotelCalendarDayTypeType": { - "description": "Details of Day Type.", - "type": "object", - "properties": { - "code": { - "description": "Code of the Day Type", + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "color": { - "description": "Associated color for the selected Day Type.", - "$ref": "#/definitions/colorType" + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "type": "string", + "minLength": 0, + "maxLength": 10 }, - "description": { - "description": "Description of the Day Type.", + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "type": "integer" + }, + "language": { + "description": "Language identification.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "hotelCalendarDetails": { - "description": "Response object for fetching calendar entries for a hotel.", - "type": "object", - "properties": { - "hotelCalendar": { - "description": "Collection of hotel level calendar entries.", - "$ref": "#/definitions/hotelCalendarType" + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, - "links": { - "$ref": "#/definitions/links" + "nationality": { + "description": "Nationality code identification", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "nationalityDescription": { + "description": "Nationality code description", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "customerValue": { + "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "creditRating": { + "description": "Credit Rating of the customer.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vipStatus": { + "description": "VIP status of the customer.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vipDescription": { + "description": "Description of the VIP status.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "birthPlace": { + "description": "Place of birth.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "privateProfile": { + "description": "This element tells profile is property exclusive or not.", + "type": "boolean" + }, + "blacklist": { + "description": "This element tells if profile is blacklisted or not.", + "type": "boolean" } } }, - "hotelCalendarEventType": { - "description": "Details of event.", + "personNameType": { "type": "object", + "description": "This provides name information for a person.", "properties": { - "code": { - "description": "Code for a specific event.", + "namePrefix": { + "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "description": { - "description": "Description for a specific event.", + "givenName": { + "description": "Given name, first name or names.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "middleName": { + "description": "The middle name of the person name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "surname": { + "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameSuffix": { + "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameTitle": { + "description": "Degree or honors (e.g., Ph.D., M.D.)", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "nameTitleSuffix": { + "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on.", + "type": "integer" + }, + "envelopeGreeting": { + "description": "Envelope Greeting of the profile", + "type": "string" + }, + "salutation": { + "description": "Salutation of the profile", + "type": "string" + }, + "nameType": { + "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", + "$ref": "#/definitions/personNameTypeType" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "externalSystem": { + "description": "When name type is external, indicates the external system the name belongs to.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 } } }, - "hotelCalendarEventsType": { - "description": "Details of hotel events", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelCalendarEventType" - } + "personNameTypeType": { + "type": "string", + "description": "Person's name in an external system.", + "enum": [ + "Primary", + "Alternate", + "Incognito", + "External", + "Phonetic" + ] }, - "hotelCalendarType": { - "description": "Represents the calendar with individual days having corresponding entries (day type, event, etc.) for a hotel.", + "anonymizationType": { "type": "object", + "description": "Provides information about guest's anonymization status.", "properties": { - "calendarDay": { - "description": "Entries for a specific calendar day.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelCalendarDayType" - } + "anonymizationStatus": { + "description": "Status of anonymization such as Requested or Anonymized.", + "$ref": "#/definitions/anonymizationStatusType" }, - "hotelId": { - "description": "Indicates a specific hotel for which the calendar is being represented.", + "anonymizationDate": { + "description": "Date and Time when the guest was anonymized.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date-time" } } }, - "hotelCategoriesCriteria": { - "description": "Request object for creating Hotel Categories.", + "anonymizationStatusType": { + "type": "string", + "description": "Guest has been anonymized.", + "enum": [ + "Requested", + "Anonymized" + ] + }, + "identificationInfoType": { "type": "object", + "description": "Information on the identification of the customer.", "properties": { - "hotelCategories": { - "description": "Hotel Categories to be created.", - "$ref": "#/definitions/hotelCategoriesType" + "identification": { + "description": "Detailed information on the identification of the customer.", + "$ref": "#/definitions/identificationType" }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "hotelCategoriesDetails": { - "description": "Response object for fetching Hotel Categories.", + "identificationType": { "type": "object", + "description": "Identification information of the customer.", "properties": { - "hotelCategories": { - "description": "Collection of Hotel Categories.", - "$ref": "#/definitions/hotelCategoriesType" + "idType": { + "description": "Identification Type. Eg Passport, Driving License etc.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "links": { - "$ref": "#/definitions/links" + "idNumber": { + "description": "Identification Number.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "hotelCategoriesToBeChanged": { - "description": "Request object for changing Hotel Categories.", - "type": "object", - "properties": { - "hotelCategories": { - "description": "Hotel Categories to be changed.", - "$ref": "#/definitions/hotelCategoriesType" + "idNumberMasked": { + "description": "Masked Identification Number.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "links": { - "$ref": "#/definitions/links" + "issuedCountry": { + "description": "The country where Identification was issued.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "hotelCategoriesType": { - "description": "List of Hotel Categories.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelCategoryType" - } - }, - "hotelCategoryType": { - "description": "Contains Common Master configuration detail.", - "type": "object", - "properties": { - "code": { - "description": "Common Master unique code.", + "issuedDate": { + "description": "Issued date of Identification.", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "issuedPlace": { + "description": "The place where Identification was issued.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "displayOrder": { - "description": "Common Master record sequence number.", + "expirationDate": { + "description": "Expiration date of Identification.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "registeredProperty": { + "description": "Property where the identification belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", "type": "number" } } }, - "hotelCodeListType": { - "description": "Hotel code.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 - } - }, - "hotelConferenceFacilitiesType": { + "alienInfoType": { "type": "object", + "description": "immigration/visa information of a foreign person.", "properties": { - "hotelBanquetSpace": { - "description": "Banquet Space of the hotel.", - "$ref": "#/definitions/hotelBanquetSpaceType" + "alienRegistrationNo": { + "description": "Alien Registration Number.", + "type": "string" }, - "hotelConferenceRooms": { - "description": "Conference Rooms of the Hotel.", - "$ref": "#/definitions/hotelConferenceRoomsType" + "immigrationStatus": { + "description": "Immigration Status on an Alien.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "visaValidityType": { + "description": "Visa Type of an Alien.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "hotelConferenceRoomType": { - "description": "Information about the Conference rooms in the hotel.", + "companyInfoType": { "type": "object", + "description": "Company Information of the Profile.", "properties": { - "roomCode": { + "legalCompany": { + "description": "Legal Company.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "roomName": { - "description": "The name of the Restaurant.", + "department": { + "description": "Department of the Profile.", "type": "string", - "maxLength": 1000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "roomType": { - "description": "The Type of Restaurant.", + "position": { + "description": "Business Title or Position of the profile.", "type": "string", - "maxLength": 1000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 } } }, - "hotelConferenceRoomsType": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelConferenceRoomType" - } - }, - "hotelContactRoleType": { - "description": "The contact's role in the hotel. Possible values are Lead, General, and Contract.", - "type": "string", - "enum": [ - "Lead", - "General", - "Contract" - ] - }, - "hotelContactRolesType": { - "description": "Lists of HotelContactRoles of the hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelContactRoleType" - } - }, - "hotelContactType": { - "description": "Contact identification details.", + "companyType": { "type": "object", "properties": { - "communicationAddress": { - "description": "Details about the preferred communication method. Example: email address, fax number, etc.", + "companyName": { + "description": "Name of the company.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "communicationMethod": { - "description": "The preferred method of communication for the contact.", + "companyName2": { + "description": "Second Name of the company.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "hotelId": { - "description": "The code of the hotel.", + "companyName3": { + "description": "Third Name of the company.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "name": { - "description": "Name of the hotel contact.", + "alternateName": { + "description": "Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "nameId": { - "description": "Contact or employee identifier..", - "$ref": "#/definitions/uniqueID_Type" + "alternateLanguage": { + "description": "Alternate Language of the company.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "ownerCode": { - "description": "The contact's code in the hotel.", + "businessLocale": { + "description": "A jurisdiction(Territory) in which a company is authorized to do business.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "iATAInfo": { + "description": "IATA Information of the profile.", + "$ref": "#/definitions/iATAInfoType" + }, + "businessTitle": { + "description": "Business Title.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "type": "integer" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "nationality": { + "description": "Nationality code identification", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "nationalityDescription": { + "description": "Nationality code description", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "commissionCode": { + "description": "Commission code of the company.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "creditRating": { + "description": "Credit Rating of the company.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "corporateIdType": { + "description": "The type of corporate ID", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vipStatus": { + "description": "VIP status of the company.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vipDescription": { + "description": "Description of the VIP status.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "primary": { - "description": "Primary flag.", + "blacklist": { + "description": "This element tells if profile is blacklisted or not.", "type": "boolean" - }, - "roles": { - "description": "List of HotelContactType.", - "$ref": "#/definitions/hotelContactRolesType" - } - } - }, - "hotelContactsCriteria": { - "description": "Request object for creating new Contacts for hotels.", - "type": "object", - "properties": { - "hotelContacts": { - "description": "Collection of hotel contacts to be created.", - "$ref": "#/definitions/hotelContactsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" } } }, - "hotelContactsToBeChanged": { - "description": "Request object for changing hotel Contacts for hotels.", + "iATAInfoType": { "type": "object", + "description": "IATA Information of the profile.", "properties": { - "hotelContacts": { - "description": "Collection of Contacts to be modified.", - "$ref": "#/definitions/hotelContactsType" + "iATACompany": { + "description": "IATA Company Detail.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "iATAConsortia": { + "description": "IATA Consortia.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "iATAValidationResult": { + "description": "IATA Validation Result.", + "type": "boolean" } } }, - "hotelContactsType": { - "description": "Lists of contacts of the hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelContactType" - } - }, - "hotelCorporateInformationsType": { - "description": "Corporate information details of the property", + "imageSetType": { "type": "object", + "description": "Represents on image set record.", "properties": { - "brandCode": { + "language": { + "description": "Language identification.", "type": "string", - "maxLength": 20, - "minLength": 0 + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, - "businessUnit": { - "$ref": "#/definitions/primaryCodesType" + "imageSet": { + "description": "The image set name.", + "type": "string", + "minLength": 0, + "maxLength": 800 }, - "departmentCode": { - "$ref": "#/definitions/primaryCodesType" + "sequenceId": { + "description": "The image set sequence ID.", + "type": "integer" }, - "division": { - "$ref": "#/definitions/primaryCodesType" + "imageStyle": { + "description": "The image set enumerated style.", + "$ref": "#/definitions/imageStyleType" }, - "hotelCategory": { + "imageType": { + "description": "The image set type.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "opertingUnit": { - "$ref": "#/definitions/primaryCodesType" - } - } - }, - "hotelDayTypeCodeType": { - "description": "Base structure for Day Type Code at both template and hotel levels.", - "type": "object", - "properties": { - "adder": { - "description": "Value that will be added to rate on a day.", - "type": "number" - }, - "code": { - "description": "Code of a Day Type.", + "hotelId": { + "description": "The image set hotel code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "color": { - "description": "Color used to represent Day Type.", - "$ref": "#/definitions/colorType" + "chainCode": { + "description": "The image set chain code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description of a Day Type.", + "imageURL": { + "description": "The image set URL.", "type": "string", - "maxLength": 100, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "hotel": { - "description": "Hotel code to which the Day Type is associated.", + "description": { + "description": "The image set description.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "multiplier": { - "description": "Value by which the rates will be multiplied on a day.", - "type": "number" + "imageOrder": { + "description": "The image set order.", + "type": "integer" }, - "sellSequence": { - "description": "Sell sequence for a Day Type.", - "type": "number" + "website": { + "description": "The image set website.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "hotelDayTypeCodesCriteria": { - "description": "Request object for creating new day type codes for a hotel.", - "type": "object", - "properties": { - "hotelDayTypeCodes": { - "description": "Collection of hotel day type codes to be created.", - "$ref": "#/definitions/hotelDayTypeCodesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } + "imageStyleType": { + "type": "string", + "description": "An enumeration of image styles.", + "enum": [ + "Full", + "Thumbnail", + "Icon", + "Square", + "Banner", + "Button", + "Lowres", + "Highres" + ] }, - "hotelDayTypeCodesDetails": { - "description": "Response object for fetching day type codes for a hotel.", + "addressInfoType": { "type": "object", + "description": "Provides address information.", "properties": { - "hotelDayTypeCodes": { - "description": "Collection of hotel level day type codes.", - "$ref": "#/definitions/hotelDayTypeCodesType" + "address": { + "description": "Address details for the profile.", + "$ref": "#/definitions/addressType" }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "hotelDayTypeCodesToBeChanged": { - "description": "Request object for modifying day type codes for a hotel.", + "telephoneInfoType": { "type": "object", + "description": "Information on a telephone number for the customer.", "properties": { - "hotelDayTypeCodes": { - "description": "Collection of hotel day type codes to be changed.", - "$ref": "#/definitions/hotelDayTypeCodesType" + "telephone": { + "description": "Phone details for the profile.", + "$ref": "#/definitions/telephoneType" }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "hotelDayTypeCodesType": { - "description": "Details for day type code at hotel level.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelDayTypeCodeType" - } - }, - "hotelDayTypeType": { - "description": "Details of Day Type to be used to set day types for a hotel.", + "emailInfoType": { "type": "object", + "description": "Information on an email for the customer.", "properties": { - "dateRange": { - "description": "Date Range with days of week where the range update has to be applied.", - "$ref": "#/definitions/timeSpanDaysOfWeekType" + "email": { + "description": "eMail deatils for the profile.", + "$ref": "#/definitions/emailType" }, - "dayTypeCode": { - "description": "Day type code selected.", + "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", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "hotelId": { - "description": "Day type code selected.", + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 } } }, - "hotelDayTypesType": { - "description": "Collection of type details.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelDayTypeType" - } - }, - "hotelDetailType": { - "description": "Base details used for storing information about a hotel detail.", + "emailType": { "type": "object", + "description": "Information on an email for the customer.", "properties": { - "category": { - "description": "Specifies the hotel detail category.", + "emailAddress": { + "description": "Defines the e-mail address.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "code": { - "description": "Specifies the hotel detail code.", + "type": { + "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Specifies the hotel detail description.", + "typeDescription": { + "description": "Describes the Type code", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "hotelDetailValues": { - "description": "Collection of values which are associated with the hotel detail.", - "$ref": "#/definitions/hotelDetailValuesType" + "emailFormat": { + "description": "Supported Email format.", + "type": "string", + "enum": [ + "Html", + "Text" + ] }, - "hotelId": { - "description": "Specifies the hotel code of the hotel detail.", + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + }, + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date-time" }, - "sequence": { - "description": "Specifies the sorting sequence number for the hotel detail.", - "type": "integer" - } - } - }, - "hotelDetailValueType": { - "description": "This type holds the base information of the hotel detail value which will be associated with a hotel detail.", - "type": "object", - "properties": { - "code": { - "description": "Specifies the hotel detail value code.", + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "description": { - "description": "Specifies the description of the hotel detail value.", + "lastModifyDateTime": { + "description": "Time stamp of last modification.", "type": "string", - "maxLength": 200, - "minLength": 0 + "format": "date-time" }, - "newCode": { - "description": "Specifies the new hotel detail value code.", + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "sequence": { - "description": "Specifies the sorting sequence number for the hotel detail value.", - "type": "integer" + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "hotelDetailValuesType": { - "description": "Collection of property level hotel detail values.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelDetailValueType" - } - }, - "hotelDetails": { - "description": "Response object for fetching Property configuration information.", + "uRLInfoType": { "type": "object", + "description": "Web site address.", "properties": { - "hotelConfigInfo": { - "description": "Hotel configuration information.", - "$ref": "#/definitions/hotelInfoType" - }, - "links": { - "$ref": "#/definitions/links" + "url": { + "description": "Provides URL information.", + "$ref": "#/definitions/uRLType" }, - "masterInfoList": { - "description": "Refer to Generic common types document.", - "type": "array", - "items": { - "$ref": "#/definitions/masterInfoType" - } + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "hotelDetailsDetails": { - "description": "Response object for fetching hotel details at the property level.", + "commentInfoType": { "type": "object", + "description": "Comment related to the profile/reservation.", "properties": { - "hotelDetails": { - "description": "Collection of hotel details specified at the property level.", - "$ref": "#/definitions/hotelDetailsType" - }, - "links": { - "$ref": "#/definitions/links" + "comment": { + "description": "Comment details for the comment. It will be empty in case of delete comment.", + "$ref": "#/definitions/commentType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "hotelDetailsType": { - "description": "Collection of property level hotel details.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelDetailType" - } - }, - "hotelEventCodeType": { - "description": "Details of Event to be used to set events for a hotel.", - "type": "object", - "properties": { - "dateRange": { - "description": "Date Range with days of week where the range update has to be applied.", - "$ref": "#/definitions/timeSpanDaysOfWeekType" + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" }, - "eventCode": { - "description": "Event code selected.", + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "hotelId": { - "description": "Code of the hotel for which the events are being set.", + "lastModifyDateTime": { + "description": "Time stamp of last modification.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "hotelEventCodesType": { - "description": "Collection of hotel events.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelEventCodeType" - } - }, - "hotelEventSpaceDetailType": { - "description": "The detail info of hotel event space", - "type": "object", - "properties": { - "code": { - "description": "The code of hotel event space.", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "description": { - "description": "Th description of the hotel event space", + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "maxLength": 2000, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "maxCapacity": { - "description": "Th max capacity of the hotel event space", - "type": "integer" + "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 }, - "maxOccupancies": { - "description": "List of max occupancies of the event space based on the setup code.", - "$ref": "#/definitions/eventSpaceMaxOccupanciesType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "hotelEventSpaceDetailsType": { - "description": "List of detail info of hotel event space", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelEventSpaceDetailType" - } - }, - "hotelEventSpaceSummariesType": { - "description": "List of summary info of hotel event space", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelEventSpaceSummaryType" - } - }, - "hotelEventSpaceSummaryType": { - "description": "The summary info of hotel event space", + "commentType": { "type": "object", + "description": "An indication of a new paragraph for a sub-section of a formatted text message.", "properties": { - "maxCapacity": { - "description": "The max capacity of this event space group", - "type": "integer" + "text": { + "description": "Formatted text content.", + "$ref": "#/definitions/formattedTextTextType" }, - "maxOccupancies": { - "description": "List of max occupancies of the event space based on the setup code.", - "$ref": "#/definitions/eventSpaceMaxOccupanciesType" + "image": { + "description": "An image for this paragraph.", + "type": "string" }, - "no": { - "description": "The total event space number which has the same space type, max capacity and setup style.", - "type": "integer" + "url": { + "description": "A URL for this paragraph.", + "type": "string" }, - "spaceType": { - "description": "The type of the event space", + "commentTitle": { + "description": "Specifies Comment's Title.", "type": "string", - "maxLength": 2000, - "minLength": 0 - } - } - }, - "hotelEventSpacesType": { - "description": "The Detail and Summary info of event space about the hotel", - "type": "object", - "properties": { - "eventSpaceDetails": { - "description": "Even Space Detail information of the hotel.", - "$ref": "#/definitions/hotelEventSpaceDetailsType" + "minLength": 0, + "maxLength": 4000 }, - "eventSpaceSummaries": { - "description": "Event Space Summary information of the hotel.", - "$ref": "#/definitions/hotelEventSpaceSummariesType" + "notificationLocation": { + "description": "Notification Location associated with the Note.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "setupStyles": { - "description": "List of hotel setup style codes of the hotel.", - "$ref": "#/definitions/hotelSetupStylesType" - } - } - }, - "hotelFeatureType": { - "description": "Base details used for amenities.", - "type": "object", - "properties": { - "comments": { - "description": "The comments about amenity of the hotel.", + "type": { + "description": "Specifies type of the comment.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "typeDescription": { + "description": "Comment type Description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "internal": { + "description": "When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.", + "type": "boolean" + }, + "confidential": { + "description": "When true, the comment may be confidential.", + "type": "boolean" + }, + "overrideInternal": { + "description": "When true, the note internal could be modified.", + "type": "boolean" + }, + "protectDescription": { + "description": "When true, the note title will be populated from the note type description and couldn't be modified.", + "type": "boolean" + }, + "hotelId": { + "description": "If specified comment belongs to the Hotel, otherwise it is a global comment.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "The description about amenity of the hotel.", + "actionType": { + "description": "Specifies type of action described in the comments.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "featureCode": { - "description": "Specifies the feature code (aka amenity code).", + "actionDate": { + "description": "Indicates at which date an action described in the comment must be taken.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "hours": { - "description": "The hours of operation of the amenity in the hotel.", + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "maxLength": 1000, - "minLength": 0 + "format": "date-time" }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "priceRange": { - "description": "The price range of the amenity in the hotel.", + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date", + "maxLength": 8 } } }, - "hotelFeaturesType": { - "description": "Collection of Features in the Hotel", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelFeatureType" - } - }, - "hotelInfoType": { - "description": "Contains the basic configuration information about a Hotel.", + "formattedTextTextType": { "type": "object", + "description": "Provides text and indicates whether it is formatted or not.", "properties": { - "accommodationDetails": { - "description": "Accommodation Details of the hotel.", - "type": "object", - "properties": { - "accessibleRooms": { - "description": "The number of Accessible Rooms of the Hotel.", - "type": "integer" - }, - "connectingRooms": { - "description": "The number of Connecting Rooms of the Hotel.", - "type": "integer" - }, - "doubleRooms": { - "description": "The number of Double Rooms of the Hotel.", - "type": "integer" - }, - "executiveFloorNo": { - "description": "The floor number of Executive Floors of the Hotel.", - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "familyRooms": { - "description": "The number of Family Rooms of the Hotel.", - "type": "integer" - }, - "guestRoomElevators": { - "description": "The number of Guest Room Elevators.", - "type": "integer" - }, - "guestRoomFloors": { - "description": "The total number of the Guest Room Floors.", - "type": "integer" - }, - "maxAdultsInFamilyRoom": { - "description": "Maximum Adults for Family Room Type.", - "type": "integer" - }, - "maxChildrenInFamilyRoom": { - "description": "Maximum Children for Family Room Type.", - "type": "integer" - }, - "nonSmokingRooms": { - "description": "The number of Non-Smoking Rooms of the Hotel.", - "type": "integer" - }, - "roomAmenties": { - "description": "The information about the Room Amenities.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "shopDescription": { - "description": "The Description of the shops in the Hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "singleRooms": { - "description": "The number of Single Rooms of the Hotel.", - "type": "integer" - }, - "suites": { - "description": "The number of Suites of the Hotel.", - "type": "integer" - }, - "twinRooms": { - "description": "The number of Twin Rooms of the Hotel.", - "type": "integer" - } - } - }, - "address": { - "description": "Provides address information.", - "type": "object", - "properties": { - "addressLine": { - "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", - "type": "array", - "maxItems": 4, - "items": { - "type": "string", - "maxLength": 80, - "minLength": 0 - } - }, - "barCode": { - "description": "The postal barcode for the address.", - "type": "string", - "maxLength": 100, - "minLength": 0 - }, - "cityExtension": { - "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "cityName": { - "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "country": { - "description": "Country name (e.g., Ireland).", - "$ref": "#/definitions/countryNameType" - }, - "county": { - "description": "County or District Name (e.g., Fairfax). This is read only.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "isValidated": { - "description": "Indicator to define if the Address is validated by the Address Validation System.", - "type": "boolean" - }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" - }, - "postalCode": { - "description": "Post Office Code number.", - "type": "string", - "maxLength": 15, - "minLength": 0 - }, - "primaryInd": { - "description": "When true, indicates a primary information.", - "type": "boolean" - }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "regionCode": { - "description": "The region code of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "state": { - "description": "State or Province name (e.g., Texas).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "type": { - "description": "Defines the type of address (e.g. home, business, other).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "typeDescription": { - "description": "Describes the type code", - "type": "string" - }, - "updateReservations": { - "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.", - "type": "boolean" - } - } - }, - "alternateHotels": { - "description": "Informations about alternative hotels provided by the Hotel.", - "$ref": "#/definitions/alternateHotelsType" - }, - "attractions": { - "description": "List of Attractions for the hotel.", - "$ref": "#/definitions/hotelAttractionsType" - }, - "chainCode": { - "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", + "value": { "type": "string", - "maxLength": 20, - "minLength": 0 + "description": "Property Value" }, - "chainName": { - "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", + "language": { + "description": "Language identification.", "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "communication": { - "description": "Communication information of the hotel.", - "type": "object", - "properties": { - "emailAddress": { - "description": "Email address of the hotel.", - "$ref": "#/definitions/basicEmailType" - }, - "faxNumber": { - "description": "Fax phone number of the hotel.", - "$ref": "#/definitions/telephoneType" - }, - "phoneNumber": { - "description": "The direct dial phone number of the hotel.", - "$ref": "#/definitions/telephoneType" - }, - "tollFreeNumber": { - "description": "Toll free phone number of the hotel.", - "$ref": "#/definitions/telephoneType" - }, - "webPage": { - "description": "The web address of the hotel.", - "$ref": "#/definitions/uRLType" - } - } - }, - "generalInformation": { - "description": "General Information of the hotel.", - "type": "object", - "properties": { - "baseLanguage": { - "description": "The base language of the Hotel.", - "$ref": "#/definitions/languageType" - }, - "bedCount": { - "description": "The total number of beds in the Hotel.", - "type": "integer" - }, - "checkInTime": { - "description": "The official check in time of the Hotel.", - "type": "string", - "format": "date-time" - }, - "checkOutTime": { - "description": "The official check out time of the Hotel.", - "type": "string", - "format": "date-time" - }, - "floorCount": { - "description": "The total number of floors of the Hotel.", - "type": "integer" - }, - "hotelInfoWebsite": { - "description": "URL where property information is located.", - "$ref": "#/definitions/uRLType" - }, - "hotelType": { - "description": "The type of the Hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "latitude": { - "description": "Latitude of the hotel.", - "type": "number" - }, - "longitude": { - "description": "Longitude of the hotel.", - "type": "number" - }, - "roomCount": { - "description": "The total number of rooms in the Hotel.", - "type": "integer" - } - } + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + } + } + }, + "profileDeliveryMethod": { + "type": "object", + "description": "Delivery Information type to the profile.", + "properties": { + "deliveryId": { + "description": "Delivery ID. It will be empty in case of new delivery method.", + "$ref": "#/definitions/uniqueID_Type" }, - "hotelCityCode": { - "description": "The IATA city code; for example DCA, ORD.", + "deliveryType": { + "description": "Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "hotelCodeContext": { - "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", + "deliveryValue": { + "description": "Delivery value holds the corresponding value of the delivery type..", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "hotelContacts": { - "description": "The contacts information the hotels.", - "$ref": "#/definitions/hotelContactsType" - }, - "hotelCorporateInformations": { - "$ref": "#/definitions/hotelCorporateInformationsType" - }, - "hotelEventSpaces": { - "description": "Even Space information of the hotel.", - "$ref": "#/definitions/hotelEventSpacesType" + "minLength": 0, + "maxLength": 2000 }, "hotelId": { - "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "hotelName": { - "description": "A text field used to communicate the proper name of the hotel.", + "description": "Property that has delivery methods configured.", "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "hotelNotes": { - "description": "List of notes for the hotel.", - "$ref": "#/definitions/hotelNotesType" - }, - "hotelRateRanges": { - "description": "The rate ranges which are offered by the hotels.", - "$ref": "#/definitions/hotelRateRangesType" - }, - "hotelRestaurants": { - "description": "Names of restaurants which can be found in the Hotel.", - "$ref": "#/definitions/hotelRestaurantsType" + "minLength": 0, + "maxLength": 20 }, - "meetingRooms": { - "description": "List of Meeting Rooms for the hotel.", - "$ref": "#/definitions/meetingRoomsType" + "deliveryModule": { + "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..", + "$ref": "#/definitions/profileDeliveryModuleType" }, - "primaryDetails": { - "description": "Primary Information of the hotel.", - "type": "object", - "properties": { - "legalOwner": { - "description": "Legal owner of the hotel.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" }, - "propertyControls": { - "description": "Property controls information configuration of the hotel.", - "type": "object", - "properties": { - "applicationMode": { - "description": "Application Mode information configuration of the hotel.", - "type": "object", - "properties": { - "configurationMode": { - "description": "The hotel's configuration mode if applicable.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "countryMode": { - "description": "The hotel's country code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "expHotelCode": { - "description": "Hotel Code used for third party exports.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "mbsSupported": { - "description": "Indicates if the hotel uses MBS (Marriott Business Services).", - "type": "boolean" - }, - "touristNumber": { - "description": "The Tourist Number of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "cateringCurrencyFormatting": { - "description": "Catering Currency Formatting information configuration of the hotel.", - "type": "object", - "properties": { - "currencyCode": { - "description": "The base currency code for this hotel..", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencyFormat": { - "description": "Format for the local currency.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "currencyFormatting": { - "description": "Currency Formatting information configuration of the hotel.", - "type": "object", - "properties": { - "currencyCode": { - "description": "The base currency code for this hotel..", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencyFormat": { - "description": "Format for the local currency.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "currencySymbol": { - "description": "Symbol to designate the default currency of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "decimalPositions": { - "description": "Number of decimal positions used for this currency type.", - "type": "integer" - } - } - }, - "dateTimeFormatting": { - "description": "Date Time Formatting information configuration of the hotel", - "type": "object", - "properties": { - "longDateFormat": { - "description": "Long date format of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "shortDateFormat": { - "description": "Short date format of the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "timeFormat": { - "description": "Time format for the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "timeZoneRegion": { - "description": "Time zone region of the hotel.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "sellControls": { - "description": "The sell controls information configuration of the hotel.", - "type": "object", - "properties": { - "endDate": { - "description": "The end date of the hotel.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "hotelId": { - "description": "The hotel code.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "startDate": { - "description": "Date when the hotel become valid for use.", - "type": "string", - "format": "date", - "maxLength": 8 - } - } - } - } + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" } } }, - "hotelInterfaceStatusType": { - "description": "Status of the Hotel Interface either STOPPED or RUNNING.", + "profileDeliveryModuleType": { "type": "string", + "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..", "enum": [ - "Stopped", - "Running", - "Waiting", - "StopInitiated", - "StartInitiated", - "RebootInitiated", - "Other" + "EfolioExport" ] }, - "hotelInterfaceType": { + "profileMembershipType": { "type": "object", + "description": "Detailed information of the memberships.", "properties": { - "activeFlag": { - "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", + "comment": { + "description": "Additional comments regarding to the membership.", + "$ref": "#/definitions/paragraphType" + }, + "newMembershipNumber": { + "description": "Card Number of the membership.", + "type": "string" + }, + "nameOnCard": { + "description": "Name to be displayed on the membership card.", + "type": "string" + }, + "programDescription": { + "description": "Description of the membership program.", + "type": "string" + }, + "membershipLevel": { + "description": "Indicates the membership level.", + "type": "string" + }, + "membershipLevelDescription": { + "description": "Indicates the membership level description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "membershipClass": { + "description": "Indicates the membership class.", + "type": "string" + }, + "earningPreference": { + "description": "Earning preference to the membership.", + "$ref": "#/definitions/membershipEarningPreferenceType" + }, + "inactive": { + "description": "Indicates whether membership is active or inactive.", "type": "boolean" }, - "hotelId": { - "description": "Hotel Code", + "benefits": { + "description": "benefits for the membership.", + "$ref": "#/definitions/benefitsType" + }, + "tierAdministration": { + "description": "Defines the degree of participation for this membership in the tier management portion of the program.", + "$ref": "#/definitions/tierAdministrationType" + }, + "downgrade": { + "description": "Defines how downgrading will be handled for this membership.", + "$ref": "#/definitions/downgradeType" + }, + "reIssueNewCard": { + "description": "The status of issuing new membership card to the member.", + "$ref": "#/definitions/cardReIssueType" + }, + "excludeFromBatch": { + "description": "True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.", + "type": "boolean" + }, + "upgradeDescription": { + "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 32000 }, - "interfaceId": { - "description": "Unique DB internal number of a Hotel Interface record.", - "$ref": "#/definitions/uniqueID_Type" + "downgradeDescription": { + "description": "Indicates information regarding the member's possible downgrades.", + "type": "string", + "minLength": 0, + "maxLength": 32000 }, - "interfaceName": { - "description": "Name of the Hotel Interface", + "rating": { + "description": "Value Rating Type Description for this membership.", + "type": "string" + }, + "membershipEnrollmentCode": { + "description": "Indicates how the guest enrolled in the program.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "interfaceType": { - "description": "Three letter code for each interface that identifies the interface.", - "$ref": "#/definitions/hotelInterfaceTypeType" + "memberStatus": { + "description": "Indicates where the guest is in the membership enrollment process.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "logo": { - "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "currentPoints": { + "description": "Profile MemberShip Points.", + "type": "number" + }, + "pointsLabel": { + "description": "Label used to refer to points for this membership type", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "machineName": { - "description": "Unique machine name of the running IFC.", + "enrollmentSource": { + "description": "Source from where the enrollment is done.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "status": { - "description": "The current status of the IFC.", - "$ref": "#/definitions/hotelInterfaceStatusType" - } - } - }, - "hotelInterfaceTypeType": { - "description": "XML Posting Interface", - "type": "string", - "enum": [ - "Bms", - "Cas", - "Ccw", - "Dls", - "Eft", - "Exp", - "Mak", - "Mbs", - "Msc", - "Pbx", - "Pos", - "Svs", - "Tik", - "Vid", - "Vms", - "Www", - "Xml" - ] - }, - "hotelNotesCriteria": { - "description": "Request object for creating new Notes for the hotels", - "type": "object", - "properties": { - "hotelNotes": { - "description": "Collection of hotel notes to be created.", - "$ref": "#/definitions/hotelNotesType" + "enrollmentResort": { + "description": "Resort/CRO where enrollment is done.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "preferredCard": { + "description": "Preferred Card.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "hotelNotesToBeChanged": { - "description": "Request object for changing hotel Notes for hotels.", - "type": "object", - "properties": { - "hotelNotes": { - "description": "Collection of Hotel Notes to be modified.", - "$ref": "#/definitions/hotelNotesType" + "membershipId": { + "description": "Card Number of the membership.", + "type": "string" }, - "links": { - "$ref": "#/definitions/links" + "membershipType": { + "description": "Type of membership.", + "type": "string" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "hotelNotesType": { - "description": "List of Notes of the hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/commentInfoType" - } - }, - "hotelPackageType": { - "description": "Information about the packages of the hotel.", - "type": "object", - "properties": { - "beginDate": { - "description": "The begin date of the package.", + "primaryMembershipYn": { + "description": "Indicator if Membership is a Primary Membership.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 1 }, - "endDate": { - "description": "The end date of the package.", + "primaryMembership": { + "description": "Boolean indicator set to True implies membership is a Primary Membership.", + "type": "boolean" + }, + "membershipIdNo": { + "description": "Membership ID Number.", + "type": "integer" + }, + "playerRanking": { + "description": "Ranking assigned to the Player Profile by the Gaming system.", + "type": "integer" + }, + "centralSetup": { + "description": "Indicates how the award points for this membership type will be managed.", + "type": "boolean" + }, + "signupDate": { + "description": "Indicates when the member signed up for the loyalty program.", "type": "string", "format": "date", "maxLength": 8 }, - "packageCode": { + "effectiveDate": { + "description": "Indicates the starting date.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "packageName": { - "description": "The name of the package.", + "expireDate": { + "description": "Indicates the ending date.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "packagePrice": { - "description": "The price of the package.", - "type": "number" + "expireDateExclusiveIndicator": { + "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", + "type": "boolean" }, - "pointsRequired": { - "description": "Indicates the required membership points for the package.", + "orderSequence": { + "description": "Display Order sequence.", "type": "number" }, - "rateCode": { - "description": "Indicates the rate code for the package.", - "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "hotelPackagesType": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelPackageType" - } - }, - "hotelRateRangeType": { - "description": "The rate rage information of the hotel.", - "type": "object", - "properties": { - "currencyCode": { - "description": "The base currency code for rate range(The currency code used by the hotel which the rate range belongs to).", + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date-time" }, - "hotelId": { + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "maxRate": { - "description": "Maximum Rate offered by the hotel.", - "type": "number" + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" }, - "minRate": { - "description": "Minimum Rate offered by the hotel.", - "type": "number" + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "timeSpan": { - "description": "The Start Date and End Date of the Hotel rate range.", - "$ref": "#/definitions/timeSpanType" + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "hotelRateRangesCriteria": { - "description": "Request object for creating new Rate Ranges for hotels.", + "paragraphType": { "type": "object", + "description": "An indication of a new paragraph for a sub-section of a formatted text message.", "properties": { - "hotelRateRanges": { - "description": "Collection of Rate Range to be created.", - "$ref": "#/definitions/hotelRateRangesType" + "text": { + "description": "Formatted text content.", + "$ref": "#/definitions/formattedTextTextType" }, - "links": { - "$ref": "#/definitions/links" + "image": { + "description": "An image for this paragraph.", + "type": "string" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "url": { + "description": "A URL for this paragraph.", + "type": "string" } } }, - "hotelRateRangesToBeChanged": { - "description": "Request object for changing hotel Rate Ranges for hotels.", + "membershipEarningPreferenceType": { + "type": "string", + "description": "The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.", + "enum": [ + "Points", + "Miles" + ] + }, + "benefitsType": { + "type": "array", + "description": "Basic information about membership benefit.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/benefitType" + } + }, + "benefitType": { "type": "object", + "description": "Basic information about membership benefit.", "properties": { - "hotelRateRanges": { - "description": "Collection of Rate Ranges to be modified.", - "$ref": "#/definitions/hotelRateRangesType" + "code": { + "description": "Benefit code associated with a membership.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "message": { + "description": "Processing message for membership benefit.", + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "inactive": { + "description": "Indicates whether membership benefit is active or inactive.", + "type": "boolean" } } }, - "hotelRateRangesType": { - "description": "Lists of rate ranges of the hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelRateRangeType" - } + "tierAdministrationType": { + "type": "string", + "description": "Do not upgrade membership. The membership may be downgraded.", + "enum": [ + "Disabled", + "NoUpgrade" + ] }, - "hotelRestaurantType": { - "description": "Information about the Restaurants in the hotel.", + "downgradeType": { + "type": "string", + "description": "Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.", + "enum": [ + "Grace", + "Never", + "Period" + ] + }, + "cardReIssueType": { + "type": "string", + "description": "Request to re issue a new card.", + "enum": [ + "Pending", + "NotApplicable", + "Requested" + ] + }, + "preferenceTypeType": { "type": "object", + "description": "Preference details for the profile.", "properties": { - "category": { - "description": "The category that the Restaurant belongs to.", - "$ref": "#/definitions/restaurantCategoryType" + "preference": { + "description": "Collection of Preferences for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/preferenceType" + } }, - "comments": { - "description": "Comments about the Restaurant.", + "preferenceType": { + "description": "Preference group code.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "hotelId": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "preferenceTypeDescription": { + "description": "Preference group description.", + "type": "string" }, - "hours": { - "description": "The Hours of Operation of the Restaurant.", - "type": "string", - "maxLength": 1000, - "minLength": 0 + "sequence": { + "description": "Preference Sequence.", + "type": "string" }, - "newRestaurantCode": { - "description": "The new Restaurant Code which is used in the change method.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "maxQuantity": { + "description": "Maximum quantity of preferences allowed per preference group.", + "type": "integer" }, - "orderBy": { + "availableQuantity": { + "description": "Available quantity of preferences (maximum quantity - Existing preferences)per preference group.", "type": "integer" }, - "priceRange": { - "description": "The price range of the Restaurant.", + "maxResortUsedQuantity": { + "description": "Maximum quantity of preferences used by any resort per preference group.", + "type": "integer" + }, + "reservationPreference": { + "description": "Whether this preference is reservation preference or not.", + "type": "boolean" + }, + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date-time" }, - "restaurantCode": { + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "restaurantName": { - "description": "The name of the Restaurant.", + "lastModifyDateTime": { + "description": "Time stamp of last modification.", "type": "string", - "maxLength": 1000, - "minLength": 0 + "format": "date-time" }, - "restaurantType": { - "description": "The Type of Restaurant.", + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", - "maxLength": 1000, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "timeSpan": { - "description": "The Start Date and End Date of the Restaurant.", - "$ref": "#/definitions/timeSpanType" + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "hotelRestaurantsCriteria": { - "description": "Request object for creating new restaurants for hotels.", + "preferenceType": { "type": "object", + "description": "Guest Preference details for the profile.", "properties": { - "hotelRestaurants": { - "description": "Collection of restaurants to be created.", - "$ref": "#/definitions/hotelRestaurantsType" + "preferenceValue": { + "description": "Preference value for display purposes.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "links": { - "$ref": "#/definitions/links" + "description": { + "description": "Preference Description for display purposes.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "global": { + "description": "Whether this preference is property specific or not.", + "type": "boolean" + }, + "source": { + "description": "Source of the preference.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "hotels": { + "description": "If specified preference belongs to the Hotels listed, otherwise it is a global preference.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "preferenceId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "excludedPreferencesCount": { + "description": "Specifies the count of preferences excluded for the attached reservation preference.", + "type": "integer" } } }, - "hotelRestaurantsToBeChanged": { - "description": "Request object for changing hotel restaurants for hotels.", + "keywordType": { "type": "object", "properties": { - "hotelRestaurants": { - "description": "Collection of restaurants to be modified.", - "$ref": "#/definitions/hotelRestaurantsType" + "keywordDetail": { + "description": "The keyword new value, in case keyword value is modified.", + "$ref": "#/definitions/keywordDetailType" }, - "links": { - "$ref": "#/definitions/links" + "type": { + "description": "The type of keyword", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "keyword": { + "description": "The keyword value.", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, - "hotelRestaurantsType": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelRestaurantType" + "keywordDetailType": { + "type": "object", + "properties": { + "newKeyword": { + "description": "The new keyword value.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } } }, - "hotelSetupStylesType": { - "description": "List of event space setup style codes.", - "type": "array", - "maxItems": 5, - "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "negotiatedType": { + "type": "object", + "description": "This holds a list of NegotiatedInfoType.", + "properties": { + "negotiatedInfoList": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/negotiatedInfoType" + } + }, + "hotelId": { + "description": "Hotel code for the negotiated rate.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "rateCode": { + "description": "Rate plan code for the negotiated rate.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } } }, - "hotelSummaryType": { - "description": "A brief summary of information about a hotel.", + "negotiatedInfoType": { "type": "object", + "description": "This provides information for a profile negotiated rate.", "properties": { - "activeDate": { - "description": "Date when the hotel becomes valid for use.", + "corporateAgreementId": { + "description": "The master identifier for multiple offices/locations under the same company profile. This is optional", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 80 }, - "chainCode": { - "description": "Hotels Chain Code. This attribute uniquely assign Hotel to a single chain.", + "comissionCode": { + "description": "Informational purposes only in numeric format.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "hotelId": { - "description": "Code identifying the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "order": { + "description": "The sell order.", + "type": "integer" }, - "hotelName": { - "description": "The name of the hotel.", + "inactive": { + "description": "Negotiated Rate is inactive or not", + "type": "boolean" + }, + "start": { + "description": "The starting value of the date range.", "type": "string", - "maxLength": 80, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "inactiveDate": { - "description": "Date when the hotel becomes invalid for use.", + "end": { + "description": "The ending value of the date range.", "type": "string", "format": "date", "maxLength": 8 } } }, - "hotelTransportationType": { - "description": "Information about the transportations of the hotel.", + "gdsNegotiatedType": { "type": "object", + "description": "This holds a list of GdsNegotiatedInfoType.", "properties": { - "comments": { - "description": "Comments about the transportation.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "description": { - "description": "The description of the transportation.", - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "keyOptions": { - "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", - "$ref": "#/definitions/codeListType" + "gdsNegotiatedInfoList": { + "description": "List of channel negotiated rates for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/gdsNegotiatedInfoType" + } }, - "label": { + "bookingChannelCode": { + "description": "Booking Channel Code.", "type": "string", - "maxLength": 1, - "minLength": 0 - }, - "orderBy": { - "type": "integer" - }, - "phoneNumber": { - "description": "The name of the package.", - "$ref": "#/definitions/telephoneType" + "minLength": 0, + "maxLength": 20 }, - "priceRange": { - "description": "The price range of the transportation.", + "hotelId": { + "description": "Hotel Code.", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "relativePosition": { - "$ref": "#/definitions/relativePositionType" + "minLength": 0, + "maxLength": 20 }, - "transportationCode": { + "channelRatePlanCode": { + "description": "Channel Room Type.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "website": { - "description": "Web address associated with transportation.", - "$ref": "#/definitions/uRLType" + "minLength": 0, + "maxLength": 20 } } }, - "hotelTransportationsType": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelTransportationType" - } - }, - "hotelUserDefinedFieldType": { - "description": "User defined information(UDF) for the hotel.", + "gdsNegotiatedInfoType": { "type": "object", + "description": "This provides information for a channel negotiated rate.", "properties": { - "category": { - "description": "The UDF Category for this information.", + "accessCode": { + "description": "The GDS negotiated rate code.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "infoType": { - "description": "The UDF Type for this information.", + "order": { + "description": "The sell order.", + "type": "integer" + }, + "inactive": { + "description": "The GDS Negotiated Rate is inactive or not", + "type": "boolean" + }, + "start": { + "description": "The starting value of the date range.", "type": "string", - "maxLength": 60, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "information": { - "description": "The UDF attribute for this information.", + "end": { + "description": "The ending value of the date range.", "type": "string", - "maxLength": 60, - "minLength": 0 + "format": "date", + "maxLength": 8 } } }, - "hotelUserDefinedFieldsType": { + "indicatorsType": { "type": "array", + "description": "Collection of lamp indicators.", "maxItems": 4000, "items": { - "$ref": "#/definitions/hotelUserDefinedFieldType" + "$ref": "#/definitions/indicatorType" } }, - "hotelsDetails": { - "description": "Response object for fetching lists of Property summary information.", + "indicatorType": { "type": "object", + "description": "Lamp indicator Type.", "properties": { - "hotelSummaryInfoList": { - "$ref": "#/definitions/hotelsSummaryType" - }, - "links": { - "$ref": "#/definitions/links" + "indicatorName": { + "description": "Name of the indicator.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "count": { + "description": "Indicates number of occurrences of the indicator.", + "type": "integer" } } }, - "hotelsSummaryType": { - "description": "Lists of Hotel summary information.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelSummaryType" - } - }, - "housekeepingRoomStatusType": { - "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", - "type": "string", - "enum": [ - "Clean", - "Dirty", - "Pickup", - "Inspected", - "OutOfOrder", - "OutOfService" - ] - }, - "housekeepingTaskCodeType": { - "description": "Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.", + "relationshipInfoType": { "type": "object", + "description": "Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.", "properties": { - "code": { - "description": "The Code for the task.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "changeRelationship": { + "description": "Information about the changes in relationship for the profile", + "$ref": "#/definitions/changeRelationsType" }, - "description": { - "description": "Description of the Task Code.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "relationshipProfile": { + "description": "Refer to Relationship Profile type document.", + "$ref": "#/definitions/relationshipProfileType" }, - "facilityDepartureTask": { - "description": "Indicates if this task code is the default departure task for Facility Tasks. This requires", - "type": "boolean" + "masterAccountInfo": { + "description": "Refer to Master Profile type document.", + "$ref": "#/definitions/masterAccountInfoType" }, - "hotelId": { - "description": "Property where this task code is configured.", + "id": { + "description": "Relationship identifier.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "instructions": { - "description": "Instructions for this Task Code.", + "relation": { + "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "linenChange": { - "description": "Indicates if a linen change is necessary.", - "type": "boolean" + "minLength": 0, + "maxLength": 20 }, - "sequence": { - "description": "Ordering sequence for display.", - "type": "integer" - } - } - }, - "iATAInfoType": { - "description": "IATA Information of the profile.", - "type": "object", - "properties": { - "iATACompany": { - "description": "IATA Company Detail.", + "relationDescription": { + "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "iATAConsortia": { - "description": "IATA Consortia.", + "targetRelation": { + "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "iATAValidationResult": { - "description": "IATA Validation Result.", - "type": "boolean" + "targetRelationDescription": { + "description": "Displays the description of the target relation(Target Profile).", + "type": "string", + "minLength": 0, + "maxLength": 200 } } }, - "identificationInfoType": { - "description": "Information on the identification of the customer.", + "changeRelationsType": { "type": "object", + "description": "Detailed information regarding the changes made to relationships for the profile.", "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.", + "description": "Relationship identifier.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "identification": { - "description": "Detailed information on the identification of the customer.", - "$ref": "#/definitions/identificationType" + "relation": { + "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "relationDescription": { + "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 200 + }, + "targetRelation": { + "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "targetRelationDescription": { + "description": "Displays the description of the target relation(Target Profile).", + "type": "string", + "minLength": 0, + "maxLength": 200 } } }, - "identificationType": { - "description": "Identification information of the customer.", + "relationshipProfileType": { "type": "object", "properties": { - "expirationDate": { - "description": "Expiration date of Identification.", - "type": "string", - "format": "date", - "maxLength": 8 + "customer": { + "description": "Detailed information of the customer", + "$ref": "#/definitions/customerType" }, - "idNumber": { - "description": "Identification Number.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "company": { + "description": "Detailed information of the Company.", + "$ref": "#/definitions/companyType" }, - "idNumberMasked": { - "description": "Masked Identification Number.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "telephone": { + "description": "Information on telephone details for the customer/company", + "$ref": "#/definitions/telephoneInfoType" }, - "idType": { - "description": "Identification Type. Eg Passport, Driving License etc.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "address": { + "description": "Information on address details for the customer/company", + "$ref": "#/definitions/addressInfoType" }, - "issuedCountry": { - "description": "The country where Identification was issued.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "email": { + "description": "Information on email address for the customer/company", + "$ref": "#/definitions/emailInfoType" }, - "issuedDate": { - "description": "Issued date of Identification.", - "type": "string", - "format": "date", - "maxLength": 8 + "uRLs": { + "description": "Information on web url/address for the customer/company", + "$ref": "#/definitions/uRLInfoType" }, - "issuedPlace": { - "description": "The place where Identification was issued.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "primaryOwner": { + "description": "Primary Owner of the profile", + "$ref": "#/definitions/ownerType" }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "profileIdList": { + "description": "Original profile details for which the relationships was created", + "$ref": "#/definitions/uniqueIDListType" }, - "primaryInd": { - "description": "When true, indicates a primary information.", - "type": "boolean" + "changeProfileIdList": { + "description": "Updated/changed profile details for the relationships created", + "$ref": "#/definitions/uniqueIDListType" }, - "registeredProperty": { - "description": "Property where the identification belongs to.", + "primary": { + "description": "Indicates if this relationship is the primary relationship.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "id": { + "description": "Relationship identifier.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 + }, + "statusCode": { + "description": "Status of the profile. Active/Inactive", + "$ref": "#/definitions/profileStatusType" + }, + "profileType": { + "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", + "$ref": "#/definitions/profileTypeType" } } }, - "imageSetType": { - "description": "Represents on image set record.", + "ownerType": { "type": "object", + "description": "Generic type for information about an owner.", "properties": { - "chainCode": { - "description": "The image set chain code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "hotel": { + "description": "Hotel to which the owner belongs to.", + "$ref": "#/definitions/codeDescriptionType" }, - "description": { - "description": "The image set description.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "userId": { + "description": "Unique application user ID.", + "$ref": "#/definitions/uniqueID_Type" }, - "hotelId": { - "description": "The image set hotel code.", + "userName": { + "description": "Unique application user name of the owner.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "imageOrder": { - "description": "The image set order.", - "type": "integer" + "minLength": 0, + "maxLength": 40 }, - "imageSet": { - "description": "The image set name.", + "ownerCode": { + "description": "Unique Code to identify the owner.", "type": "string", - "maxLength": 800, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "imageStyle": { - "description": "The image set enumerated style.", - "$ref": "#/definitions/imageStyleType" + "profileId": { + "description": "Unique owner profile information.", + "$ref": "#/definitions/profileId" }, - "imageType": { - "description": "The image set type.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "name": { + "description": "Provides name information of the owner.", + "$ref": "#/definitions/personNameType" }, - "imageURL": { - "description": "The image set URL.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "department": { + "description": "Department to which the owner belongs to.", + "$ref": "#/definitions/codeDescriptionType" }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "email": { + "description": "Email information of the owner.", + "$ref": "#/definitions/emailInfoType" }, - "sequenceId": { - "description": "The image set sequence ID.", - "type": "integer" + "phone": { + "description": "Information on the telephone number of the owner.", + "$ref": "#/definitions/telephoneInfoType" }, - "website": { - "description": "The image set website.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "relationship": { + "description": "Relationship of the owner within the profile or block.", + "$ref": "#/definitions/codeDescriptionType" + }, + "primary": { + "description": "When true, this is a primary owner.", + "type": "boolean" } } }, - "imageStyleType": { - "description": "An enumeration of image styles.", - "type": "string", - "enum": [ - "Full", - "Thumbnail", - "Icon", - "Square", - "Banner", - "Button", - "Lowres", - "Highres" - ] - }, - "indicatorType": { - "description": "Lamp indicator Type.", + "codeDescriptionType": { "type": "object", + "description": "This contains a generic code and description information.", "properties": { - "count": { - "description": "Indicates number of occurrences of the indicator.", - "type": "integer" + "code": { + "description": "Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "indicatorName": { - "description": "Name of the indicator.", + "description": { + "description": "description.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 } } }, - "indicatorsType": { - "description": "Collection of lamp indicators.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/indicatorType" - } - }, - "instanceLink": { - "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", + "profileId": { "type": "object", - "required": [ - "href", - "rel", - "method", - "operationId" - ], + "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": { - "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.", + "url": { + "description": "URL that identifies the location associated with the record identified by the UniqueID.", "type": "string" }, - "method": { - "description": "HTTP method for requesting the target of the link.", + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE", - "PATCH", - "OPTIONS", - "HEAD" - ] + "minLength": 0, + "maxLength": 20 }, - "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" + "instance": { + "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "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" + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "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" + "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 }, - "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 + "idExtension": { + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" + } + } + }, + "uniqueIDListType": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "profileStatusType": { + "type": "string", + "enum": [ + "Active", + "Inactive" + ] + }, + "profileTypeType": { + "type": "string", + "description": "The types of Profile handled by the web service.", + "enum": [ + "Guest", + "Agent", + "Company", + "Group", + "Source", + "Employee", + "Hotel", + "Vendor", + "Contact", + "Purge", + "BusinessHeader", + "BillingAccount", + "Activity", + "Potential", + "Account" + ] + }, + "masterAccountInfoType": { + "type": "object", + "properties": { + "masterAccountId": { + "description": "Unique ID of the Master account.", + "$ref": "#/definitions/uniqueID_Type" }, - "title": { - "description": "Exact copy of the \"summary\" field on the linked operation.", - "type": "string" + "masterAccountName": { + "description": "Name of the Master account.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "interfaceRightsStatusType": { + "relationshipInfoSummaryType": { "type": "object", + "description": "RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.", "properties": { - "category": { - "description": "Category code of this interface right.", + "relationshipProfile": { + "description": "Refer to Relationship Profile Summary type document.", + "$ref": "#/definitions/relationshipProfileSummaryType" + }, + "masterAccountDetails": { + "description": "Refer to Master Profile type document.", + "$ref": "#/definitions/masterAccountInfoType" + }, + "relationshipID": { + "description": "Relationship identifier.", "type": "string", - "maxLength": 1, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "description": { - "description": "User defined description for an Interface Right.", + "sourceRelation": { + "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "right": { - "description": "Internal code for each allowed right of a Hotel Interface record.", - "type": "integer" + "sourceRelationDescription": { + "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "statusCode": { - "description": "User defined code for an Interface Right.", + "targetRelation": { + "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "targetRelationDescription": { + "description": "Displays the description of the target relation(Target Profile).", "type": "string", - "maxLength": 5, - "minLength": 0 + "minLength": 0, + "maxLength": 200 } } }, - "jobTitleType": { - "description": "Base details common between both template and hotel job titles.", + "relationshipProfileSummaryType": { "type": "object", "properties": { - "code": { - "description": "Job Title Code.", + "customerName": { + "description": "Name of the customer", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "description": { - "description": "Description of the job title.", - "$ref": "#/definitions/translationTextType80" + "companyName": { + "description": "Name of the company.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "displayClosingScript": { - "description": "Flag to indicate if display reservation closing script.", - "type": "boolean" + "telephoneNumber": { + "description": "Telephone number assigned to a single location", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "hotelId": { - "description": "Property Code where the job title belongs to.", + "address": { + "description": "Information on address details for the customer/company", + "$ref": "#/definitions/relationshipAddressType" + }, + "emailAddress": { + "description": "Defines the e-mail address.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "jobTitlesCriteria": { - "description": "Request object for creating new job titles for hotels.", - "type": "object", - "properties": { - "jobTitles": { - "description": "Collection of job titles to be created.", - "$ref": "#/definitions/jobTitlesType" + "minLength": 0, + "maxLength": 2000 }, - "links": { - "$ref": "#/definitions/links" + "ownerCode": { + "description": "Unique Code to identify the owner.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "jobTitlesDetails": { - "description": "Response object for fetching job titles configured for hotels.", - "type": "object", - "properties": { - "jobTitles": { - "description": "Collection of job titles.", - "$ref": "#/definitions/jobTitlesType" + "profileIdList": { + "description": "Original profile details for which the relationships was created", + "$ref": "#/definitions/uniqueIDListType" }, - "links": { - "$ref": "#/definitions/links" + "primary": { + "description": "Indicates if this relationship is the primary relationship.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "jobTitlesToBeChanged": { - "description": "Request object for modifying job titles for hotels.", - "type": "object", - "properties": { - "jobTitles": { - "description": "Collection of job titles to be modified.", - "$ref": "#/definitions/jobTitlesType" + "profileStatus": { + "description": "Status of the profile. Active/Inactive", + "$ref": "#/definitions/profileStatusType" }, - "links": { - "$ref": "#/definitions/links" + "primaryOwnerCode": { + "description": "When true, this is a primary owner.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "profileType": { + "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", + "$ref": "#/definitions/profileTypeType" } } }, - "jobTitlesType": { - "description": "Job Title details for a hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/jobTitleType" - } - }, - "keywordDetailType": { + "relationshipAddressType": { "type": "object", + "description": "Provides address information for a Relationship.", "properties": { - "newKeyword": { - "description": "The new keyword value.", + "addressLine": { + "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", + "type": "array", + "maxItems": 4, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 80 + } + }, + "city": { + "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "keywordType": { - "type": "object", - "properties": { - "keyword": { - "description": "The keyword value.", + "minLength": 0, + "maxLength": 40 + }, + "postalCode": { + "description": "Post Office Code number.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 15 }, - "keywordDetail": { - "description": "The keyword new value, in case keyword value is modified.", - "$ref": "#/definitions/keywordDetailType" + "state": { + "description": "State or Province name (e.g., Texas).", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "type": { - "description": "The type of keyword", + "country": { + "description": "Country name (e.g., Ireland).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 } } }, - "languageType": { - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "languagesCriteria": { - "description": "Request object for creating new language records.", + "reservationHistoryFutureInfoType": { "type": "object", + "description": "Information of History and Future Reservation details attached to Profiles.", "properties": { - "languages": { - "description": "Collection containing details of languages to be created.", - "$ref": "#/definitions/configLanguagesType" - }, - "links": { - "$ref": "#/definitions/links" + "historyList": { + "description": "Refer to History list type document.", + "$ref": "#/definitions/historyListType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "futureList": { + "description": "Refer to Future list type document.", + "$ref": "#/definitions/futureListType" } } }, - "languagesDetails": { - "description": "Response object for fetching languages.", + "historyListType": { "type": "object", + "description": "A collection of reservation history details attached to Profiles.", "properties": { - "languages": { - "description": "Collection of languages.", - "$ref": "#/definitions/configLanguagesType" + "reservationInfo": { + "description": "Additional reservation information attached to the profile . Eg : History reservation details", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationInfoType" + } }, - "links": { - "$ref": "#/definitions/links" + "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" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" } } }, - "languagesToBeChanged": { - "description": "Request object for changing details of existing language records.", + "reservationInfoType": { "type": "object", + "description": "The Reservation class contains the current reservation being created or altered.", "properties": { - "languages": { - "description": "Collection containing details of languages to be changed.", - "$ref": "#/definitions/configLanguagesType" + "reservationIdList": { + "description": "Unique identifiers for the reservation for both internal and external systems", + "$ref": "#/definitions/reservationIdList" }, - "links": { - "$ref": "#/definitions/links" + "externalReferences": { + "description": "External Reference information for Reservation.", + "$ref": "#/definitions/externalReferencesType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "lastStayInfoType": { - "description": "Contains last stay related details for the profile", - "type": "object", - "properties": { - "lastRate": { - "description": "Used to hold last rate information for the profile.", - "$ref": "#/definitions/currencyAmountType" + "roomStay": { + "description": "Collection of room stays.", + "$ref": "#/definitions/stayInfoType" }, - "lastRoom": { - "description": "Used to hold last room information for the profile.", - "type": "string" + "reservationGuest": { + "description": "Collection of guests associated with the reservation.", + "$ref": "#/definitions/resGuestInfoType" }, - "lastVisit": { - "description": "Used to hold last stay information for the profile.", + "sharedGuests": { + "description": "Collection of guests who share this reservation.", + "$ref": "#/definitions/resSharedGuestListType" + }, + "attachedProfiles": { + "description": "List of attached profiles", + "$ref": "#/definitions/resAttachedProfileListType" + }, + "reservationPaymentMethod": { + "description": "Payment method used for this reservation", + "$ref": "#/definitions/reservationPaymentMethodType" + }, + "reservationFolioWindows": { + "description": "Collection of reservation folio windows.", + "$ref": "#/definitions/reservationFolioWindowsType" + }, + "specials": { + "description": "Set of reservation preferences which belongs to the Specials group.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "lastPrivacyPromptDate": { + "description": "Last Privacy Prompt Date", "type": "string", "format": "date", "maxLength": 8 }, - "totalStay": { - "description": "The total number of previous stay of the profile.", - "type": "integer" - } - } - }, - "links": { - "type": "array", - "items": { - "$ref": "#/definitions/instanceLink" - } - }, - "mailingActionsType": { - "description": "Defines mailing action list for the profile.", - "type": "object", - "properties": { - "active": { - "description": "When true indicates that profile has subscribed to the mailing list.", - "type": "boolean" + "displayColor": { + "description": "Color setting of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "reservationIndicators": { + "description": "Indicators of additional information attached to the reservation", + "$ref": "#/definitions/indicatorsType" }, - "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" + "roomStatus": { + "description": "Current room status", + "$ref": "#/definitions/housekeepingRoomStatusType" }, - "mailingAction": { - "description": "Defines mailing action code and description.", + "searchMatches": { + "description": "Super Search matching terms.", + "$ref": "#/definitions/searchMatchesType" + }, + "sourceOfSale": { + "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", + "$ref": "#/definitions/sourceOfSaleType" + }, + "waitlist": { + "description": "Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.", + "$ref": "#/definitions/waitlistResType" + }, + "queue": { + "description": "Information about the time and duration this reservation was on Queue for Checkin.", + "$ref": "#/definitions/reservationQueueInformationType" + }, + "housekeeping": { + "description": "Information regarding housekeeping for this reservation.", + "$ref": "#/definitions/resHousekeepingType" + }, + "cashiering": { + "description": "Holds cashiering related information for the reservation.", + "$ref": "#/definitions/resCashieringType" + }, + "taxType": { + "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", + "$ref": "#/definitions/taxTypeType" + }, + "deposit": { + "description": "Holds reservation deposit information.", + "$ref": "#/definitions/reservationDepositType" + }, + "allowedActions": { + "description": "Collection of reservation allowed actions.", + "$ref": "#/definitions/reservationAllowedActionsType" + }, + "revenuesAndBalances": { + "description": "Revenues and Balances Amount summary for the reservation.", + "$ref": "#/definitions/resRevenueBalanceType" + }, + "hotelInterfaceStatusList": { + "description": "Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/codeDescriptionType" + "$ref": "#/definitions/reservationInterfaceStatusType" } }, - "totalResults": { - "description": "Total number of rows queried", + "guestPreferredCurrency": { + "description": "Currency code preferred by guest.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "turndownInfo": { + "description": "Currency code preferred by guest.", + "$ref": "#/definitions/reservationTurndownInfoType" + }, + "mobileNotifications": { + "description": "Denotes the status of Room Ready, Key Ready messages.", + "$ref": "#/definitions/resMobileNotificationsType" + }, + "reservationCommunication": { + "description": "Collection of reservation communication details.", + "$ref": "#/definitions/resCommunicationType" + }, + "advanceCheckIn": { + "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", + "$ref": "#/definitions/advanceCheckInType" + }, + "welcomeOffer": { + "description": "This flag will determine wheather the reservation is eligible for Welcome Offer or not.", + "type": "boolean" + }, + "cancellationInfo": { + "description": "Information regarding why reservation has been/was cancelled.", + "type": "object", + "properties": { + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "code": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "date": { + "description": "Date when reservation was last cancelled.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "keyCount": { + "description": "Number of keys created for the reservation.", "type": "integer" - } - } - }, - "marketingCitiesByRegionDetails": { - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" }, - "marketingCities": { - "$ref": "#/definitions/regionsType" + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "hotelName": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "expectedServiceTime": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomStayReservation": { + "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.", + "type": "boolean" + }, + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" + }, + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "reservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" + }, + "computedReservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" + }, + "walkInIndicator": { + "description": "When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.", + "type": "boolean" + }, + "accessRestriction": { + "description": "Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.", + "$ref": "#/definitions/resAccessRestrictionType" + }, + "commissionPayoutTo": { + "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.", + "$ref": "#/definitions/commissionPayoutToType" + }, + "paymentMethod": { + "description": "Payment Method.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "preRegistered": { + "description": "Defines if the reservation is pre-registered or not.", + "type": "boolean" + }, + "openFolio": { + "description": "Returns true when reservation has an open folio.", + "type": "boolean" + }, + "allowMobileCheckout": { + "description": "Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.", + "type": "boolean" + }, + "allowMobileViewFolio": { + "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.", + "type": "boolean" + }, + "optedForCommunication": { + "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.", + "type": "boolean" } } }, - "marketingCitiesCriteria": { - "description": "Request object for creating new marketing cities for hotels.", + "reservationIdList": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "externalReferencesType": { + "type": "array", + "description": "This type contains unique information of external reference.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/externalReferenceType" + } + }, + "externalReferenceType": { "type": "object", + "description": "This type contains unique information of external reference.", "properties": { - "links": { - "$ref": "#/definitions/links" + "id": { + "description": "Unique ID of external reference.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "marketingCities": { - "description": "Collection of marketing cities to be created.", - "$ref": "#/definitions/marketingCitiesType" + "idExtension": { + "description": "ID extension for external reference.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "idContext": { + "description": "ID context for external reference.", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, - "marketingCitiesDetails": { - "description": "Response object for fetching marketing cities configured for hotels.", + "stayInfoType": { "type": "object", + "description": "Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.", "properties": { - "count": { - "description": "Total number of rows returned", - "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" + "arrivalDate": { + "type": "string", + "format": "date" }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "departureDate": { + "type": "string", + "format": "date" }, - "links": { - "$ref": "#/definitions/links" + "originalTimeSpan": { + "description": "The Original Time Span covers the Room Stay dates of the original reservation.", + "$ref": "#/definitions/timeSpanType" }, - "marketingCities": { - "description": "Collection of marketing cities.", - "$ref": "#/definitions/marketingCitiesType" + "expectedTimes": { + "description": "The expected arrival, return and departure times of the guest.", + "$ref": "#/definitions/resExpectedTimesType" }, - "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.", + "adultCount": { + "description": "A collection of Guest Counts associated with Room Stay.", "type": "integer" }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", + "childCount": { + "description": "A collection of Child Counts associated with Room Stay.", "type": "integer" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "roomClass": { + "description": "Room class code", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "marketingCitiesToBeChanged": { - "description": "Request object for modifying marketing cities for hotels.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "roomType": { + "description": "Room type code", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "marketingCities": { - "description": "Collection of marketing cities to be modified.", - "$ref": "#/definitions/marketingCitiesType" + "componentRoomType": { + "description": "True indicates room type is a component type.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "marketingCitiesType": { - "description": "Marketing city details for a hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/marketingCityConfigType" - } - }, - "marketingCityConfigType": { - "description": "Base details of the marketing city.", - "type": "object", - "properties": { - "description": { - "description": "Description of the marketing city.", + "numberOfRooms": { + "description": "Room Id", + "type": "integer" + }, + "roomId": { + "description": "Room Id", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "direction": { - "description": "Direction of the marketing city in relation to the hotel.", + "ratePlanCode": { + "description": "Rate plan code", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "distance": { - "description": "Distance from the hotel to the marketing city.", - "type": "number" + "rateAmount": { + "description": "Rate amount", + "$ref": "#/definitions/currencyAmountType" }, - "distanceType": { - "description": "Unit of distance for the Distance measurement.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "points": { + "description": "The Points contains the number of points used to book a particular room type.", + "$ref": "#/definitions/pointsType" }, - "drivingTime": { - "description": "Driving time from the hotel to the marketing city.", + "rateSuppressed": { + "description": "Whether this rate should be suppressed from view", + "type": "boolean" + }, + "reservationBlock": { + "description": "Key information about the block for this reservation.", + "$ref": "#/definitions/reservationBlockType" + }, + "bookingChannelCode": { + "description": "Booking channel code", "type": "string", - "maxLength": 100, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "hotelId": { - "description": "Hotel the marketing city belongs to.", + "linkCode": { + "description": "Party code", "type": "string", - "maxLength": 20, - "minLength": 0 + "maxLength": 2000 }, - "inactive": { - "description": "Flag to indicate whether the marketing city is inactive or not.", + "fixedRate": { + "description": "True if the rate is a fixed rate, otherwise false", "type": "boolean" }, - "marketingCity": { - "description": "Marketing city code.", + "totalAmount": { + "description": "The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.", + "$ref": "#/definitions/currencyAmountType" + }, + "guarantee": { + "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.", + "$ref": "#/definitions/resGuaranteeType" + }, + "promotion": { + "description": "Promotion Codes", + "$ref": "#/definitions/promotionType" + }, + "marketCode": { + "description": "Market code", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "regionCode": { - "description": "Region that the marketing city belongs to.", + "marketDescription": { + "description": "Description of Market code", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 4000 }, - "sequence": { - "description": "Sequence number for displaying the marketing city.", - "type": "integer" - } - } - }, - "marketingCityType": { - "type": "object", - "properties": { - "cityHotels": { - "description": "Hotels under this Marketing City.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/cityHotelInfoType" - } + "sourceCode": { + "description": "Source of business", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description of the Marketing City", + "sourceCodeDescription": { + "description": "Description of the source of business.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 4000 }, - "marketingCity": { - "description": "Hotels under this Marketing City.", + "balance": { + "description": "Balance amount", + "$ref": "#/definitions/currencyAmountType" + }, + "compBalance": { + "description": "Comp Balance amount", + "$ref": "#/definitions/currencyAmountType" + }, + "roomTypeCharged": { + "description": "Room type code that was charged", "type": "string", - "maxLength": 40, - "minLength": 0 - } - } - }, - "marketingRegionType": { - "description": "Contains Common Master configuration detail.", - "type": "object", - "properties": { - "code": { - "description": "Common Master unique code.", + "minLength": 0, + "maxLength": 20 + }, + "depositPayments": { + "description": "A collection of deposit and/or payments for the Room Stay.", + "$ref": "#/definitions/currencyAmountType" + }, + "guestServiceStatus": { + "description": "Service Status of In House guest like DND or MUP", + "$ref": "#/definitions/guestHousekeepingServiceRequestType" + }, + "scheduledCheckoutTime": { + "description": "Indicates that this reservation is scheduled for automated check out.", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date" }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "roomNumberLocked": { + "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.", + "type": "boolean" }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "marketingRegionsCriteria": { - "description": "Request object for creating Marketing Regions.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "pseudoRoom": { + "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.", + "type": "boolean" }, - "marketingRegions": { - "description": "Marketing Regionsto be created.", - "$ref": "#/definitions/marketingRegionsType" + "assignedByAI": { + "description": "Represents the room was assigned by AI Room Assignment.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "upgradedByAI": { + "description": "Represents the room was assigned by AI Room Assignment.", + "type": "boolean" } } }, - "marketingRegionsDetails": { - "description": "Response object for fetching Marketing Regions.", + "resExpectedTimesType": { "type": "object", + "description": "Holds the Arrival and Departure Time Information", "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "marketingRegions": { - "description": "Collection of Marketing Regions.", - "$ref": "#/definitions/marketingRegionsType" + "reservationExpectedArrivalTime": { + "description": "Arrival Time", + "type": "string", + "format": "date-time" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "reservationExpectedDepartureTime": { + "description": "Departure Time", + "type": "string", + "format": "date-time" } } }, - "marketingRegionsToBeChanged": { - "description": "Request object for changing Marketing Regions.", + "reservationBlockType": { "type": "object", + "description": "Key information about the block for a reservation.", "properties": { - "links": { - "$ref": "#/definitions/links" + "blockIdList": { + "description": "Collection of unique block identifiers for the reservation.", + "$ref": "#/definitions/blockIdList" }, - "marketingRegions": { - "description": "Marketing Regionsto be changed.", - "$ref": "#/definitions/marketingRegionsType" + "blockName": { + "description": "The Name of the block that is attached to the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "hotelId": { + "description": "This is the HotelCode of the Block.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "marketingRegionsType": { - "description": "List of Marketing Regions.", + "blockIdList": { "type": "array", + "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { - "$ref": "#/definitions/marketingRegionType" + "$ref": "#/definitions/uniqueID_Type" } }, - "masterAccountInfoType": { + "resGuaranteeType": { "type": "object", + "description": "Validations type record returned after Validations are done.", "properties": { - "masterAccountId": { - "description": "Unique ID of the Master account.", - "$ref": "#/definitions/uniqueID_Type" + "guaranteeCode": { + "description": "Guarantee Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "masterAccountName": { - "description": "Name of the Master account.", + "shortDescription": { + "description": "Guarantee Code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 80 + }, + "onHold": { + "description": "Guarantee Code.", + "type": "boolean" } } }, - "masterInfoCodeDetailType": { - "type": "string", - "enum": [ - "LongDescription", - "ShortDescription" - ] - }, - "masterInfoType": { + "promotionType": { "type": "object", + "description": "Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.", "properties": { - "codeInfo": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/codeInfoType" - } + "promotionCode": { + "description": "Promotion code associated with the rate plan.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "codeType": { - "$ref": "#/definitions/masterType" + "promotionName": { + "description": "Promotion code Name associated with the rate plan.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "couponCode": { + "description": "Promotion Coupon Code when promotion is setup to have a valid coupon code.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "masterRestrictionStatusesType": { - "type": "string", - "enum": [ - "Closed", - "ClosedForArrival", - "ClosedForDeparture", - "MinimumStayThrough", - "MaximumStayThrough", - "MinimumLengthOfStay", - "MaximumLengthOfStay", - "LOSNotAvailable", - "MinimumAdvanceBooking", - "MaximumAdvanceBooking", - "Open", - "OpenForArrival", - "OpenForDeparture", - "Hurdle", - "MinimumOccupancy", - "MaximumOccupancy", - "RateStrategy", - "RateDetailsNotSet", - "InventoryItemNotAvailable", - "RankRestriction", - "MaximumAuth", - "InventoryNotAvailable", - "RoomClassNotAvailable", - "RoomTypeNotAvailable", - "BlockSellLimit", - "OnRequest" - ] - }, - "masterType": { + "guestHousekeepingServiceRequestType": { "type": "string", + "description": "Possible values for the Guest Service Status.", "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" + "DoNotDisturb", + "MakeUpRoom", + "NoStatusSelected" ] }, - "mealPlanCodeType": { - "description": "Meal plan codes associated with the rate codes.", + "resGuestInfoType": { "type": "object", + "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.", "properties": { - "breakfastIncluded": { - "description": "Represents if the meal plan code is available for breakfast or not.", - "type": "boolean" + "membership": { + "description": "The Membership object identifying the frequent customer reward program.", + "$ref": "#/definitions/membershipInfoType" + }, + "namePrefix": { + "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)", + "$ref": "#/definitions/namePrefixType" + }, + "givenName": { + "description": "Given name, first name or names", + "$ref": "#/definitions/givenNameType" + }, + "alternateGivenName": { + "description": "Alternate given name, first name or names", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "middleName": { + "description": "The middle name of the person name", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "surnamePrefix": { + "description": "e.g \"van der\", \"von\", \"de\"", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "surname": { + "description": "Family name, last name.", + "$ref": "#/definitions/surnameType" + }, + "alternateSurname": { + "description": "Alternate family name, last name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameSuffix": { + "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "nameTitle": { + "description": "Degree or honors (e.g., Ph.D., M.D.)", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "fullName": { + "description": "Full display name", + "type": "string" + }, + "alternateFullName": { + "description": "Altername full display name", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number", + "$ref": "#/definitions/phoneNumberType" + }, + "email": { + "description": "Email address", + "$ref": "#/definitions/basicEmailType" + }, + "birthDate": { + "description": "Date of birth", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "nationality": { + "description": "Affiliation or ethnicity to a particular country.", + "$ref": "#/definitions/countryNameType" + }, + "vip": { + "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", + "$ref": "#/definitions/vIPType" + }, + "address": { + "description": "Address information that is attached to the reservation guest", + "$ref": "#/definitions/addressSearchType" + }, + "anonymization": { + "description": "Provides information about the guest's anonymization status", + "$ref": "#/definitions/anonymizationType" + }, + "accompanyGuests": { + "description": "List of guest names that are accompanying the reservation guest", + "$ref": "#/definitions/resAccompanyGuestListType" + }, + "externalInfo": { + "description": "External information about the guest associated with the reservation.", + "$ref": "#/definitions/resGuestExternalInfoType" + }, + "guestLastStayInfo": { + "description": "Contains information regarding the last stay of this guest.", + "$ref": "#/definitions/guestLastStayInfoType" }, - "code": { - "description": "Meal plan code.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "guestRestrictedCode": { + "description": "Guest profile restricted reason code", + "type": "string" }, - "dinnerIncluded": { - "description": "Represents if the meal plan code is available for dinner or not.", - "type": "boolean" + "guestRestrictedReasonDesc": { + "description": "Guest profile restricted reason description", + "type": "string" }, - "included": { - "description": "Represents if the meal plan code is included in rate code or not.", + "guestRestricted": { + "description": "True indicates there are restrictions associated with the current profile.", "type": "boolean" }, - "lunchIncluded": { - "description": "Represents if the meal plan code is available for lunch or not.", - "type": "boolean" - } - } - }, - "mealPlansType": { - "description": "Meal plan codes associated with the rate codes.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/mealPlanCodeType" - } - }, - "meetingRoomType": { - "description": "Information about the meeting rooms of the hotel.", - "type": "object", - "properties": { - "charge": { - "description": "The charge for the meeting room.", + "registrationCardNo": { + "description": "Unique identifier of the police registration card number.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "code": { - "description": "the code of the meeting room", + "nameType": { + "$ref": "#/definitions/nameTypeType" + }, + "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", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "description": { - "description": "A description of the meeting room.", + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 40 } } }, - "meetingRoomsType": { - "description": "List of meeting rooms of the hotel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/meetingRoomType" - } - }, - "membershipEarningPreferenceType": { - "description": "The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.", - "type": "string", - "enum": [ - "Points", - "Miles" - ] - }, "membershipInfoType": { - "description": "The Membership object identifies the frequent customer reward program.", "type": "object", + "description": "The Membership object identifies the frequent customer reward program.", "properties": { - "accountId": { - "description": "The account identification number for this particular member in this particular program.", - "type": "string", - "maxLength": 50, - "minLength": 0 - }, - "bonusCode": { - "description": "The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, "membershipId": { "description": "Membership ID (Unique ID from the memberships table).", "type": "number" }, - "membershipLevel": { - "description": "The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.", + "programCode": { + "description": "The code or name of the membership program ('Hertz', 'AAdvantage', etc.).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "membershipLevelDesc": { - "description": "The description of the Bonus Code.(Platinum for code P)", + "bonusCode": { + "description": "The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "membershipTypeDesc": { "description": "The description of the ProgramCode.(Delta Previlige for code DP)", "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "playerRanking": { - "description": "Ranking assigned to the Player Profile by the Gaming system.", - "type": "integer" + "minLength": 0, + "maxLength": 2000 }, - "programCode": { - "description": "The code or name of the membership program ('Hertz', 'AAdvantage', etc.).", + "membershipLevelDesc": { + "description": "The description of the Bonus Code.(Platinum for code P)", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "membershipSearchType": { - "description": "Identifies criteria for searching frequent customer reward program.", - "type": "object", - "properties": { - "associatedReservationsOnly": { - "description": "If this is true,the reservations which has membership information associated will be resulted .", - "type": "boolean" + "minLength": 0, + "maxLength": 2000 }, - "membershipId": { - "description": "Membership ID criteria.", - "type": "string" + "accountId": { + "description": "The account identification number for this particular member in this particular program.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, "membershipLevel": { - "description": "Membership Level criteria.", - "$ref": "#/definitions/codeListType" + "description": "The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "membershipType": { - "description": "Membership Type criteria.", - "$ref": "#/definitions/codeListType" + "playerRanking": { + "description": "Ranking assigned to the Player Profile by the Gaming system.", + "type": "integer" } } }, "namePrefixType": { + "type": "string", "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)", + "minLength": 0, + "maxLength": 40 + }, + "givenNameType": { "type": "string", - "maxLength": 40, - "minLength": 0 + "description": "Given name, first name or names", + "minLength": 0, + "maxLength": 40 }, - "nameTypeType": { + "surnameType": { "type": "string", - "enum": [ - "Guest", - "Company", - "Agent", - "Contact", - "Source", - "Group", - "Employee", - "Hotel", - "Purge" - ] + "description": "Family name, last name.", + "minLength": 0, + "maxLength": 40 }, - "negotiatedInfoType": { - "description": "This provides information for a profile negotiated rate.", - "type": "object", - "properties": { - "comissionCode": { - "description": "Informational purposes only in numeric format.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "corporateAgreementId": { - "description": "The master identifier for multiple offices/locations under the same company profile. This is optional", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "end": { - "description": "The ending value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "inactive": { - "description": "Negotiated Rate is inactive or not", - "type": "boolean" - }, - "order": { - "description": "The sell order.", - "type": "integer" - }, - "start": { - "description": "The starting value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 - } - } + "phoneNumberType": { + "type": "string", + "description": "Phone number", + "minLength": 0, + "maxLength": 40 }, - "negotiatedType": { - "description": "This holds a list of NegotiatedInfoType.", + "vIPType": { "type": "object", + "description": "The supplier's ranking of the customer.", "properties": { - "hotelId": { - "description": "Hotel code for the negotiated rate.", + "vipCode": { + "description": "VIP Code.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "negotiatedInfoList": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/negotiatedInfoType" - } + "minLength": 0, + "maxLength": 20 }, - "rateCode": { - "description": "Rate plan code for the negotiated rate.", + "vipDescription": { + "description": "VIP Description.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 } } }, - "noteTypeType": { - "description": "Note Types Information Type.", + "addressSearchType": { "type": "object", + "description": "Address Details such as city, state, country, postal code etc.", "properties": { - "code": { - "description": "Code of the Note Types.", + "cityName": { + "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "defaultNoteText": { - "description": "Default Note Text if Note Type has default note.", + "postalCode": { + "description": "Post Office Code number.", "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "defaultNoteType": { - "description": "Indicates if the Note Types Code is default.", - "type": "boolean" - }, - "defaultText": { - "description": "Indicates if the Note Types Code has at least one default text defined.", - "type": "boolean" - }, - "departmentNotes": { - "description": "Indicates if the Note Types Code has department notes.", - "type": "boolean" - }, - "departments": { - "description": "Departments that can see Department Notes of the Note Types Code.", - "$ref": "#/definitions/genericHotelCodeCodeListType" + "minLength": 0, + "maxLength": 15 }, - "description": { - "description": "Description of the Note Types Code.", + "state": { + "description": "State or Province name (e.g., Texas).", "type": "string", - "maxLength": 100, - "minLength": 0 - }, - "displaySequence": { - "description": "Display Sequence.", - "type": "number" - }, - "globalAllowed": { - "description": "Indicates if the Note Types Code is globally allowed.", - "type": "boolean" - }, - "inactive": { - "description": "Indicates if the Note Types Code is inactive.", - "type": "boolean" + "minLength": 0, + "maxLength": 20 }, - "internal": { - "description": "Indicates if the Note Types Code is internal.", - "type": "boolean" + "country": { + "description": "Country name (e.g., Ireland).", + "$ref": "#/definitions/countryNameType" }, - "noteGroup": { - "description": "Notes Group of the Note Types code.", + "streetAddress": { + "description": "First Line of Street Address. For profile search it matches the first Address line.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "notificationAreas": { - "description": "Display Sequence.", - "$ref": "#/definitions/codeListType" + "minLength": 0, + "maxLength": 80 }, - "overrideInternal": { - "description": "Indicates if the Note Types Code is override internal.", + "excludeNoCity": { + "description": "When true indicates that only profiles with city will be fetched.", "type": "boolean" - }, - "propertyDefaultNoteTexts": { - "description": "Collection of multiple Default Note Text for different Properties/Global for specific Note Type/Node Code.", - "$ref": "#/definitions/defaultNoteTextsDetailType" } } }, - "noteTypesCriteria": { - "description": "Request object for creating new Note Types.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "noteTypes": { - "description": "Note Types to be created.", - "$ref": "#/definitions/noteTypesType" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "resAccompanyGuestListType": { + "type": "array", + "description": "Collection of accompany guests", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resAccompanyGuestInfoType" } }, - "noteTypesDetails": { - "description": "Response object for fetching Note Types of specific Notes Group.", + "resAccompanyGuestInfoType": { "type": "object", "properties": { - "links": { - "$ref": "#/definitions/links" + "firstName": { + "description": "Given name, first name or names", + "type": "string" }, - "noteTypes": { - "description": "Collection of Note Types.", - "$ref": "#/definitions/noteTypesType" + "lastName": { + "description": "Family name, last name.", + "type": "string" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "fullName": { + "description": "String representation of the full name", + "type": "string" + }, + "registrationCardNo": { + "description": "Unique identifier of the police registration card number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", + "$ref": "#/definitions/profileIdList" } } }, - "noteTypesToBeChanged": { - "description": "Request object for changing existing Note Types.", + "resGuestExternalInfoType": { "type": "object", + "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "noteTypes": { - "description": "Note Types to be changed.", - "$ref": "#/definitions/noteTypesType" + "givenName": { + "description": "Given name, first name or names", + "$ref": "#/definitions/givenNameType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "surname": { + "description": "Family name, last name.", + "$ref": "#/definitions/surnameType" } } }, - "noteTypesType": { - "description": "Note Types Collection element.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/noteTypeType" - } - }, - "numericUDFType": { - "description": "Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", + "guestLastStayInfoType": { "type": "object", + "description": "Contains last stay related details of the guest.", "properties": { - "alternateName": { - "description": "Label of user defined field used by vendors or customers.", + "lastStayDate": { + "description": "Guest's last stay date.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "name": { - "description": "Name of user defined field.", + "lastStayRoom": { + "description": "Room Number where the guest stayed.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "value": { - "description": "Value of user defined field.", - "type": "number" + "lastStayRate": { + "description": "The Rate amount of the guest's last stay.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalStay": { + "description": "The total number of previous stay of the guest.", + "type": "integer" } } }, - "numericUDFsType": { - "description": "Used to hold collection of user defined fields of Numeric Type.", + "nameTypeType": { + "type": "string", + "enum": [ + "Guest", + "Company", + "Agent", + "Contact", + "Source", + "Group", + "Employee", + "Hotel", + "Purge" + ] + }, + "resSharedGuestListType": { "type": "array", + "description": "Collection of shared guest reservations.", "maxItems": 4000, "items": { - "$ref": "#/definitions/numericUDFType" + "$ref": "#/definitions/resSharedGuestInfoType" } }, - "operaHotelContextDetails": { - "description": "The result element returned with general hotel contextual information.", + "resSharedGuestInfoType": { "type": "object", + "description": "Contains information regarding the share reservation.", "properties": { - "hotelContext": { - "description": "A record containing hotel contextual information, stored as attributes.", - "type": "object", - "properties": { - "businessDate": { - "description": "The hotel's business date.", - "type": "string", - "format": "date" - }, - "cateringCurrencyCode": { - "description": "Catering Currency Code, used when Catering Currency differs from base currency.", - "type": "string", - "maxLength": 3, - "minLength": 3 - }, - "chainCode": { - "description": "The hotel's chain code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "checkInTime": { - "description": "The hotel's check-in time.", - "type": "string", - "format": "date" - }, - "checkOutTime": { - "description": "The hotel's check-out time.", - "type": "string", - "format": "date" - }, - "configurationMode": { - "description": "The hotel's configuration mode if applicable.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "countryMode": { - "description": "The hotel's country code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencyCode": { - "description": "Provides the hotel's currency code.", - "type": "string", - "maxLength": 3, - "minLength": 3 - }, - "hotelId": { - "description": "The hotel code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "hotelName": { - "description": "The hotel name.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "languageCode": { - "description": "The hotel's language code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "loginUserId": { - "description": "The login user.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "timezone": { - "description": "The hotel's timezone.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } + "profileId": { + "$ref": "#/definitions/profileId" }, - "links": { - "$ref": "#/definitions/links" + "firstName": { + "description": "Given name, first name or names", + "type": "string" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "lastName": { + "description": "Family name, last name.", + "type": "string" + }, + "fullName": { + "description": "String representation of the full name", + "type": "string" } } }, - "operaParametersDetails": { - "description": "The result element containing a collection of the requested application parameters.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "parameters": { - "description": "Represents a single application parameter and its value.", - "type": "array", - "items": { - "$ref": "#/definitions/applicationSettingSimpleType" - } - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "resAttachedProfileListType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resAttachedProfileType" } }, - "operaSettingsDetails": { - "description": "The result element containing the requested application settings.", + "resAttachedProfileType": { "type": "object", "properties": { - "activeFunctions": { - "description": "Count of active property services functions.", - "type": "integer" - }, - "groups": { - "description": "Contains a collection of application settings for a particular group.", - "type": "array", - "items": { - "$ref": "#/definitions/applicationSettingGroupType" - } + "name": { + "description": "Attached profile name", + "type": "string" }, - "links": { - "$ref": "#/definitions/links" + "profileIdList": { + "description": "Collection of unique profile identifiers", + "$ref": "#/definitions/profileIdList" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "reservationProfileType": { + "$ref": "#/definitions/resProfileTypeType" } } }, - "operaVersionNumberType": { - "description": "Current Opera Version Number", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "ownerResTypeType": { + "resProfileTypeType": { "type": "string", "enum": [ - "Owner", - "AuthorizedUser" + "Guest", + "Company", + "Group", + "TravelAgent", + "Source", + "ReservationContact", + "BillingContact", + "Addressee" ] }, - "ownerType": { - "description": "Generic type for information about an owner.", + "reservationPaymentMethodType": { "type": "object", "properties": { - "department": { - "description": "Department to which the owner belongs to.", - "$ref": "#/definitions/codeDescriptionType" + "paymentCard": { + "$ref": "#/definitions/resPaymentCardType" }, - "email": { - "description": "Email information of the owner.", - "$ref": "#/definitions/emailInfoType" + "balance": { + "$ref": "#/definitions/currencyAmountType" }, - "hotel": { - "description": "Hotel to which the owner belongs to.", - "$ref": "#/definitions/codeDescriptionType" + "authorizationRule": { + "$ref": "#/definitions/authorizationRuleType" }, - "name": { - "description": "Provides name information of the owner.", - "$ref": "#/definitions/personNameType" + "emailFolioInfo": { + "description": "Information on an email for the customer.", + "type": "object", + "properties": { + "email": { + "description": "eMail deatils for the profile.", + "$ref": "#/definitions/emailType" + }, + "emailFolio": { + "type": "boolean" + }, + "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 + } + } }, - "ownerCode": { - "description": "Unique Code to identify the owner.", + "paymentMethod": { "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "phone": { - "description": "Information on the telephone number of the owner.", - "$ref": "#/definitions/telephoneInfoType" - }, - "primary": { - "description": "When true, this is a primary owner.", - "type": "boolean" - }, - "profileId": { - "description": "Unique owner profile information.", - "$ref": "#/definitions/profileId" - }, - "relationship": { - "description": "Relationship of the owner within the profile or block.", - "$ref": "#/definitions/codeDescriptionType" - }, - "userId": { - "description": "Unique application user ID.", - "$ref": "#/definitions/uniqueID_Type" + "minLength": 0, + "maxLength": 20 }, - "userName": { - "description": "Unique application user name of the owner.", + "description": { "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 + }, + "folioView": { + "type": "integer" } } }, - "pMS_ResStatusType": { - "description": "This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.", - "type": "string", - "enum": [ - "Reserved", - "Requested", - "NoShow", - "Cancelled", - "InHouse", - "CheckedOut", - "Waitlisted", - "DueIn", - "DueOut", - "Walkin", - "PendingCheckout" - ] - }, - "packageElementType": { + "resPaymentCardType": { "type": "object", + "description": "Information on a credit card for the customer.", "properties": { - "addRateCombinedLine": { - "type": "boolean" - }, - "addRateSeprateLine": { - "type": "boolean" + "cardId": { + "description": "credit card id", + "$ref": "#/definitions/uniqueID_Type" }, - "allowance": { + "currentAuthorizedAmount": { "$ref": "#/definitions/currencyAmountType" }, - "amount": { + "approvalAmountNeeded": { "$ref": "#/definitions/currencyAmountType" }, - "calculationRule": { - "type": "string" + "cardType": { + "description": "Indicates the type of credit card from a defined list", + "$ref": "#/definitions/cardTypeType" }, - "description": { - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - } + "userDefinedCardType": { + "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided", + "type": "string", + "minLength": 0, + "maxLength": 2 }, - "endDate": { + "cardNumber": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "cardNumberMasked": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "cardNumberLast4Digits": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "expirationDate": { + "description": "Expiration date of the credit card", "type": "string", "format": "date", "maxLength": 8 }, - "endTime": { - "type": "string" + "expirationDateMasked": { + "description": "Masked Expiration date of the credit card", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "includedInRate": { + "expirationDateExpired": { "type": "boolean" }, - "packageCode": { - "type": "string" + "cardHolderName": { + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "postingRhythm": { - "type": "string" + "attachCreditCardToProfile": { + "description": "Attach the credit card to profile.", + "type": "boolean" }, - "quantity": { - "type": "integer" + "processing": { + "description": "This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.", + "$ref": "#/definitions/cardProcessingType" }, - "sellSeparate": { + "swiped": { "type": "boolean" }, - "startDate": { - "type": "string", - "format": "date", - "maxLength": 8 + "cardPresent": { + "description": "Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.", + "type": "boolean" }, - "startTime": { - "type": "string" + "cardOrToken": { + "description": "This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.", + "$ref": "#/definitions/cardNumberTypeType" + }, + "citId": { + "description": "Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.", + "type": "string", + "minLength": 0, + "maxLength": 30 } } }, - "paragraphType": { - "description": "An indication of a new paragraph for a sub-section of a formatted text message.", + "cardTypeType": { + "type": "string", + "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.", + "enum": [ + "Ab", + "Am", + "Ax", + "Cb", + "Dc", + "Ds", + "Dt", + "Ec", + "Er", + "Jc", + "Jl", + "Mc", + "Nb", + "So", + "St", + "Sw", + "Va", + "Xy", + "Zz", + "Cp", + "Cu" + ] + }, + "cardProcessingType": { + "type": "string", + "enum": [ + "Eft", + "Manual" + ] + }, + "cardNumberTypeType": { + "type": "string", + "description": "Simple type for indicating if credit card number is tokenized.", + "enum": [ + "CardNumber", + "Token" + ] + }, + "authorizationRuleType": { "type": "object", + "description": "Configured rule for computing the amount to authorize.", "properties": { - "image": { - "description": "An image for this paragraph.", - "type": "string" + "code": { + "description": "The authorization rule code.", + "type": "integer", + "pattern": "[0-9]{1,9}" }, - "text": { - "description": "Formatted text content.", - "$ref": "#/definitions/formattedTextTextType" + "amount": { + "description": "The amount applicable to the authorization rule.", + "$ref": "#/definitions/currencyAmountType" }, - "url": { - "description": "A URL for this paragraph.", - "type": "string" + "percent": { + "description": "A percentage value if the authorization rule is percentage based.", + "type": "number" } } }, - "payeeInfoType": { - "description": "Payee information.", + "reservationFolioWindowsType": { + "type": "array", + "description": "Collection of reservation folio windows.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationFolioWindowType" + } + }, + "reservationFolioWindowType": { "type": "object", + "description": "Folio window view which holds the set of folios for a reservation.", "properties": { - "payeeAccountInfo": { - "description": "AR account short info of the payee.", - "$ref": "#/definitions/aRAccountShortInfoType" + "payeeInfo": { + "description": "The window's configured payee information.", + "$ref": "#/definitions/payeeInfoType" }, - "payeeAddress": { - "description": "Address of the payee.", - "$ref": "#/definitions/addressInfoType" + "balance": { + "description": "Running balance of the window.", + "$ref": "#/definitions/currencyAmountType" }, - "payeeAddressCount": { - "description": "Payee multiple address count.", - "type": "integer" + "paymentMethod": { + "description": "Payment Method Type", + "type": "string", + "minLength": 0, + "maxLength": 20 }, + "folioWindowNo": { + "type": "integer" + } + } + }, + "payeeInfoType": { + "type": "object", + "description": "Payee information.", + "properties": { "payeeId": { "description": "Opera name id of the payee.", "$ref": "#/definitions/uniqueID_Type" @@ -47072,999 +41366,1075 @@ "payeeName": { "description": "Name of the payee.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 80 + }, + "payeeAddress": { + "description": "Address of the payee.", + "$ref": "#/definitions/addressInfoType" + }, + "payeeAddressCount": { + "description": "Payee multiple address count.", + "type": "integer" }, "payeeReferenceCurrency": { "description": "Reference currency of the payee.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "payeeAccountInfo": { + "description": "AR account short info of the payee.", + "$ref": "#/definitions/aRAccountShortInfoType" }, "payeeTaxNumber": { "description": "The tax number of the payee.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 } } }, - "personNameType": { - "description": "This provides name information for a person.", + "aRAccountShortInfoType": { "type": "object", + "description": "Accounts Receivabales Account details type charged for batched posting.", "properties": { - "envelopeGreeting": { - "description": "Envelope Greeting of the profile", - "type": "string" - }, - "externalSystem": { - "description": "When name type is external, indicates the external system the name belongs to.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "givenName": { - "description": "Given name, first name or names.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "language": { - "description": "Language identification.", + "accountName": { + "description": "Name of the AR Account.", "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "minLength": 0, + "maxLength": 200 }, - "middleName": { - "description": "The middle name of the person name.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "accountId": { + "description": "The unique ID for the Account.", + "$ref": "#/definitions/uniqueID_Type" }, - "namePrefix": { - "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", + "accountNo": { + "description": "The Account Number for the Account.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "nameSuffix": { - "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", + "status": { + "description": "The status of the account.", + "$ref": "#/definitions/aRAccountStatusType" + } + } + }, + "aRAccountStatusType": { + "type": "object", + "description": "Type for the Account Status. Status can be restricted and a message/description added to the Account.", + "properties": { + "restriction": { + "description": "The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "nameTitle": { - "description": "Degree or honors (e.g., Ph.D., M.D.)", + "description": { + "description": "User defined status message on the Account.", "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "nameTitleSuffix": { - "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on.", - "type": "integer" - }, - "nameType": { - "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", - "$ref": "#/definitions/personNameTypeType" - }, - "salutation": { - "description": "Salutation of the profile", - "type": "string" + "minLength": 0, + "maxLength": 2000 }, - "surname": { - "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "restricted": { + "description": "Flag to indicate if the Account is restricted.", + "type": "boolean" } } }, - "personNameTypeType": { - "description": "Person's name in an external system.", + "housekeepingRoomStatusType": { "type": "string", + "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", "enum": [ - "Primary", - "Alternate", - "Incognito", - "External", - "Phonetic" + "Clean", + "Dirty", + "Pickup", + "Inspected", + "OutOfOrder", + "OutOfService" ] }, - "phoneNumberType": { - "description": "Phone number", - "type": "string", - "maxLength": 40, - "minLength": 0 + "searchMatchesType": { + "type": "array", + "description": "List of Generic Name-Value-Pair Parameters used for super search matches.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/searchMatchType" + } }, - "pointsType": { - "description": "The Redeem Points contains the number of points required to book a room type.", + "searchMatchType": { "type": "object", + "description": "Search match indicating attribute and the matching value.", "properties": { - "awardsType": { - "description": "Awards type for the award type rate code.", - "type": "string" + "attribute": { + "description": "Search match attribute.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "points": { - "description": "No of points required to book this Room Stay.", - "type": "integer" + "value": { + "description": "Search match value.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "preferenceType": { - "description": "Guest Preference details for the profile.", + "sourceOfSaleType": { "type": "object", + "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", "properties": { - "description": { - "description": "Preference Description for display purposes.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "excludedPreferencesCount": { - "description": "Specifies the count of preferences excluded for the attached reservation preference.", - "type": "integer" - }, - "global": { - "description": "Whether this preference is property specific or not.", - "type": "boolean" - }, - "hotels": { - "description": "If specified preference belongs to the Hotels listed, otherwise it is a global preference.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 - } - }, - "preferenceId": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "preferenceValue": { - "description": "Preference value for display purposes.", + "sourceType": { + "description": "Type of entity/channel who made the reservation..", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "source": { - "description": "Source of the preference.", + "sourceCode": { + "description": "The entity/channel who made the reservation.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "preferenceTypeType": { - "description": "Preference details for the profile.", + "waitlistResType": { "type": "object", + "description": "Information regarding why reservation is being /has been waitlisted.", "properties": { - "availableQuantity": { - "description": "Available quantity of preferences (maximum quantity - Existing preferences)per preference group.", - "type": "integer" - }, - "createDateTime": { - "description": "Time stamp of the creation.", + "reasonDescription": { + "description": "Waitlist Reason Description.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 2000 }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "priorityDescription": { + "description": "Waitlist priority Description.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "description": { + "description": "Description why the reservation is being /has been waitlisted.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", + "reasonCode": { + "description": "Waitlist Reason Code.", "type": "string", - "format": "date-time" - }, - "maxQuantity": { - "description": "Maximum quantity of preferences allowed per preference group.", - "type": "integer" + "minLength": 0, + "maxLength": 20 }, - "maxResortUsedQuantity": { - "description": "Maximum quantity of preferences used by any resort per preference group.", - "type": "integer" + "priorityCode": { + "description": "Waitlist Priority Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "preference": { - "description": "Collection of Preferences for the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/preferenceType" + "telephone": { + "description": "Guest telephone number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "reservationQueueInformationType": { + "type": "object", + "description": "Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.", + "properties": { + "timeSpan": { + "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.", + "type": "object", + "properties": { + "startDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "duration": { + "type": "string" + }, + "durationInSeconds": { + "description": "The total duration, in seconds, the reservation is on Queue.", + "type": "integer" + } } }, - "preferenceType": { - "description": "Preference group code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "guestTextInfo": { + "description": "Information for the message sent to the user", + "$ref": "#/definitions/queueTextInfoType" }, - "preferenceTypeDescription": { - "description": "Preference group description.", - "type": "string" + "priority": { + "description": "The Queue Priority given to this reservation.", + "type": "integer" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "averageQueueTimeToCheckIn": { + "description": "The average time, in seconds, a reservation was on queue prior to Check-In.", + "type": "integer" + }, + "averageQueueTimeCurrentReservations": { + "description": "The average time, in seconds, of the reservations currently in queue.", + "type": "integer" + }, + "queueDate": { + "description": "The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.", "type": "string", "format": "date", "maxLength": 8 - }, - "reservationPreference": { - "description": "Whether this preference is reservation preference or not.", - "type": "boolean" - }, - "sequence": { - "description": "Preference Sequence.", - "type": "string" } } }, - "primaryCodeType": { - "description": "Primary flag with code and description.", + "queueTextInfoType": { "type": "object", + "description": "Information regarding the message sent to guest.", "properties": { - "codeDescription": { - "$ref": "#/definitions/codeDescriptionType" + "sentTime": { + "description": "Time the text was last sent to the user.", + "type": "string", + "format": "date-time" }, - "primary": { - "type": "boolean" + "sentBy": { + "description": "User name of the user who sent message.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "primaryCodesType": { - "description": "List of codes with primary flag", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/primaryCodeType" - } - }, - "primaryShareTypeType": { - "type": "string", - "enum": [ - "Primary", - "NonPrimary" - ] - }, - "privacyInfoType": { - "description": "Defines Privacy related information for the profile.", + "resHousekeepingType": { "type": "object", + "description": "Holds housekeeping turndown service information for the room.", "properties": { - "allowEmail": { - "description": "Indicates if the profile wishes to allow Email.", - "type": "boolean" - }, - "allowPhone": { - "description": "Indicates if the profile wishes to allow phone calls.", - "type": "boolean" + "instructions": { + "description": "Turndown instructions for the room.", + "type": "string" }, - "allowSMS": { - "description": "Indicates if the profile wishes to allow SMS.", - "type": "boolean" + "facilityTaskInfo": { + "description": "The facility task applicable for the current day. This will be information only and not used for any updates.", + "$ref": "#/definitions/facilityTaskType" }, - "autoEnrollLoyaltyProgram": { - "description": "Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.", + "linenChange": { + "description": "Indicates if a linen change is necessary.", "type": "boolean" }, - "infoFromThirdParty": { - "description": "Indicates if the profile is ok getting info from third parties.", + "turndownRequested": { + "description": "Indicates whether guest wants turndown facility or not.", "type": "boolean" }, - "lastPrivacyPromptDate": { - "description": "Indicate the last privacy prompt date of the guest.", + "serviceTime": { + "description": "This is the Turndown room service time.", "type": "string", "format": "date", "maxLength": 8 }, - "marketResearchParticipation": { - "description": "Indicates if the profile participates in market research.", - "type": "boolean" + "expectedServiceTime": { + "description": "Expected Start Time for housekeeping task(s).", + "type": "string" }, - "optInAutoEnrollmentMember": { - "description": "Indicates if the profile wishes to opt in for Auto Enrolment Member.", - "type": "boolean" + "roomStatus": { + "description": "Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.", + "$ref": "#/definitions/housekeepingRoomStatusType" + } + } + }, + "facilityTaskType": { + "type": "object", + "description": "Information regarding facility task on a reservation.", + "properties": { + "task": { + "description": "The Task Code.", + "$ref": "#/definitions/housekeepingTaskCodeType" }, - "optInEmail": { - "description": "Indicates if the profile wishes to opt in for Email.", - "type": "boolean" + "supplies": { + "description": "Supplies associated with the task.", + "$ref": "#/definitions/facilityCodesType" }, - "optInMailingList": { - "description": "Indicates if the profile wishes to opt in for Mailing List.", - "type": "boolean" + "date": { + "description": "The Date on which the task is applicable.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "housekeepingTaskCodeType": { + "type": "object", + "description": "Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.", + "properties": { + "description": { + "description": "Description of the Task Code.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "optInMarketResearch": { - "description": "Indicates if the profile wishes to opt in for Market Research.", - "type": "boolean" + "instructions": { + "description": "Instructions for this Task Code.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "optInPhone": { - "description": "Indicates if the profile wishes to opt in for Phone.", + "facilityDepartureTask": { + "description": "Indicates if this task code is the default departure task for Facility Tasks. This requires", "type": "boolean" }, - "optInSms": { - "description": "Indicates if the profile wishes to opt in for SMS.", + "linenChange": { + "description": "Indicates if a linen change is necessary.", "type": "boolean" }, - "optInThirdParty": { - "description": "Indicates if the profile wishes to opt in for Third Party.", - "type": "boolean" + "hotelId": { + "description": "Property where this task code is configured.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "code": { + "description": "The Code for the task.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sequence": { + "description": "Ordering sequence for display.", + "type": "integer" } } }, - "profileAccessType": { + "facilityCodesType": { + "type": "array", + "description": "List of the facility codes.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/facilityCodeType" + } + }, + "facilityCodeType": { "type": "object", + "description": "Facility Housekeeping Code, its description and quantity.", "properties": { - "chainCode": { - "description": "Indicates the Chain code where the profile was created", + "description": { + "description": "Facility Code.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "croCode": { - "description": "Indicates the CRO code where the profile was created", - "type": "string", - "maxLength": 200, - "minLength": 0 + "quantity": { + "description": "Signifies the quantity.", + "type": "integer" }, - "hotelId": { - "description": "Indicates the Hotel code where the profile was created", + "code": { + "description": "Facility code value.", "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "sharedLevel": { - "description": "Indicates whether the profile is shared at the following levels : global/property/CRO", - "$ref": "#/definitions/profileSharedLevelType" + "minLength": 0, + "maxLength": 20 } } }, - "profileCashieringType": { - "description": "Contains cashiering related details for the profile", + "resCashieringType": { "type": "object", + "description": "Cashiering Information for the reservation.", "properties": { - "arNoCentral": { - "description": "Account Receivables Central Number.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "revenuesAndBalances": { + "description": "Revenues and Balances Amount summary for the reservation.", + "$ref": "#/definitions/resRevenueBalanceType" }, - "autoFolioSettlementType": { - "description": "Contains the auto folio settlement type for the profile.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "billingPrivileges": { + "description": "Billing privileges set on the reservation.", + "$ref": "#/definitions/billingPrivilegesType" }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "taxType": { + "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", + "$ref": "#/definitions/reservationTaxTypeInfo" }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", - "type": "string", - "maxLength": 10, - "minLength": 0 + "bedTaxReporting": { + "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", + "$ref": "#/definitions/bedTaxReportingType" }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", - "type": "integer" + "folioTexts": { + "description": "Additional text fields to display on the folio.", + "$ref": "#/definitions/folioTextsType" }, - "directBillingList": { - "description": "Contains the direct billing related information for the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/directBillingType" - } + "periodicFolio": { + "description": "Information regarding periodic folios set on the reservation.", + "$ref": "#/definitions/resPeriodicFolioType" }, - "paymentDueDays": { - "description": "Ability to define on the account, the number of days after which the invoice should be paid.", - "type": "integer" + "compAccounting": { + "description": "Information regarding comp accounting on the reservation.", + "$ref": "#/definitions/resCompAccountingType" }, - "referenceCurrency": { - "description": "Reference Currency.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "reservationPreConfiguredRoutingInstruction": { + "description": "Information regarding the selected preconfigured routing instruction on the reservation.", + "$ref": "#/definitions/resPreConfiguredRoutingInstrType" }, - "taxPercent1": { - "description": "Tax1 Percentage for Collecting Agent.", - "type": "integer" + "financiallyResponsible": { + "description": "The guest from whom payment has to be recovered (direct guest).", + "type": "boolean" }, - "taxPercent2": { - "description": "Tax2 Percentage for Collecting Agent.", - "type": "integer" + "proratedBilling": { + "description": "In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.", + "type": "boolean" }, - "taxPercent3": { - "description": "Tax3 Percentage for Collecting Agent.", - "type": "integer" + "lastRoomAndTaxPostedDate": { + "description": "Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "taxPercent4": { - "description": "Tax4 Percentage for Collecting Agent.", - "type": "integer" + "reverseCheckInAllowed": { + "description": "This attribute is to verify if reverse check-in is allowed for the reservation.", + "type": "boolean" }, - "taxPercent5": { - "description": "Tax5 Percentage for Collecting Agent.", - "type": "integer" + "reverseAdvanceCheckInAllowed": { + "description": "This attribute is to verify if reverse advance check-in is allowed for the reservation.", + "type": "boolean" }, - "vATOffsetYN": { - "description": "VAT Offset Flag.", - "type": "string", - "maxLength": 1, - "minLength": 0 + "transactionsPosted": { + "description": "Specifies whether reservation has a financial transaction associated with it.", + "type": "boolean" } } }, - "profileCommissionType": { - "description": "This is the preconfigured routing instruction type.", + "resRevenueBalanceType": { "type": "object", + "description": "Revenue and Balance Amount summary for the reservation.", "properties": { - "bankAccount": { - "description": "Bank account used for the commission for a profile.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "totalFixedCharge": { + "description": "Total Fixed Charges on the reservation.", + "$ref": "#/definitions/currencyAmountType" }, - "commissionCode": { - "description": "commission Code for a profile.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "totalPayment": { + "description": "Total payment received for the reservation.", + "$ref": "#/definitions/currencyAmountType" }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "roomRevenue": { + "description": "Room Revenue generated by the reservation.", + "$ref": "#/definitions/currencyAmountType" }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", - "type": "string", - "maxLength": 10, - "minLength": 0 + "foodAndBevRevenue": { + "description": "Food and Beverage Revenue generated by the reservation.", + "$ref": "#/definitions/currencyAmountType" }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", - "type": "integer" + "otherRevenue": { + "description": "Other Revenue generated by the reservation.", + "$ref": "#/definitions/currencyAmountType" }, - "hotelId": { - "description": "Hotel Code for the commission being used for a profile.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "nonRevenue": { + "description": "Total Non Revenue posted on the reservation.", + "$ref": "#/definitions/currencyAmountType" }, - "paymentMethod": { - "description": "Type of payment associated with the bank account.", - "$ref": "#/definitions/commissionPaymentMethods" + "totalRevenue": { + "description": "Total Revenue generated by the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "balance": { + "description": "Balance amount on the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "compBalance": { + "description": "Comp Balance amount", + "$ref": "#/definitions/currencyAmountType" } } }, - "profileDeliveryMethod": { - "description": "Delivery Information type to the profile.", + "billingPrivilegesType": { "type": "object", + "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", "properties": { - "deliveryId": { - "description": "Delivery ID. It will be empty in case of new delivery method.", - "$ref": "#/definitions/uniqueID_Type" + "postingRestriction": { + "description": "Flag used by interface program during check in.", + "type": "boolean" }, - "deliveryModule": { - "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..", - "$ref": "#/definitions/profileDeliveryModuleType" + "preStayCharging": { + "description": "Indicates if the reservation has charging privileges before arrival.", + "type": "boolean" }, - "deliveryType": { - "description": "Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.", + "postStayCharging": { + "description": "Indicates if the reservation has charging privileges after checkout.", + "type": "boolean" + }, + "folioCloseDate": { + "description": "Date when folio was closed. This works with PostStayCharging flag.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "deliveryValue": { - "description": "Delivery value holds the corresponding value of the delivery type..", + "scheduledCheckout": { + "description": "Indicates if the guest is scheduled for automatic check out.", + "type": "boolean" + }, + "scheduledCheckoutTime": { + "description": "Time of automatic check out if guest is schedule for automatic check out.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "hotelId": { - "description": "Property that has delivery methods configured.", + "directBillAuthorized": { + "description": "If Direct bill is authorized this will hold User ID who authorized it.", + "type": "boolean" + }, + "videoCheckout": { + "description": "Indicates if the guest can do video checkout", + "type": "boolean" + }, + "allowAutoCheckin": { + "description": "Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.", + "type": "boolean" + }, + "autoSettlement": { + "description": "Indicates if the is a candidate for auto folio settlement.", + "type": "boolean" + }, + "autoSettlementType": { + "description": "The folio settlement type for auto folio settlement.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "autoSettlementFreq": { + "description": "The interval of days between each auto folio settlement.", + "type": "integer" }, - "primaryInd": { - "description": "When true, indicates a primary information.", + "creditLimitAutoPay": { + "description": "Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.", "type": "boolean" } } }, - "profileDeliveryModuleType": { - "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..", - "type": "string", - "enum": [ - "EfolioExport" - ] - }, - "profileId": { - "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).", + "reservationTaxTypeInfo": { "type": "object", + "description": "Provides information about the Tax Type.", "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.", + "hotelId": { + "description": "Code of the Hotel.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "idContext": { - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "code": { + "description": "Code of the Tax Type.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "idExtension": { - "description": "Additional identifying value assigned by the creating system.", + "description": { + "description": "Description of the Tax Type.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "collectingAgentTax": { + "description": "A boolean flag for Collecting Agent Tax", + "type": "boolean" + }, + "printAutoAdjust": { + "description": "Print auto adjust information for this tax type on the tax exempt report.", + "type": "boolean" + }, + "reportExemptDays": { + "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.", "type": "integer" }, - "instance": { - "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "reportTaxPercentage": { + "description": "Tax percentage. Only used for tax exempt report.", + "type": "number", + "minimum": 0, + "maximum": 100 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "minimumLengthOfStay": { + "description": "Minimun Length of Stay.", + "type": "integer" }, - "url": { - "description": "URL that identifies the location associated with the record identified by the UniqueID.", - "type": "string" + "taxExemptNo": { + "description": "Tax exempt number on the profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "profileIdList": { - "description": "Unique Id that references an object uniquely in the system.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/uniqueID_Type" - } - }, - "profileMembershipType": { - "description": "Detailed information of the memberships.", + "bedTaxReportingType": { "type": "object", + "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", "properties": { - "benefits": { - "description": "benefits for the membership.", - "$ref": "#/definitions/benefitsType" - }, - "centralSetup": { - "description": "Indicates how the award points for this membership type will be managed.", - "type": "boolean" - }, - "comment": { - "description": "Additional comments regarding to the membership.", - "$ref": "#/definitions/paragraphType" - }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "currentPoints": { - "description": "Profile MemberShip Points.", + "taxRegistrationNo": { + "description": "Tax Registration Number for Maldives Bed Tax Reporting.", "type": "number" }, - "downgrade": { - "description": "Defines how downgrading will be handled for this membership.", - "$ref": "#/definitions/downgradeType" - }, - "downgradeDescription": { - "description": "Indicates information regarding the member's possible downgrades.", + "visaNumber": { + "description": "Visa number used for Maldives Bed Tax Reporting", "type": "string", - "maxLength": 32000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "earningPreference": { - "description": "Earning preference to the membership.", - "$ref": "#/definitions/membershipEarningPreferenceType" - }, - "effectiveDate": { - "description": "Indicates the starting date.", + "visaIssueDate": { + "description": "Visa Issue Date used for Maldives Bed Tax Reporting.", "type": "string", "format": "date", "maxLength": 8 }, - "enrollmentResort": { - "description": "Resort/CRO where enrollment is done.", + "visaExpiryDate": { + "description": "Visa Expiration Date used for Maldives Bed Tax Reporting", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "enrollmentSource": { - "description": "Source from where the enrollment is done.", + "taxableDays": { + "description": "Number of days for which the Maldives tax is applicable.", + "type": "integer" + } + } + }, + "folioTextsType": { + "type": "array", + "description": "This stores the description for the type of tax calculation especially with tax exemption, etc.", + "maxItems": 2, + "items": { + "type": "object", + "properties": { + "text": { + "description": "Additional text field to display on the folio.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "row": { + "description": "Row number of the additional text.", + "type": "integer" + } + } + } + }, + "resPeriodicFolioType": { + "type": "object", + "description": "Information regarding periodic folios set on the reservation.", + "properties": { + "lastSettlementDate": { + "description": "Latest date when a direct bill settlement was automatically done using the \"Direct Bill Batch Folios\" option.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "excludeFromBatch": { - "description": "True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.", - "type": "boolean" + "format": "date", + "maxLength": 8 }, - "expireDate": { - "description": "Indicates the ending date.", + "lastFolioDate": { + "description": "Latest date when a folio was printed using the \"Periodic Batch Folios\" option", "type": "string", "format": "date", "maxLength": 8 }, - "expireDateExclusiveIndicator": { - "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", - "type": "boolean" - }, - "inactive": { - "description": "Indicates whether membership is active or inactive.", - "type": "boolean" + "frequency": { + "description": "Frequency in number of days when folios should be printed for this reservation.", + "type": "integer" + } + } + }, + "resCompAccountingType": { + "type": "object", + "description": "Information regarding comp accounting on the reservation.", + "properties": { + "compType": { + "description": "Code used to identify the casino comp type and ranking of a guest.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "authorizer": { + "description": "ID of the employee who will act as the host for this guest.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", + "compPostings": { + "description": "Indicates if the Comp Billing/posting Exist", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 5 + } + } + }, + "resPreConfiguredRoutingInstrType": { + "type": "object", + "description": "Instruction to attach Pre-Configured Routing Instructions to a Reservation.", + "properties": { + "authorizerInfo": { + "description": "The authorizer information for Promotion Code with attached Complimentary Routing", + "$ref": "#/definitions/authorizerInfoType" }, - "memberStatus": { - "description": "Indicates where the guest is in the membership enrollment process.", + "ratePlanCode": { + "description": "Rate Code with attached Routing Instruction.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "membershipClass": { - "description": "Indicates the membership class.", - "type": "string" + "profileType": { + "description": "Profile Type with attached Routing Instruction.", + "$ref": "#/definitions/resProfileTypeType" }, - "membershipEnrollmentCode": { - "description": "Indicates how the guest enrolled in the program.", + "promotionCode": { + "description": "Promotion Code with attached Complimentary Routing.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "authorizerInfoType": { + "type": "object", + "description": "Authorizer Information", + "properties": { + "authorizerId": { + "$ref": "#/definitions/uniqueID_Type" }, - "membershipId": { - "description": "Card Number of the membership.", - "type": "string" + "authorizerUserName": { + "description": "Application user name of the authorizer", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "membershipIdNo": { - "description": "Membership ID Number.", - "type": "integer" + "authorizerName": { + "description": "Full name of the authorizer.", + "type": "string", + "minLength": 0, + "maxLength": 100 }, - "membershipLevel": { - "description": "Indicates the membership level.", - "type": "string" + "authorizerRateCode": { + "description": "Rate code of the authorizer.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "membershipLevelDescription": { - "description": "Indicates the membership level description.", + "inheritAuthorizerRateCode": { + "description": "Indicates whether user has the choice to have reservation inherit rate code from the authorizer.", + "type": "boolean" + } + } + }, + "taxTypeType": { + "type": "object", + "description": "Provides information about the Tax Type.", + "properties": { + "hotelId": { + "description": "Code of the Hotel.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "membershipType": { - "description": "Type of membership.", - "type": "string" + "code": { + "description": "Code of the Tax Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "nameOnCard": { - "description": "Name to be displayed on the membership card.", - "type": "string" + "description": { + "description": "Description of the Tax Type.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "newMembershipNumber": { - "description": "Card Number of the membership.", - "type": "string" + "collectingAgentTax": { + "description": "A boolean flag for Collecting Agent Tax", + "type": "boolean" }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "printAutoAdjust": { + "description": "Print auto adjust information for this tax type on the tax exempt report.", + "type": "boolean" }, - "playerRanking": { - "description": "Ranking assigned to the Player Profile by the Gaming system.", + "reportExemptDays": { + "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.", "type": "integer" }, - "pointsLabel": { - "description": "Label used to refer to points for this membership type", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "preferredCard": { - "description": "Preferred Card.", - "type": "boolean" + "reportTaxPercentage": { + "description": "Tax percentage. Only used for tax exempt report.", + "type": "number", + "minimum": 0, + "maximum": 100 }, - "primaryMembership": { - "description": "Boolean indicator set to True implies membership is a Primary Membership.", - "type": "boolean" + "minimumLengthOfStay": { + "description": "Minimun Length of Stay.", + "type": "integer" + } + } + }, + "reservationDepositType": { + "type": "object", + "description": "Reservation Deposit Type.", + "properties": { + "amountRequired": { + "description": "Deposit Amount Required.", + "type": "number" }, - "primaryMembershipYn": { - "description": "Indicator if Membership is a Primary Membership.", - "type": "string", - "maxLength": 1, - "minLength": 0 + "amountPaid": { + "description": "Deposit Amount Paid.", + "type": "number" }, - "programDescription": { - "description": "Description of the membership program.", - "type": "string" + "amountOwed": { + "description": "Deposit Amount Owed.", + "type": "number" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "dueDate": { + "description": "Deposit Due Date.", "type": "string", "format": "date", "maxLength": 8 }, - "rating": { - "description": "Value Rating Type Description for this membership.", - "type": "string" - }, - "reIssueNewCard": { - "description": "The status of issuing new membership card to the member.", - "$ref": "#/definitions/cardReIssueType" - }, - "signupDate": { - "description": "Indicates when the member signed up for the loyalty program.", + "postingDate": { + "description": "Deposit Posting Date.", "type": "string", "format": "date", "maxLength": 8 }, - "tierAdministration": { - "description": "Defines the degree of participation for this membership in the tier management portion of the program.", - "$ref": "#/definitions/tierAdministrationType" + "hasPaid": { + "description": "Resolves whether reservation has paid deposit.", + "type": "boolean" }, - "upgradeDescription": { - "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.", + "hasOutstanding": { + "description": "Resolves whether reservation has outstanding deposit.", + "type": "boolean" + } + } + }, + "reservationAllowedActionsType": { + "type": "array", + "description": "Allowed action.", + "maxItems": 11, + "items": { + "$ref": "#/definitions/reservationAllowedActionType" + } + }, + "reservationAllowedActionType": { + "type": "string", + "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.", + "enum": [ + "Cancel", + "Move", + "PreCharge", + "PostCharge", + "FacilitySchedule", + "Upsell", + "PreCheckIn", + "PostToNoShowCancel", + "NoShow", + "NameChange", + "Discount", + "EnrollToPrimaryMembership", + "EnrollInProgress" + ] + }, + "reservationInterfaceStatusType": { + "type": "object", + "description": "Hotel Interface Type for a reservation and status of the various services", + "properties": { + "roomExtension": { + "description": "Identifier for the room extension", "type": "string", - "maxLength": 32000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "hotelInterface": { + "description": "Hotel interface information for the reservation", + "$ref": "#/definitions/hotelInterfaceType" + }, + "interfaceRights": { + "description": "Contains a list of status/rights for the various services under this interface", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceRightsStatusType" + } } } }, - "profileRestrictions": { + "hotelInterfaceType": { "type": "object", "properties": { - "reason": { - "description": "Restriction reason associated with the current profile.", + "interfaceId": { + "description": "Unique DB internal number of a Hotel Interface record.", + "$ref": "#/definitions/uniqueID_Type" + }, + "hotelId": { + "description": "Hotel Code", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "reasonDescription": { - "description": "Description of restriction reason.", + "interfaceName": { + "description": "Name of the Hotel Interface", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "restricted": { - "description": "True indicates there are restrictions associated with the current profile.", + "interfaceType": { + "description": "Three letter code for each interface that identifies the interface.", + "$ref": "#/definitions/hotelInterfaceTypeType" + }, + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "machineName": { + "description": "Unique machine name of the running IFC.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "status": { + "description": "The current status of the IFC.", + "$ref": "#/definitions/hotelInterfaceStatusType" + }, + "activeFlag": { + "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", "type": "boolean" } } }, - "profileSharedLevelType": { - "description": "Simple types for Shared level.", + "hotelInterfaceTypeType": { "type": "string", "enum": [ - "Global", - "Property", - "Cro" - ] + "Bms", + "Cas", + "Ccw", + "Dls", + "Eft", + "Exp", + "Mak", + "Mbs", + "Msc", + "Pbx", + "Pos", + "Svs", + "Tik", + "Vid", + "Vms", + "Www", + "Xml" + ], + "description": "XML Posting Interface" }, - "profileStatusType": { + "hotelInterfaceStatusType": { "type": "string", + "description": "Status of the Hotel Interface either STOPPED or RUNNING.", "enum": [ - "Active", - "Inactive" + "Stopped", + "Running", + "Waiting", + "StopInitiated", + "StartInitiated", + "RebootInitiated", + "Other" ] }, - "profileSubscriptionListType": { - "description": "Details of the OPERA Profile subscription to external system", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileSubscriptionType" - } - }, - "profileSubscriptionType": { - "description": "Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular external system", + "interfaceRightsStatusType": { "type": "object", "properties": { - "distributed": { - "description": "Indicates if the profile was distributed to the external system.", - "type": "boolean" - }, - "externalProfileId": { - "description": "Profile ID within the external system.", - "$ref": "#/definitions/uniqueID_Type" - }, - "force": { - "description": "Indicates if the profile information should be overwritten by the external system.", - "type": "boolean" - }, - "inactive": { - "description": "Indicates whether this subscription is active or inactive.", - "type": "boolean" - }, - "lastDistributionDate": { - "description": "Timestamp of the most recent distribution of this profile to the external system.", - "type": "string", - "format": "date-time" - }, - "lastExternalUpdateDate": { - "description": "Timestamp of the most recent update of the subscription information by the external system.", - "type": "string", - "format": "date-time" - }, - "profileId": { - "description": "OPERA Profile ID that this subscription record corresponds to.", - "$ref": "#/definitions/profileId" - }, - "profileInfo": { - "description": "This provides name information for a person.", - "type": "object", - "properties": { - "fullName": { - "description": "Full display Name.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "givenName": { - "description": "Given name, first name or names.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "middleName": { - "description": "The middle name of the person name.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "name": { - "description": "Family name, last name or Company Name.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "namePrefix": { - "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "nameSuffix": { - "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "nameTitle": { - "description": "Degree or honors (e.g., Ph.D., M.D.)", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "nameType": { - "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", - "$ref": "#/definitions/personNameTypeType" - }, - "profileType": { - "description": "OPERA profile type such as Individual or Company", - "$ref": "#/definitions/profileTypeType" - } - } + "right": { + "description": "Internal code for each allowed right of a Hotel Interface record.", + "type": "integer" }, - "subscriptionDate": { - "description": "Timestamp when the profile was subscribed to.", + "statusCode": { + "description": "User defined code for an Interface Right.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 5 }, - "systemCode": { - "description": "Code of system where profile is subscribed to.", + "description": { + "description": "User defined description for an Interface Right.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "systemType": { - "description": "Type of system where profile is subscribed to.", + "category": { + "description": "Category code of this interface right.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 1 } } }, - "profileTaxInfoType": { - "description": "Profile information related to tax.", + "reservationTurndownInfoType": { "type": "object", + "description": "Turndown information for a reservation", "properties": { - "businessId": { - "description": "Business ID. The maximum length of this element should not exceed 120 characters.", - "type": "string", - "maxLength": 128, - "minLength": 0 - }, - "businessRegistration": { - "description": "Business Registration Code. The maximum length of this element should not exceed 120 characters.", - "type": "string", - "maxLength": 128, - "minLength": 0 + "allowed": { + "description": "Indicates if turndown is allowed or not", + "type": "boolean" }, - "tax1No": { - "description": "The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "status": { + "description": "Indicates turndown status, values could be required, not required, completed", + "$ref": "#/definitions/turndownStatusType" + } + } + }, + "turndownStatusType": { + "type": "string", + "description": "Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.", + "enum": [ + "Required", + "NotRequired", + "Compeleted" + ] + }, + "resMobileNotificationsType": { + "type": "object", + "description": "Contains the status of Room Ready and Key Ready messages.", + "properties": { + "roomReady": { + "description": "Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED", + "$ref": "#/definitions/communicationStatusType" }, - "tax2No": { - "description": "Tax 2 id of this profile.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "keyReady": { + "description": "Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED", + "$ref": "#/definitions/communicationStatusType" }, - "taxCategory": { - "description": "Tax Category to be changed.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "checkoutMessageReceived": { + "description": "Indicates if the Mobile checkout message is received.", + "type": "boolean" }, - "taxOffice": { - "description": "Tax Office to be changed.", - "type": "string", - "maxLength": 30, - "minLength": 0 + "requiresAction": { + "description": "Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout", + "type": "boolean" }, - "taxType": { - "description": "Tax type to be changed.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "errorMessage": { + "description": "Error message when Mobile Notification has failed.", + "type": "string" } } }, - "profileType": { - "description": "Type provides the detailed information about the profile and its children.", + "communicationStatusType": { + "type": "string", + "description": "Enum to denote the Status of Readiness messages sent to Guest Devices.", + "enum": [ + "Pending", + "Completed", + "Failed", + "Sent", + "Received", + "Cancelled", + "PendingAvailability" + ] + }, + "resCommunicationType": { "type": "object", + "description": "Communication details for a reservation.", "properties": { - "addresses": { - "description": "List of customer addresses.", + "telephones": { + "description": "List of Telephone Number Information", "type": "object", "properties": { - "addressInfo": { - "description": "Collection of Detailed information on an address for the customer.", + "telephoneInfo": { + "description": "Collection of Detailed information on telephone/fax for the customer.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/addressInfoType" + "$ref": "#/definitions/telephoneInfoType" } }, - "count": { - "description": "Total number of rows returned", - "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" @@ -48072,39 +42442,25 @@ "totalResults": { "description": "Total number of rows queried", "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" } } }, - "businessSegments": { - "description": "Business/Market Segment associated to the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 20, - "minLength": 0 - } - }, - "cashiering": { - "description": "Contains cashiering related details for the profile", - "$ref": "#/definitions/profileCashieringType" - }, - "comments": { - "description": "List of Notes for the customer.", + "emails": { + "description": "List of email address for the customer.", "type": "object", "properties": { - "commentInfo": { - "description": "Collection of Detailed information on comments for the customer.", + "emailInfo": { + "description": "Collection of Detailed information on an eMail address for the customer.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/commentInfoType" + "$ref": "#/definitions/emailInfoType" } }, - "count": { - "description": "Total number of rows returned", - "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" @@ -48112,4455 +42468,5271 @@ "totalResults": { "description": "Total number of rows queried", "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" } } + } + } + }, + "advanceCheckInType": { + "type": "object", + "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", + "properties": { + "advanceCheckedIn": { + "description": "Indicates if the reservation is marked as Advance Checked In", + "type": "boolean" }, - "commissionInfoList": { - "description": "Contains commission related details for the profile.", + "expectedReturnTime": { + "description": "Expected Return Time", + "type": "string", + "format": "date-time" + }, + "eTRComments": { + "description": "ETR Comments", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "pMS_ResStatusType": { + "type": "string", + "description": "This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.", + "enum": [ + "Reserved", + "Requested", + "NoShow", + "Cancelled", + "InHouse", + "CheckedOut", + "Waitlisted", + "DueIn", + "DueOut", + "Walkin", + "PendingCheckout" + ] + }, + "resAccessRestrictionType": { + "type": "string", + "description": "Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.", + "enum": [ + "Change", + "Cancel", + "ChangeOrCancel" + ] + }, + "commissionPayoutToType": { + "type": "string", + "enum": [ + "TravelAgent", + "Source", + "TravelAgentSource", + "None" + ] + }, + "futureListType": { + "type": "object", + "description": "A collection of reservation history details attached to Profiles.", + "properties": { + "reservationInfo": { + "description": "Additional reservation information attached to the profile . Eg : Future reservation details", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/profileCommissionType" + "$ref": "#/definitions/reservationInfoType" } }, - "company": { - "description": "Detailed company information for this profile.", - "$ref": "#/definitions/companyType" + "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" }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "reservationStayHistoryFutureInfoType": { + "type": "object", + "description": "Information of History and Future Reservation details attached to Profiles.", + "properties": { + "historyList": { + "description": "Refer to History list type document.", + "$ref": "#/definitions/stayHistoryListType" }, - "customer": { - "description": "Detailed customer information for this profile.", - "$ref": "#/definitions/customerType" + "futureList": { + "description": "Refer to Future list type document.", + "$ref": "#/definitions/stayFutureListType" + } + } + }, + "stayHistoryListType": { + "type": "object", + "description": "A collection of reservation history details attached to Profiles.", + "properties": { + "reservationInfo": { + "description": "Additional reservation information attached to the profile . Eg : History reservation details", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stayReservationInfoType" + } }, - "eCertificates": { - "description": "E-Certificate assosiated with the profile.", - "$ref": "#/definitions/eCertificatesType" + "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" }, - "eligibleForFiscalFolio": { - "description": "Eligible for Fiscal Folio/Payload generation.", + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "stayReservationInfoType": { + "type": "object", + "description": "The Reservation class contains the current reservation being created or altered.", + "properties": { + "reservationIdList": { + "description": "Unique identifiers for the reservation for both internal and external systems", + "$ref": "#/definitions/reservationIdList" + }, + "roomStay": { + "description": "Collection of room stays.", + "$ref": "#/definitions/stayInfoType" + }, + "attachedProfiles": { + "description": "List of attached profiles", + "$ref": "#/definitions/resAttachedProfileListType" + }, + "hotelId": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "emails": { - "description": "List of email address for the customer.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "type": "integer" - }, - "emailInfo": { - "description": "Collection of Detailed information on an eMail address for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/emailInfoType" - } - }, - "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" - } - } + "reservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" }, - "gdsNegotiatedRates": { - "description": "List of channel negotiated rates that this profile has been assigned to.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "type": "integer" - }, - "gdsNegotiatedRate": { - "description": "Collection of Detailed information on channel negotiated rates for the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/gdsNegotiatedType" - } - }, - "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" - } + "computedReservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" + } + } + }, + "stayFutureListType": { + "type": "object", + "description": "A collection of reservation history details attached to Profiles.", + "properties": { + "reservationInfo": { + "description": "Additional reservation information attached to the profile . Eg : Future reservation details", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stayReservationInfoType" } }, - "hasCommission": { - "description": "Populates true if the profile has commission configured false otherwise.", + "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" }, - "influenceCode": { - "description": "Influence Code associated to the profile.", + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "lastStayInfoType": { + "type": "object", + "description": "Contains last stay related details for the profile", + "properties": { + "lastVisit": { + "description": "Used to hold last stay information for the profile.", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "inheritedNegRates": { - "description": "Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.", - "type": "boolean" + "lastRoom": { + "description": "Used to hold last room information for the profile.", + "type": "string" }, - "keywords": { - "description": "List of customer keywords.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "keyword": { - "description": "Collection of keywords attached to the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/keywordType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } - } + "lastRate": { + "description": "Used to hold last rate information for the profile.", + "$ref": "#/definitions/currencyAmountType" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "totalStay": { + "description": "The total number of previous stay of the profile.", + "type": "integer" + } + } + }, + "profileAccessType": { + "type": "object", + "properties": { + "chainCode": { + "description": "Indicates the Chain code where the profile was created", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", + "croCode": { + "description": "Indicates the CRO code where the profile was created", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 200 }, - "lastStayInfo": { - "description": "Information on last stay of the profile.", - "$ref": "#/definitions/lastStayInfoType" + "hotelId": { + "description": "Indicates the Hotel code where the profile was created", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "localizationGuestType": { - "description": "Localization Guest Type assocaited to the profile.", + "sharedLevel": { + "description": "Indicates whether the profile is shared at the following levels : global/property/CRO", + "$ref": "#/definitions/profileSharedLevelType" + } + } + }, + "profileSharedLevelType": { + "type": "string", + "description": "Simple types for Shared level.", + "enum": [ + "Global", + "Property", + "Cro" + ] + }, + "profileRestrictions": { + "type": "object", + "properties": { + "reason": { + "description": "Restriction reason associated with the current profile.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "mailingActions": { - "description": "Contains collection of mailing action list associated with the profile", - "$ref": "#/definitions/mailingActionsType" + "reasonDescription": { + "description": "Description of restriction reason.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "markAsRecentlyAccessed": { - "description": "Mark this profile as recently accessed.", + "restricted": { + "description": "True indicates there are restrictions associated with the current profile.", "type": "boolean" + } + } + }, + "mailingActionsType": { + "type": "object", + "description": "Defines mailing action list for the profile.", + "properties": { + "mailingAction": { + "description": "Defines mailing action code and description.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeDescriptionType" + } }, - "markForHistory": { - "description": "\"true\" setting marks the profile to be kept from being purged, once the profile is marked inactive.", + "active": { + "description": "When true indicates that profile has subscribed to the mailing list.", "type": "boolean" }, - "negotiatedRates": { - "description": "List of profile negotiated rates.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "negotiatedRate": { - "description": "Collection of Detailed information on profile negotiated rates.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/negotiatedType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "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" }, - "ownerCode": { - "description": "Owner Code associated to the profile.", + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "privacyInfoType": { + "type": "object", + "description": "Defines Privacy related information for the profile.", + "properties": { + "marketResearchParticipation": { + "description": "Indicates if the profile participates in market research.", + "type": "boolean" + }, + "lastPrivacyPromptDate": { + "description": "Indicate the last privacy prompt date of the guest.", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "preferenceCollection": { - "description": "List of customer preferences.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "preferenceType": { - "description": "Collection of Detailed information on preferences of the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/preferenceTypeType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } - } + "infoFromThirdParty": { + "description": "Indicates if the profile is ok getting info from third parties.", + "type": "boolean" + }, + "autoEnrollLoyaltyProgram": { + "description": "Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.", + "type": "boolean" }, - "privacyInfo": { - "description": "Contains privacy related information associated with the profile", - "$ref": "#/definitions/privacyInfoType" + "allowPhone": { + "description": "Indicates if the profile wishes to allow phone calls.", + "type": "boolean" }, - "profileAccessType": { - "description": "Detailed information on access type associated with the profile.", - "$ref": "#/definitions/profileAccessType" + "allowSMS": { + "description": "Indicates if the profile wishes to allow SMS.", + "type": "boolean" }, - "profileDeliveryMethods": { - "description": "List of Delivery methods configured against a Property for this Profile.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "profileDeliveryMethod": { - "description": "Collection of delivery methods for this Profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileDeliveryMethod" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } - } + "allowEmail": { + "description": "Indicates if the profile wishes to allow Email.", + "type": "boolean" }, - "profileImage": { - "description": "The profile image.", - "$ref": "#/definitions/imageSetType" + "optInMailingList": { + "description": "Indicates if the profile wishes to opt in for Mailing List.", + "type": "boolean" }, - "profileIndicators": { - "description": "Indicators of additional information attached to the profile", - "$ref": "#/definitions/indicatorsType" + "optInMarketResearch": { + "description": "Indicates if the profile wishes to opt in for Market Research.", + "type": "boolean" }, - "profileMemberships": { - "description": "List of loyalty program(s) the profile is subscribed to.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "profileMembership": { - "description": "Collection of Detailed information on memberships for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileMembershipType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } - } + "optInThirdParty": { + "description": "Indicates if the profile wishes to opt in for Third Party.", + "type": "boolean" }, - "profileRestrictions": { - "description": "Detailed information on restrictions associated with the profile.", - "$ref": "#/definitions/profileRestrictions" + "optInAutoEnrollmentMember": { + "description": "Indicates if the profile wishes to opt in for Auto Enrolment Member.", + "type": "boolean" }, - "profileType": { - "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", - "$ref": "#/definitions/profileTypeType" + "optInPhone": { + "description": "Indicates if the profile wishes to opt in for Phone.", + "type": "boolean" }, - "protectedBy": { - "description": "What level this profile is protected.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "optInSms": { + "description": "Indicates if the profile wishes to opt in for SMS.", + "type": "boolean" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 + "optInEmail": { + "description": "Indicates if the profile wishes to opt in for Email.", + "type": "boolean" + } + } + }, + "profileCashieringType": { + "type": "object", + "description": "Contains cashiering related details for the profile", + "properties": { + "directBillingList": { + "description": "Contains the direct billing related information for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/directBillingType" + } }, - "registeredProperty": { - "description": "Hotel which this profile is registered with. This attribute is not used for configuration.", + "autoFolioSettlementType": { + "description": "Contains the auto folio settlement type for the profile.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "relationships": { - "description": "Contains a collection of profiles that have a relationship with this profile.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "relationship": { - "description": "A collection of the profiles that have a relationship with this profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/relationshipInfoType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } - } + "paymentDueDays": { + "description": "Ability to define on the account, the number of days after which the invoice should be paid.", + "type": "integer" }, - "relationshipsSummary": { - "description": "Contains a collection of profiles that have a relationship with this profile.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "relationship": { - "description": "A collection of the profiles summary that have a relationship with this profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/relationshipInfoSummaryType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } - } + "taxPercent1": { + "description": "Tax1 Percentage for Collecting Agent.", + "type": "integer" }, - "requestForHotel": { - "description": "Hotel which this profile is to be registered. This attribute is only used during creation of profile.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "taxPercent2": { + "description": "Tax2 Percentage for Collecting Agent.", + "type": "integer" }, - "reservationInfoList": { - "description": "Collection of Detailed information on history and future reservations associated with the profile.", - "$ref": "#/definitions/reservationHistoryFutureInfoType" + "taxPercent3": { + "description": "Tax3 Percentage for Collecting Agent.", + "type": "integer" }, - "salesInfo": { - "description": "Sales information of the profiles.", - "$ref": "#/definitions/salesInfoType" + "taxPercent4": { + "description": "Tax4 Percentage for Collecting Agent.", + "type": "integer" }, - "statusCode": { - "description": "Status of the profile. Active/Inactive", - "$ref": "#/definitions/profileStatusType" + "taxPercent5": { + "description": "Tax5 Percentage for Collecting Agent.", + "type": "integer" }, - "stayReservationInfoList": { - "description": "Collection of Detailed information on history and future reservations associated with the profile.", - "$ref": "#/definitions/reservationStayHistoryFutureInfoType" + "arNoCentral": { + "description": "Account Receivables Central Number.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "subscriptions": { - "description": "List of profile subscriptions.", - "$ref": "#/definitions/profileSubscriptionListType" + "referenceCurrency": { + "description": "Reference Currency.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "taxInfo": { - "description": "Profile information about tax.", - "$ref": "#/definitions/profileTaxInfoType" + "vATOffsetYN": { + "description": "VAT Offset Flag.", + "type": "string", + "minLength": 0, + "maxLength": 1 }, - "telephones": { - "description": "List of Telephone Number Information", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "telephoneInfo": { - "description": "Collection of Detailed information on telephone/fax for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/telephoneInfoType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } - } + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "territory": { - "description": "Territory associated to the profile.", + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 10 }, - "traceCode": { - "description": "Trace Code associated to the profile.", + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "type": "integer" + } + } + }, + "directBillingType": { + "type": "object", + "description": "This is the preconfigured routing instruction type.", + "properties": { + "hotelId": { + "description": "Hotel Code for which the details of direct billing is provided for a profile.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "uRLs": { - "description": "List of Information on a URL for the customer.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "uRLInfo": { - "description": "Collection of Detailed information on web url/address for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/uRLInfoType" - } - } - } + "aRNumber": { + "description": "Hotel Code for which the details of direct billing is provided for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "profileCommissionType": { + "type": "object", + "description": "This is the preconfigured routing instruction type.", + "properties": { + "hotelId": { + "description": "Hotel Code for the commission being used for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "userDefinedFields": { - "description": "Collections of user defined fields.", - "$ref": "#/definitions/userDefinedFieldsType" + "commissionCode": { + "description": "commission Code for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "webUserAccounts": { - "description": "List of Web User Accounts of the profile.", - "$ref": "#/definitions/webUserAccountsType" + "bankAccount": { + "description": "Bank account used for the commission for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "paymentMethod": { + "description": "Type of payment associated with the bank account.", + "$ref": "#/definitions/commissionPaymentMethods" + }, + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "type": "integer" } } }, - "profileTypeType": { - "description": "The types of Profile handled by the web service.", + "commissionPaymentMethods": { "type": "string", + "description": "Check", "enum": [ - "Guest", - "Agent", - "Company", - "Group", - "Source", - "Employee", - "Hotel", - "Vendor", - "Contact", - "Purge", - "BusinessHeader", - "BillingAccount", - "Activity", - "Potential", - "Account" + "Cent", + "Eft", + "Chk" ] }, - "promotionType": { - "description": "Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.", + "userDefinedFieldsType": { "type": "object", + "description": "A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.", "properties": { - "couponCode": { - "description": "Promotion Coupon Code when promotion is setup to have a valid coupon code.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "characterUDFs": { + "description": "Collection of user defined fields of Character/String Type.", + "$ref": "#/definitions/characterUDFsType" }, - "promotionCode": { - "description": "Promotion code associated with the rate plan.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "numericUDFs": { + "description": "Collection of user defined fields of Numeric Type.", + "$ref": "#/definitions/numericUDFsType" }, - "promotionName": { - "description": "Promotion code Name associated with the rate plan.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "dateUDFs": { + "description": "Collection of user defined fields of Date Type.", + "$ref": "#/definitions/dateUDFsType" } } }, - "propertyDetailCategoriesCriteria": { - "description": "Request object for creating Property Detail Categories.", + "characterUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Character/String Type.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/characterUDFType" + } + }, + "characterUDFType": { "type": "object", + "description": "Used to hold user defined field of Character/String Type.", "properties": { - "links": { - "$ref": "#/definitions/links" + "name": { + "description": "Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "propertyDetailCategories": { - "description": "Property Detail Categories to be created.", - "$ref": "#/definitions/propertyDetailCategoriesType" + "value": { + "description": "Value of user defined field.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "alternateName": { + "description": "Label of user defined field used by vendors or customers.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "propertyDetailCategoriesDetails": { - "description": "Response object for fetching Property Detail Categories.", + "numericUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Numeric Type.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/numericUDFType" + } + }, + "numericUDFType": { "type": "object", + "description": "Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", "properties": { - "links": { - "$ref": "#/definitions/links" + "name": { + "description": "Name of user defined field.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "propertyDetailCategories": { - "description": "Collection of Property Detail Categories.", - "$ref": "#/definitions/propertyDetailCategoriesType" + "value": { + "description": "Value of user defined field.", + "type": "number" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "alternateName": { + "description": "Label of user defined field used by vendors or customers.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "propertyDetailCategoriesToBeChanged": { - "description": "Request object for changing Property Detail Categories.", + "dateUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Date Type.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/dateUDFType" + } + }, + "dateUDFType": { "type": "object", + "description": "Used to hold user defined field of Date Type.", "properties": { - "links": { - "$ref": "#/definitions/links" + "name": { + "description": "Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "propertyDetailCategories": { - "description": "Property Detail Categories to be changed.", - "$ref": "#/definitions/propertyDetailCategoriesType" + "value": { + "description": "Value of user defined field.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "alternateName": { + "description": "Label of user defined field used by vendors or customers.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "propertyDetailCategoriesType": { - "description": "List of Property Detail Categories.", + "webUserAccountsType": { "type": "array", + "description": "Web User Accounts List.", "maxItems": 4000, "items": { - "$ref": "#/definitions/propertyDetailCategoryType" + "$ref": "#/definitions/webUserAccountType" } }, - "propertyDetailCategoryType": { - "description": "Contains Common Master configuration detail.", + "webUserAccountType": { "type": "object", + "description": "Web User Account of the guest.", "properties": { - "code": { - "description": "Common Master unique code.", + "securityQuestion": { + "description": "Security Question and its Code associated with the account to verify the user.", + "$ref": "#/definitions/codeDescriptionType" + }, + "securityAnswer": { + "description": "Answer to the Security Question.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "comments": { + "description": "Comments.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "history": { + "description": "Web User Account History.", + "$ref": "#/definitions/webUserHistoryType" + }, + "newLoginName": { + "description": "New Login Name of the guest.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "newPassword": { + "description": "Login Password.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "autoGeneratePassword": { + "description": "A flag which determines if the password is auto generated.", + "type": "boolean" + }, + "loginName": { + "description": "Login Name of the guest.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "domainCode": { + "description": "Domain code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "locked": { + "description": "Boolean flag that indicates whether the web account is locked or not.", + "type": "boolean" + }, + "inactive": { + "description": "Boolean flag that indicates whether the web account is inactive or not.", + "type": "boolean" } } }, - "propertyTypeType": { - "description": "Contains Common Master configuration detail.", + "webUserHistoryType": { "type": "object", + "description": "Creation date time, Creator Id, last modification date time and last Modifier Id.", "properties": { - "code": { - "description": "Common Master unique code.", + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "maxLength": 40, - "minLength": 0 + "format": "date-time" }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" - } - } - }, - "propertyTypesCriteria": { - "description": "Request object for creating Property Types.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" }, - "propertyTypes": { - "description": "Property Typesto be created.", - "$ref": "#/definitions/propertyTypesType" + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "lastLogin": { + "description": "Last login date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "lastPasswordChange": { + "description": "Last Password change date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "inactiveDate": { + "description": "Inactive date.", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "propertyTypesDetails": { - "description": "Response object for fetching Property Types.", + "profileTaxInfoType": { "type": "object", + "description": "Profile information related to tax.", "properties": { - "links": { - "$ref": "#/definitions/links" + "tax1No": { + "description": "The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "propertyTypes": { - "description": "Collection of Property Types.", - "$ref": "#/definitions/propertyTypesType" + "tax2No": { + "description": "Tax 2 id of this profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "taxCategory": { + "description": "Tax Category to be changed.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "taxOffice": { + "description": "Tax Office to be changed.", + "type": "string", + "minLength": 0, + "maxLength": 30 + }, + "taxType": { + "description": "Tax type to be changed.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "businessId": { + "description": "Business ID. The maximum length of this element should not exceed 120 characters.", + "type": "string", + "minLength": 0, + "maxLength": 128 + }, + "businessRegistration": { + "description": "Business Registration Code. The maximum length of this element should not exceed 120 characters.", + "type": "string", + "minLength": 0, + "maxLength": 128 } } }, - "propertyTypesToBeChanged": { - "description": "Request object for changing Property Types.", + "salesInfoType": { "type": "object", + "description": "Provides sales information about the profiles of type company, travel agent, source and contact.", "properties": { - "links": { - "$ref": "#/definitions/links" + "scope": { + "description": "Defines the scope.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "propertyTypes": { - "description": "Property Typesto be changed.", - "$ref": "#/definitions/propertyTypesType" + "scopeCity": { + "description": "Defines the scope city.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "accountType": { + "description": "Defines the account type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "accountSource": { + "description": "Defines the account source.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "industryCode": { + "description": "Defines the industry code.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "businessSegments": { + "description": "Defines the Business segments.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "priority": { + "description": "Defines the priority.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "roomsPotential": { + "description": "Defines the rooms potential.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "actionCode": { + "description": "Defines the action code.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "competitionCode": { + "description": "Defines the competition code.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "influence": { + "description": "Defines the influence for the contact profile.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "preferredRoom": { + "description": "Defines the Preferred Room for profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel Code used to filter the sales information.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "propertyTypesType": { - "description": "List of Property Types.", + "eCertificatesType": { "type": "array", + "description": "List of e-certificates for the profile.", "maxItems": 4000, "items": { - "$ref": "#/definitions/propertyTypeType" + "$ref": "#/definitions/eCertificateType" } }, - "queueTextInfoType": { - "description": "Information regarding the message sent to guest.", + "eCertificateType": { "type": "object", + "description": "E-Certificates details.", "properties": { - "sentBy": { - "description": "User name of the user who sent message.", + "certificateId": { + "description": "System generated unique certificate id.", + "type": "integer" + }, + "voucherNo": { + "description": "System generated unique voucher number.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "sentTime": { - "description": "Time the text was last sent to the user.", + "certificateNo": { + "description": "Printed certificate no. This has to be unique.", "type": "string", - "format": "date-time" - } - } - }, - "rateRangeType": { - "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.", - "type": "object", - "properties": { - "base": { - "description": "The base amount charged for the accommodation or service.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/totalType" - } + "minLength": 0, + "maxLength": 40 }, - "rateChange": { - "description": "Rate Change Indicator.", + "eCertificateInfo": { + "$ref": "#/definitions/eCertificateInfoType" + }, + "expiryDate": { + "description": "Date of expiry.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "newExpiryDate": { + "description": "New Date of expiry to extend e-certificate.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "profileId": { + "description": "NameId.", + "$ref": "#/definitions/profileId" + }, + "consumptionDetail": { + "$ref": "#/definitions/eCertificateConsumptionType" + }, + "status": { + "description": "Status of the certificate.", + "$ref": "#/definitions/eCertificateStatusType" + }, + "printed": { + "description": "Print status of the certificate.", "type": "boolean" - } - } - }, - "rateRoomDetailsType": { - "type": "object", - "properties": { - "memberships": { - "description": "Detail regarding customer loyalty program.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipSearchType" - } }, - "restrictionType": { - "description": "Indicates the restriction types if hotel is not available.", - "$ref": "#/definitions/masterRestrictionStatusesType" + "inactiveDate": { + "description": "Date the record was marked as inactive.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "roomStays": { - "description": "Room stay information.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/roomStayType" - } - } - } - }, - "ratesType": { - "description": "Individual rate amount.", - "type": "object", - "properties": { - "rate": { - "description": "The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/amountType" - } + "awardId": { + "description": "AwardID.", + "$ref": "#/definitions/awardId" }, - "rateRange": { - "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/rateRangeType" - } - } - } - }, - "regionCodeType": { - "description": "Contains Common Master configuration detail.", - "type": "object", - "properties": { - "code": { - "description": "Common Master unique code.", + "databaseId": { + "description": "External reference from which the record is created.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "source": { + "description": "Source of e-certificate.", + "$ref": "#/definitions/eCertificateIssueSourceType" }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "issueType": { + "description": "Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p).", + "$ref": "#/definitions/eCertificateIssueType" + }, + "issueDate": { + "description": "Date when certificate was issued.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "awardPoints": { + "description": "Award points if any in case of certificate use membership award.", + "type": "integer" + }, + "generationDetail": { + "$ref": "#/definitions/eCertificateGenerationType" + }, + "originalVoucherNo": { + "description": "In case of in lieu of certificate this will contain the original voucher no.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "originalCertificateNo": { + "description": "In case of in lieu of certificate this will contain the original certificate no.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "inLieuSequence": { + "description": "Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.", + "type": "integer" + }, + "cancelRequestDate": { + "description": "Date on which the cancellation was requested.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "extensionCount": { + "description": "Number of times e-certificate is already extended.", + "type": "integer" } } }, - "regionType": { + "eCertificateInfoType": { "type": "object", + "description": "E-Certificates details.", "properties": { - "description": { - "description": "Description of the Region", + "certificateType": { + "description": "User defined certificate code.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "marketingCities": { - "description": "Marketing Cities under this Region.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/marketingCityType" + "membershipType": { + "description": "Membership type to which the certificate is linked to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "awardCode": { + "description": "Award type to which the certificate is linked to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "promotionCode": { + "description": "Promotion code to which certificate is attached to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "voucherBenefitCode": { + "description": "Voucher benefit code attached to the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "hotels": { + "description": "Hotel to which certificate is attached to.", + "type": "object", + "properties": { + "code": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "scope": { + "description": "Scope of e-cert: global,single property or multi property.", + "$ref": "#/definitions/eCertificateScopeType" + } } }, - "regionCode": { - "description": "Code of this Region.", + "description": { + "description": "Description about the certificate.", "type": "string", - "maxLength": 20, - "minLength": 0 - } - } - }, - "regionsCodeCriteria": { - "description": "Request object for creating Regions Code.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "minLength": 0, + "maxLength": 200 }, - "regionsCode": { - "description": "Regions Code to be created.", - "$ref": "#/definitions/regionsCodeType" + "longDescription": { + "description": "Detail description about the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "regionsCodeDetails": { - "description": "Response object for fetching Regions Code.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "label": { + "description": "Label for the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "regionsCode": { - "description": "Collection of Regions Code.", - "$ref": "#/definitions/regionsCodeType" + "maxExtensionAllowed": { + "description": "Number of times e-certificate can be extended.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "regionsCodeToBeChanged": { - "description": "Request object for changing Regions Code.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "usageCriteria": { + "$ref": "#/definitions/eCertificateUsageCriteriaType" }, - "regionsCode": { - "description": "Regions Code to be changed.", - "$ref": "#/definitions/regionsCodeType" + "value": { + "description": "Value of the certificate for the guest.", + "$ref": "#/definitions/currencyAmountType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "cost": { + "description": "Cost of certificate.", + "$ref": "#/definitions/currencyAmountType" + }, + "benefitSummary": { + "description": "Summary of Benefits attached to this ECertificate.", + "type": "string", + "minLength": 0, + "maxLength": 4000 } } }, - "regionsCodeType": { - "description": "List of Regions Code.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/regionCodeType" - } - }, - "regionsType": { - "description": "List of Regions.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/regionType" - } + "eCertificateScopeType": { + "type": "string", + "description": "Indicates that OPERA E-Certificate is available for a specific list of hotels.", + "enum": [ + "Global", + "Hotel", + "MultiHotel" + ] }, - "relationshipAddressType": { - "description": "Provides address information for a Relationship.", + "eCertificateUsageCriteriaType": { "type": "object", + "description": "E-Certificates details.", "properties": { - "addressLine": { - "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", - "type": "array", - "maxItems": 4, - "items": { - "type": "string", - "maxLength": 80, - "minLength": 0 - } + "reservation": { + "description": "Indicates if certificate is to be used against reservation or not.", + "type": "boolean" + }, + "web": { + "description": "Indicates if web certificate can be consumed in OWS.", + "type": "boolean" + }, + "webAllowed": { + "description": "Indicates if certificate consumption allowable on the web.", + "type": "boolean" }, - "city": { - "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", - "type": "string", - "maxLength": 40, - "minLength": 0 + "benefit": { + "description": "Indicates to attach a rate code to the e-certificate as a benefit.", + "type": "boolean" }, - "country": { - "description": "Country name (e.g., Ireland).", - "type": "string", - "maxLength": 200, - "minLength": 0 + "hotel": { + "description": "Indicates if web certificate can be consumed in hotel.", + "type": "boolean" }, - "postalCode": { - "description": "Post Office Code number.", - "type": "string", - "maxLength": 15, - "minLength": 0 + "verifyCertificateNo": { + "description": "Specify if the certificate number verification is required at time of consumption or not.", + "type": "boolean" }, - "state": { - "description": "State or Province name (e.g., Texas).", - "type": "string", - "maxLength": 20, - "minLength": 0 + "cancelAllowed": { + "description": "Identify if cancel is allowed or not.", + "type": "boolean" + }, + "generateInLieuCertificate": { + "description": "Identify if in lieu of certificate can be generated or not.", + "type": "boolean" } } }, - "relationshipInfoSummaryType": { - "description": "RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.", + "eCertificateConsumptionType": { "type": "object", + "description": "E-Certificates details.", "properties": { - "masterAccountDetails": { - "description": "Refer to Master Profile type document.", - "$ref": "#/definitions/masterAccountInfoType" - }, - "relationshipID": { - "description": "Relationship identifier.", + "hotelId": { + "description": "Property where certificate was consumed for.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "relationshipProfile": { - "description": "Refer to Relationship Profile Summary type document.", - "$ref": "#/definitions/relationshipProfileSummaryType" + "source": { + "description": "Source of consumption.", + "$ref": "#/definitions/eCertificateConsumeSourceType" }, - "sourceRelation": { - "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "surname": { + "description": "Last name of the person who consumed the certificate..", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "sourceRelationDescription": { - "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "firstName": { + "description": "First name of the person who consumed the certificate.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "targetRelation": { - "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).", + "middleName": { + "description": "Middle name of the person who consumed the certificate.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "targetRelationDescription": { - "description": "Displays the description of the target relation(Target Profile).", + "email": { + "description": "Email of the person who consumed the certificate.", "type": "string", - "maxLength": 200, - "minLength": 0 - } - } - }, - "relationshipInfoType": { - "description": "Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.", - "type": "object", - "properties": { - "changeRelationship": { - "description": "Information about the changes in relationship for the profile", - "$ref": "#/definitions/changeRelationsType" + "minLength": 0, + "maxLength": 2000 }, - "id": { - "description": "Relationship identifier.", + "date": { + "description": "Date the certificate was consumed.", "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "masterAccountInfo": { - "description": "Refer to Master Profile type document.", - "$ref": "#/definitions/masterAccountInfoType" + "format": "date", + "maxLength": 8 }, - "relation": { - "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "userName": { + "description": "Application user who created the consumption.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "relationDescription": { - "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "userNotes": { + "description": "Any notes on the certificate entered at time of consumption.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 4000 }, - "relationshipProfile": { - "description": "Refer to Relationship Profile type document.", - "$ref": "#/definitions/relationshipProfileType" + "referenceId": { + "description": "Any reference like reservation no etc against which the certificate was consumed.", + "$ref": "#/definitions/uniqueID_Type" }, - "targetRelation": { - "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).", + "locationType": { + "description": "Consumption location type.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "targetRelationDescription": { - "description": "Displays the description of the target relation(Target Profile).", + "authorizationCode": { + "description": "Authorization code for consumption.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "serviceDate": { + "description": "Date on which the service is due (arrival date in case of reservation).", "type": "string", - "maxLength": 200, - "minLength": 0 + "format": "date", + "maxLength": 8 } } }, - "relationshipProfileSummaryType": { + "eCertificateConsumeSourceType": { + "type": "string", + "description": "Indicates that OPERA E-Certificate is consumed by hotelPMS.", + "enum": [ + "Central", + "Web", + "Hotel" + ] + }, + "eCertificateStatusType": { + "type": "string", + "description": "Indicates that OPERA E-Certificate is reserved.", + "enum": [ + "Cancelled", + "Consumed", + "Deleted", + "Expired", + "Issued", + "Reserved" + ] + }, + "awardId": { "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": { - "address": { - "description": "Information on address details for the customer/company", - "$ref": "#/definitions/relationshipAddressType" + "url": { + "description": "URL that identifies the location associated with the record identified by the UniqueID.", + "type": "string" }, - "companyName": { - "description": "Name of the company.", + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "customerName": { - "description": "Name of the customer", + "instance": { + "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "emailAddress": { - "description": "Defines the e-mail address.", + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "ownerCode": { - "description": "Unique Code to identify the owner.", + "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", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "primary": { - "description": "Indicates if this relationship is the primary relationship.", - "type": "boolean" - }, - "primaryOwnerCode": { - "description": "When true, this is a primary owner.", - "type": "boolean" - }, - "profileIdList": { - "description": "Original profile details for which the relationships was created", - "$ref": "#/definitions/uniqueIDListType" - }, - "profileStatus": { - "description": "Status of the profile. Active/Inactive", - "$ref": "#/definitions/profileStatusType" + "idExtension": { + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" + } + } + }, + "eCertificateIssueSourceType": { + "type": "string", + "description": "Indicates that OPERA E-Certificate is issued by external system.", + "enum": [ + "Opera", + "Web", + "Interface" + ] + }, + "eCertificateIssueType": { + "type": "string", + "description": "Indicates that guest purchased OPERA E-Certificate.", + "enum": [ + "Assigned", + "OptedIn", + "Purchased" + ] + }, + "eCertificateGenerationType": { + "type": "object", + "description": "E-Certificates details.", + "properties": { + "ruleId": { + "description": "Key to identify the generation rule id.", + "$ref": "#/definitions/uniqueID_Type" }, - "profileType": { - "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", - "$ref": "#/definitions/profileTypeType" + "generationDetail": { + "description": "Reason for which e-certificate was generated.", + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "telephoneNumber": { - "description": "Telephone number assigned to a single location", + "referenceValue": { + "description": "Type of value that is in the certificate.valid values are membership_level.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "relationshipProfileType": { + "profileSubscriptionListType": { + "type": "array", + "description": "Details of the OPERA Profile subscription to external system", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileSubscriptionType" + } + }, + "profileSubscriptionType": { "type": "object", + "description": "Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular external system", "properties": { - "address": { - "description": "Information on address details for the customer/company", - "$ref": "#/definitions/addressInfoType" + "profileId": { + "description": "OPERA Profile ID that this subscription record corresponds to.", + "$ref": "#/definitions/profileId" }, - "changeProfileIdList": { - "description": "Updated/changed profile details for the relationships created", - "$ref": "#/definitions/uniqueIDListType" + "externalProfileId": { + "description": "Profile ID within the external system.", + "$ref": "#/definitions/uniqueID_Type" }, - "company": { - "description": "Detailed information of the Company.", - "$ref": "#/definitions/companyType" + "profileInfo": { + "description": "This provides name information for a person.", + "type": "object", + "properties": { + "name": { + "description": "Family name, last name or Company Name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "fullName": { + "description": "Full display Name.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "namePrefix": { + "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "givenName": { + "description": "Given name, first name or names.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "middleName": { + "description": "The middle name of the person name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameSuffix": { + "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameTitle": { + "description": "Degree or honors (e.g., Ph.D., M.D.)", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "nameType": { + "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", + "$ref": "#/definitions/personNameTypeType" + }, + "profileType": { + "description": "OPERA profile type such as Individual or Company", + "$ref": "#/definitions/profileTypeType" + } + } }, - "customer": { - "description": "Detailed information of the customer", - "$ref": "#/definitions/customerType" + "distributed": { + "description": "Indicates if the profile was distributed to the external system.", + "type": "boolean" }, - "email": { - "description": "Information on email address for the customer/company", - "$ref": "#/definitions/emailInfoType" + "force": { + "description": "Indicates if the profile information should be overwritten by the external system.", + "type": "boolean" }, - "id": { - "description": "Relationship identifier.", + "subscriptionDate": { + "description": "Timestamp when the profile was subscribed to.", "type": "string", - "maxLength": 80, - "minLength": 0 + "format": "date-time" }, - "primary": { - "description": "Indicates if this relationship is the primary relationship.", + "lastDistributionDate": { + "description": "Timestamp of the most recent distribution of this profile to the external system.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "primaryOwner": { - "description": "Primary Owner of the profile", - "$ref": "#/definitions/ownerType" - }, - "profileIdList": { - "description": "Original profile details for which the relationships was created", - "$ref": "#/definitions/uniqueIDListType" - }, - "profileType": { - "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", - "$ref": "#/definitions/profileTypeType" - }, - "statusCode": { - "description": "Status of the profile. Active/Inactive", - "$ref": "#/definitions/profileStatusType" + "format": "date-time" }, - "telephone": { - "description": "Information on telephone details for the customer/company", - "$ref": "#/definitions/telephoneInfoType" + "lastExternalUpdateDate": { + "description": "Timestamp of the most recent update of the subscription information by the external system.", + "type": "string", + "format": "date-time" }, - "uRLs": { - "description": "Information on web url/address for the customer/company", - "$ref": "#/definitions/uRLInfoType" - } - } - }, - "relativePositionType": { - "description": "Defines the position of an entity in relation to another entity (e.g. from an airport to a hotel, the relationship is dependent on use).", - "type": "object", - "properties": { - "distance": { - "description": "Defines the distance between two points.", - "type": "number" + "inactive": { + "description": "Indicates whether this subscription is active or inactive.", + "type": "boolean" }, - "distanceType": { - "description": "The unit of measure in a code format.", + "systemCode": { + "description": "Code of system where profile is subscribed to.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "drivingTime": { - "description": "The driving time in a free text format.", + "systemType": { + "description": "Type of system where profile is subscribed to.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 } } }, - "resAccessRestrictionType": { - "description": "Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.", - "type": "string", - "enum": [ - "Change", - "Cancel", - "ChangeOrCancel" - ] - }, - "resAccompanyGuestInfoType": { + "guestCountsType": { "type": "object", + "description": "A collection of GuestCount by age group.", "properties": { - "firstName": { - "description": "Given name, first name or names", - "type": "string" - }, - "fullName": { - "description": "String representation of the full name", - "type": "string" + "childAges": { + "description": "Defines Children's Ages. Number of children ages mentioned may mot match with children counts.", + "$ref": "#/definitions/childAgesType" }, - "lastName": { - "description": "Family name, last name.", - "type": "string" + "childBuckets": { + "description": "Defines children counts with Age Qualifying Group(Child Bucket#1) classification.", + "$ref": "#/definitions/childBucketsType" }, - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", - "$ref": "#/definitions/profileIdList" + "adults": { + "description": "Defines the number of Adults.", + "type": "integer" }, - "registrationCardNo": { - "description": "Unique identifier of the police registration card number.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "children": { + "description": "Defines the number of Children.", + "type": "integer" } } }, - "resAccompanyGuestListType": { - "description": "Collection of accompany guests", + "childAgesType": { "type": "array", + "description": "Age of a child in years.", "maxItems": 4000, "items": { - "$ref": "#/definitions/resAccompanyGuestInfoType" + "$ref": "#/definitions/childAgeType" } }, - "resAttachedProfileListType": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/resAttachedProfileType" + "childAgeType": { + "type": "object", + "description": "Defines Child's Age.", + "properties": { + "age": { + "description": "Age of a child in years.", + "type": "integer" + } } }, - "resAttachedProfileType": { + "childBucketsType": { "type": "object", + "description": "Defines children counts with Age Qualifying Group(Child Bucket) classification.", "properties": { - "name": { - "description": "Attached profile name", - "type": "string" + "bucket1Count": { + "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).", + "type": "integer" }, - "profileIdList": { - "description": "Collection of unique profile identifiers", - "$ref": "#/definitions/profileIdList" + "bucket2Count": { + "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).", + "type": "integer" }, - "reservationProfileType": { - "$ref": "#/definitions/resProfileTypeType" + "bucket3Count": { + "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).", + "type": "integer" + }, + "bucket4Count": { + "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).", + "type": "integer" + }, + "bucket5Count": { + "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).", + "type": "integer" } } }, "resAwardsType": { - "description": "Membership Awards code applied on the reservation.", "type": "object", + "description": "Membership Awards code applied on the reservation.", "properties": { - "awardVouchers": { - "$ref": "#/definitions/awardVouchersType" - }, "membershipNo": { "description": "Membership program under which the award is applied.", "$ref": "#/definitions/uniqueID_Type" }, + "awardVouchers": { + "$ref": "#/definitions/awardVouchersType" + }, "originalRoomType": { "description": "Room Type before the Upgrade Award.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "upgradeRoomType": { "description": "Room Type after the Upgrade Award.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "resCashieringType": { - "description": "Cashiering Information for the reservation.", + "awardVouchersType": { + "type": "array", + "description": "This stores the Membership Awards code applied on the reservation.", + "maxItems": 5, + "items": { + "type": "object", + "properties": { + "awardCode": { + "description": "Membership Award code applied on the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "voucherNo": { + "description": "Membership Award number.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + } + }, + "foreignExchangeType": { "type": "object", + "description": "Foreign Exchange info.", "properties": { - "bedTaxReporting": { - "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", - "$ref": "#/definitions/bedTaxReportingType" - }, - "billingPrivileges": { - "description": "Billing privileges set on the reservation.", - "$ref": "#/definitions/billingPrivilegesType" - }, - "compAccounting": { - "description": "Information regarding comp accounting on the reservation.", - "$ref": "#/definitions/resCompAccountingType" - }, - "financiallyResponsible": { - "description": "The guest from whom payment has to be recovered (direct guest).", - "type": "boolean" - }, - "folioTexts": { - "description": "Additional text fields to display on the folio.", - "$ref": "#/definitions/folioTextsType" + "type": { + "description": "Exchange Type for the postings.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "lastRoomAndTaxPostedDate": { - "description": "Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.", + "effectiveDate": { + "description": "Effective Exchange date for the foreign currency posting.", "type": "string", "format": "date", "maxLength": 8 + } + } + }, + "mealPlansType": { + "type": "array", + "description": "Meal plan codes associated with the rate codes.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/mealPlanCodeType" + } + }, + "mealPlanCodeType": { + "type": "object", + "description": "Meal plan codes associated with the rate codes.", + "properties": { + "code": { + "description": "Meal plan code.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "periodicFolio": { - "description": "Information regarding periodic folios set on the reservation.", - "$ref": "#/definitions/resPeriodicFolioType" - }, - "proratedBilling": { - "description": "In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.", + "included": { + "description": "Represents if the meal plan code is included in rate code or not.", "type": "boolean" }, - "reservationPreConfiguredRoutingInstruction": { - "description": "Information regarding the selected preconfigured routing instruction on the reservation.", - "$ref": "#/definitions/resPreConfiguredRoutingInstrType" - }, - "revenuesAndBalances": { - "description": "Revenues and Balances Amount summary for the reservation.", - "$ref": "#/definitions/resRevenueBalanceType" - }, - "reverseAdvanceCheckInAllowed": { - "description": "This attribute is to verify if reverse advance check-in is allowed for the reservation.", + "breakfastIncluded": { + "description": "Represents if the meal plan code is available for breakfast or not.", "type": "boolean" }, - "reverseCheckInAllowed": { - "description": "This attribute is to verify if reverse check-in is allowed for the reservation.", + "lunchIncluded": { + "description": "Represents if the meal plan code is available for lunch or not.", "type": "boolean" }, - "taxType": { - "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", - "$ref": "#/definitions/reservationTaxTypeInfo" - }, - "transactionsPosted": { - "description": "Specifies whether reservation has a financial transaction associated with it.", + "dinnerIncluded": { + "description": "Represents if the meal plan code is available for dinner or not.", "type": "boolean" } } }, - "resCommunicationType": { - "description": "Communication details for a reservation.", + "roomRateAvailReasonType": { + "type": "string", + "description": "Indicates the Room Rate is not available due to unavailability of enough items for the rate code.", + "enum": [ + "Available", + "Restricted", + "RestrictedDueToInventory", + "RestrictedDueToOccupancy", + "RestrictedDueToItemInventory" + ] + }, + "upsellInfoType": { "type": "object", + "description": "Information regarding upsell for a reservation.", "properties": { - "emails": { - "description": "List of email address for the customer.", + "originalInfo": { + "description": "Original Values of the reservation prior to upgrade.", "type": "object", "properties": { - "count": { - "description": "Total number of rows returned", - "type": "integer" + "rateCode": { + "description": "The Rate Code of the Reservation before it was upgraded", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "emailInfo": { - "description": "Collection of Detailed information on an eMail address for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/emailInfoType" - } + "totalAmount": { + "description": "Total Amount of the reservation before it was upgraded.", + "$ref": "#/definitions/currencyAmountType" }, - "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" + "roomType": { + "description": "Original Reservation Room Type before being upgraded.", + "$ref": "#/definitions/codeDescriptionType" }, - "totalResults": { - "description": "Total number of rows queried", + "nights": { + "description": "The number of nights of the reservation before being upgraded.", "type": "integer" } } }, - "telephones": { - "description": "List of Telephone Number Information", + "upsellInfo": { + "description": "Information of a reservation during the process of upgrade.", "type": "object", "properties": { - "count": { - "description": "Total number of rows returned", + "totalUpsellCharge": { + "description": "Amount that was charged for the upsell.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalUpsellMoneyAmount": { + "description": "Total Amount that was charged including upsell.", + "$ref": "#/definitions/currencyAmountType" + }, + "firstNightUpsellAmount": { + "description": "First Night Total Amount including Upsell.", + "$ref": "#/definitions/currencyAmountType" + }, + "firstNightUpsellCharge": { + "description": "First Night Upsell Charges.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalUpsellPoints": { + "description": "Total Upsell Points.", "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" + "totalActualRateAmount": { + "description": "Actual Total Room Rate for the Target Upsell Room Type.", + "$ref": "#/definitions/currencyAmountType" }, - "telephoneInfo": { - "description": "Collection of Detailed information on telephone/fax for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/telephoneInfoType" - } + "roomType": { + "description": "Reservation Room Type for Upsell.", + "$ref": "#/definitions/codeDescriptionType" }, - "totalResults": { - "description": "Total number of rows queried", + "roomLongDescription": { + "description": "Detail description of the Room Type.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "ruleId": { + "description": "Upsell Rule Id.", "type": "integer" + }, + "ruleCode": { + "description": "Upsell rule code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "ruleDescription": { + "description": "Upsell rule description", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "percentageSavings": { + "description": "Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "upsellDate": { + "description": "The date on which reservation is upgraded.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "upsellUser": { + "description": "User who upgraded the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } } } }, - "resCompAccountingType": { - "description": "Information regarding comp accounting on the reservation.", + "ownerResTypeType": { + "type": "string", + "enum": [ + "Owner", + "AuthorizedUser" + ] + }, + "primaryShareTypeType": { + "type": "string", + "enum": [ + "Primary", + "NonPrimary" + ] + }, + "channelSummaryInfoType": { "type": "object", + "description": "Depicts channel information such as the type and code.", "properties": { - "authorizer": { - "description": "ID of the employee who will act as the host for this guest.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "bookingChannel": { + "$ref": "#/definitions/bookingChannelType" }, - "compPostings": { - "description": "Indicates if the Comp Billing/posting Exist", - "type": "string", - "maxLength": 5, - "minLength": 0 + "messageId": { + "description": "Indicates the transaction identifier.", + "type": "string" }, - "compType": { - "description": "Code used to identify the casino comp type and ranking of a guest.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "summaryOnly": { + "description": "Used to indicate whether to return summarized or detailed rate room information.", + "type": "boolean" } } }, - "resExpectedTimesType": { - "description": "Holds the Arrival and Departure Time Information", + "bookingChannelType": { "type": "object", "properties": { - "reservationExpectedArrivalTime": { - "description": "Arrival Time", + "channelCode": { "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 20 }, - "reservationExpectedDepartureTime": { - "description": "Departure Time", + "channelName": { "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 80 + }, + "channelType": { + "type": "string", + "minLength": 0, + "maxLength": 240 } } }, - "resGuaranteeType": { - "description": "Validations type record returned after Validations are done.", + "sellMessagesType": { "type": "object", + "description": "The SellMessagesType is the list of message and attributes returned by web service.", "properties": { - "guaranteeCode": { - "description": "Guarantee Code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "sellMessage": { + "description": "This is the message text.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/sellMessageType" + } }, - "onHold": { - "description": "Guarantee Code.", + "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" }, - "shortDescription": { - "description": "Guarantee Code.", - "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "resGuestExternalInfoType": { - "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.", - "type": "object", - "properties": { - "givenName": { - "description": "Given name, first name or names", - "$ref": "#/definitions/givenNameType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "surname": { - "description": "Family name, last name.", - "$ref": "#/definitions/surnameType" + "count": { + "description": "Total number of rows returned", + "type": "integer" } } }, - "resGuestInfoType": { - "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.", + "sellMessageType": { "type": "object", + "description": "The SellMessagesType defines the standard attributes that will be retrieved with the sell message.", "properties": { - "accompanyGuests": { - "description": "List of guest names that are accompanying the reservation guest", - "$ref": "#/definitions/resAccompanyGuestListType" - }, - "address": { - "description": "Address information that is attached to the reservation guest", - "$ref": "#/definitions/addressSearchType" + "message": { + "description": "This is the message text.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "alternateFullName": { - "description": "Altername full display name", - "type": "string" + "croCode": { + "description": "This is the Central Reservation office code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "alternateGivenName": { - "description": "Alternate given name, first name or names", + "chainCode": { + "description": "This is the chain code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "alternateSurname": { - "description": "Alternate family name, last name.", + "hotelId": { + "description": "This is the hotel code or resort.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "anonymization": { - "description": "Provides information about the guest's anonymization status", - "$ref": "#/definitions/anonymizationType" + "roomType": { + "description": "This represents the room type code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "birthDate": { - "description": "Date of birth", + "ratePlanCode": { + "description": "This represents the rate plan code of the room type.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "email": { - "description": "Email address", - "$ref": "#/definitions/basicEmailType" + "languageCode": { + "description": "This is the language code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "externalInfo": { - "description": "External information about the guest associated with the reservation.", - "$ref": "#/definitions/resGuestExternalInfoType" + "stickyFlagYn": { + "description": "Flag which tells if this message is Sticky (Y/N).", + "type": "string", + "minLength": 0, + "maxLength": 1 }, - "fullName": { - "description": "Full display name", - "type": "string" + "usedInModule": { + "description": "This represents the correct moduletype which should be used for fetching SellMessages.", + "$ref": "#/definitions/usedInModuleType" }, - "givenName": { - "description": "Given name, first name or names", - "$ref": "#/definitions/givenNameType" + "beginDate": { + "description": "This is the Begin date for the configured SellMessage.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "guestLastStayInfo": { - "description": "Contains information regarding the last stay of this guest.", - "$ref": "#/definitions/guestLastStayInfoType" + "url": { + "description": "URL that identifies the location associated with the record identified by the UniqueID.", + "type": "string" }, - "guestRestricted": { - "description": "True indicates there are restrictions associated with the current profile.", - "type": "boolean" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "guestRestrictedCode": { - "description": "Guest profile restricted reason code", - "type": "string" + "instance": { + "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "guestRestrictedReasonDesc": { - "description": "Guest profile restricted reason description", - "type": "string" + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 }, "id": { "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "idExtension": { + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" + } + } + }, + "usedInModuleType": { + "type": "string", + "description": "Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control.", + "enum": [ + "Blocks", + "Reservations", + "FunctionDiary", + "LookToBookSales", + "GroupRoomsControl" + ] + }, + "currencyExchangeRatesType": { + "type": "array", + "description": "Exchange Rate information for a currency code.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/currencyExchangeRateType" + } + }, + "hotelContactsType": { + "type": "array", + "description": "Lists of contacts of the hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelContactType" + } + }, + "hotelContactType": { + "type": "object", + "description": "Contact identification details.", + "properties": { + "nameId": { + "description": "Contact or employee identifier..", + "$ref": "#/definitions/uniqueID_Type" }, - "membership": { - "description": "The Membership object identifying the frequent customer reward program.", - "$ref": "#/definitions/membershipInfoType" + "hotelId": { + "description": "The code of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "middleName": { - "description": "The middle name of the person name", + "name": { + "description": "Name of the hotel contact.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "namePrefix": { - "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)", - "$ref": "#/definitions/namePrefixType" + "roles": { + "description": "List of HotelContactType.", + "$ref": "#/definitions/hotelContactRolesType" }, - "nameSuffix": { - "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).", + "ownerCode": { + "description": "The contact's code in the hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "nameTitle": { - "description": "Degree or honors (e.g., Ph.D., M.D.)", + "communicationMethod": { + "description": "The preferred method of communication for the contact.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "nameType": { - "$ref": "#/definitions/nameTypeType" + "communicationAddress": { + "description": "Details about the preferred communication method. Example: email address, fax number, etc.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "nationality": { - "description": "Affiliation or ethnicity to a particular country.", - "$ref": "#/definitions/countryNameType" + "primary": { + "description": "Primary flag.", + "type": "boolean" + } + } + }, + "hotelContactRolesType": { + "type": "array", + "description": "Lists of HotelContactRoles of the hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelContactRoleType" + } + }, + "hotelContactRoleType": { + "type": "string", + "description": "The contact's role in the hotel. Possible values are Lead, General, and Contract.", + "enum": [ + "Lead", + "General", + "Contract" + ] + }, + "hotelEventSpacesType": { + "type": "object", + "description": "The Detail and Summary info of event space about the hotel", + "properties": { + "eventSpaceDetails": { + "description": "Even Space Detail information of the hotel.", + "$ref": "#/definitions/hotelEventSpaceDetailsType" }, - "phoneNumber": { - "description": "Phone number", - "$ref": "#/definitions/phoneNumberType" + "eventSpaceSummaries": { + "description": "Event Space Summary information of the hotel.", + "$ref": "#/definitions/hotelEventSpaceSummariesType" }, - "registrationCardNo": { - "description": "Unique identifier of the police registration card number.", + "setupStyles": { + "description": "List of hotel setup style codes of the hotel.", + "$ref": "#/definitions/hotelSetupStylesType" + } + } + }, + "hotelEventSpaceDetailsType": { + "type": "array", + "description": "List of detail info of hotel event space", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelEventSpaceDetailType" + } + }, + "hotelEventSpaceDetailType": { + "type": "object", + "description": "The detail info of hotel event space", + "properties": { + "code": { + "description": "The code of hotel event space.", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "surname": { - "description": "Family name, last name.", - "$ref": "#/definitions/surnameType" + "minLength": 0, + "maxLength": 20 }, - "surnamePrefix": { - "description": "e.g \"van der\", \"von\", \"de\"", + "description": { + "description": "Th description of the hotel event space", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "maxCapacity": { + "description": "Th max capacity of the hotel event space", + "type": "integer" + }, + "maxOccupancies": { + "description": "List of max occupancies of the event space based on the setup code.", + "$ref": "#/definitions/eventSpaceMaxOccupanciesType" + } + } + }, + "eventSpaceMaxOccupanciesType": { + "type": "array", + "description": "List of event space max occupancy.", + "maxItems": 5, + "items": { + "type": "integer" + } + }, + "hotelEventSpaceSummariesType": { + "type": "array", + "description": "List of summary info of hotel event space", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelEventSpaceSummaryType" + } + }, + "hotelEventSpaceSummaryType": { + "type": "object", + "description": "The summary info of hotel event space", + "properties": { + "no": { + "description": "The total event space number which has the same space type, max capacity and setup style.", + "type": "integer" + }, + "spaceType": { + "description": "The type of the event space", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 + }, + "maxCapacity": { + "description": "The max capacity of this event space group", + "type": "integer" }, - "vip": { - "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", - "$ref": "#/definitions/vIPType" + "maxOccupancies": { + "description": "List of max occupancies of the event space based on the setup code.", + "$ref": "#/definitions/eventSpaceMaxOccupanciesType" } } }, - "resHousekeepingType": { - "description": "Holds housekeeping turndown service information for the room.", + "hotelSetupStylesType": { + "type": "array", + "description": "List of event space setup style codes.", + "maxItems": 5, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "hotelNotesType": { + "type": "array", + "description": "List of Notes of the hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/commentInfoType" + } + }, + "hotelCorporateInformationsType": { "type": "object", + "description": "Corporate information details of the property", "properties": { - "expectedServiceTime": { - "description": "Expected Start Time for housekeeping task(s).", - "type": "string" - }, - "facilityTaskInfo": { - "description": "The facility task applicable for the current day. This will be information only and not used for any updates.", - "$ref": "#/definitions/facilityTaskType" + "brandCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "instructions": { - "description": "Turndown instructions for the room.", - "type": "string" + "hotelCategory": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "linenChange": { - "description": "Indicates if a linen change is necessary.", - "type": "boolean" + "businessUnit": { + "$ref": "#/definitions/primaryCodesType" }, - "roomStatus": { - "description": "Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.", - "$ref": "#/definitions/housekeepingRoomStatusType" + "departmentCode": { + "$ref": "#/definitions/primaryCodesType" }, - "serviceTime": { - "description": "This is the Turndown room service time.", - "type": "string", - "format": "date", - "maxLength": 8 + "division": { + "$ref": "#/definitions/primaryCodesType" }, - "turndownRequested": { - "description": "Indicates whether guest wants turndown facility or not.", - "type": "boolean" + "opertingUnit": { + "$ref": "#/definitions/primaryCodesType" } } }, - "resMobileNotificationsType": { - "description": "Contains the status of Room Ready and Key Ready messages.", + "primaryCodesType": { + "type": "array", + "description": "List of codes with primary flag", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/primaryCodeType" + } + }, + "primaryCodeType": { "type": "object", + "description": "Primary flag with code and description.", "properties": { - "checkoutMessageReceived": { - "description": "Indicates if the Mobile checkout message is received.", - "type": "boolean" - }, - "errorMessage": { - "description": "Error message when Mobile Notification has failed.", - "type": "string" - }, - "keyReady": { - "description": "Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED", - "$ref": "#/definitions/communicationStatusType" - }, - "requiresAction": { - "description": "Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout", + "primary": { "type": "boolean" }, - "roomReady": { - "description": "Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED", - "$ref": "#/definitions/communicationStatusType" + "codeDescription": { + "$ref": "#/definitions/codeDescriptionType" } } }, - "resPaymentCardType": { - "description": "Information on a credit card for the customer.", + "hotelAttractionsType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelAttractionType" + } + }, + "hotelAttractionType": { "type": "object", + "description": "Information about the attractions near the hotel.", "properties": { - "approvalAmountNeeded": { - "$ref": "#/definitions/currencyAmountType" - }, - "attachCreditCardToProfile": { - "description": "Attach the credit card to profile.", - "type": "boolean" - }, - "cardHolderName": { - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "cardId": { - "description": "credit card id", - "$ref": "#/definitions/uniqueID_Type" + "name": { + "description": "Attraction name for the hotel.", + "$ref": "#/definitions/translationTextType2000" }, - "cardNumber": { + "type": { + "description": "The type of the attraction.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 60 }, - "cardNumberLast4Digits": { + "class": { + "description": "The class of the attraction.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 60 }, - "cardNumberMasked": { + "generalDirections": { + "description": "Directions to the attraction from the hotel.", "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "cardOrToken": { - "description": "This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.", - "$ref": "#/definitions/cardNumberTypeType" - }, - "cardPresent": { - "description": "Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.", - "type": "boolean" + "minLength": 0, + "maxLength": 2000 }, - "cardType": { - "description": "Indicates the type of credit card from a defined list", - "$ref": "#/definitions/cardTypeType" + "relativePosition": { + "$ref": "#/definitions/relativePositionType" }, - "citId": { - "description": "Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.", - "type": "string", - "maxLength": 30, - "minLength": 0 + "address": { + "description": "Address of the attraction.", + "$ref": "#/definitions/addressType" }, - "currentAuthorizedAmount": { - "$ref": "#/definitions/currencyAmountType" + "website": { + "description": "Website for the attraction.", + "$ref": "#/definitions/uRLType" }, - "expirationDate": { - "description": "Expiration date of the credit card", + "priceRange": { + "description": "Price range for the attraction.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 40 }, - "expirationDateExpired": { - "type": "boolean" - }, - "expirationDateMasked": { - "description": "Masked Expiration date of the credit card", + "operationHours": { + "description": "Price range for the attraction.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "processing": { - "description": "This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.", - "$ref": "#/definitions/cardProcessingType" + "minLength": 0, + "maxLength": 20 }, - "swiped": { - "type": "boolean" + "displaySeq": { + "description": "Display sequence of the attraction.", + "type": "integer" }, - "userDefinedCardType": { - "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided", + "code": { "type": "string", - "maxLength": 2, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "resPeriodicFolioType": { - "description": "Information regarding periodic folios set on the reservation.", + "meetingRoomsType": { + "type": "array", + "description": "List of meeting rooms of the hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/meetingRoomType" + } + }, + "meetingRoomType": { "type": "object", + "description": "Information about the meeting rooms of the hotel.", "properties": { - "frequency": { - "description": "Frequency in number of days when folios should be printed for this reservation.", - "type": "integer" + "code": { + "description": "the code of the meeting room", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "lastFolioDate": { - "description": "Latest date when a folio was printed using the \"Periodic Batch Folios\" option", + "charge": { + "description": "The charge for the meeting room.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 40 }, - "lastSettlementDate": { - "description": "Latest date when a direct bill settlement was automatically done using the \"Direct Bill Batch Folios\" option.", + "description": { + "description": "A description of the meeting room.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 200 } } }, - "resPreConfiguredRoutingInstrType": { - "description": "Instruction to attach Pre-Configured Routing Instructions to a Reservation.", + "masterInfoType": { "type": "object", "properties": { - "authorizerInfo": { - "description": "The authorizer information for Promotion Code with attached Complimentary Routing", - "$ref": "#/definitions/authorizerInfoType" + "codeInfo": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeInfoType" + } }, - "profileType": { - "description": "Profile Type with attached Routing Instruction.", - "$ref": "#/definitions/resProfileTypeType" + "codeType": { + "$ref": "#/definitions/masterType" + } + } + }, + "codeInfoType": { + "type": "object", + "description": "", + "properties": { + "description": { + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "promotionCode": { - "description": "Promotion Code with attached Complimentary Routing.", + "addtionalCodeInfo": { + "$ref": "#/definitions/addtionalCodeInfoType" + }, + "hotelId": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "ratePlanCode": { - "description": "Rate Code with attached Routing Instruction.", + "code": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "resProfileTypeType": { + "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": [ - "Guest", - "Company", - "Group", - "TravelAgent", - "Source", - "ReservationContact", - "BillingContact", - "Addressee" + "LongDescription", + "ShortDescription" ] }, - "resRevenueBalanceType": { - "description": "Revenue and Balance Amount summary for the reservation.", + "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" + ] + }, + "airportsDetails": { "type": "object", + "description": "Response object for fetching airports configured for hotels.", "properties": { - "balance": { - "description": "Balance amount on the reservation.", - "$ref": "#/definitions/currencyAmountType" + "airports": { + "description": "Collection of airports.", + "$ref": "#/definitions/airportsType" }, - "compBalance": { - "description": "Comp Balance amount", - "$ref": "#/definitions/currencyAmountType" + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "foodAndBevRevenue": { - "description": "Food and Beverage Revenue generated by the reservation.", - "$ref": "#/definitions/currencyAmountType" + "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" }, - "nonRevenue": { - "description": "Total Non Revenue posted on the reservation.", - "$ref": "#/definitions/currencyAmountType" + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "otherRevenue": { - "description": "Other Revenue generated by the reservation.", - "$ref": "#/definitions/currencyAmountType" + "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" }, - "roomRevenue": { - "description": "Room Revenue generated by the reservation.", - "$ref": "#/definitions/currencyAmountType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "totalFixedCharge": { - "description": "Total Fixed Charges on the reservation.", - "$ref": "#/definitions/currencyAmountType" + "count": { + "description": "Total number of rows returned", + "type": "integer" }, - "totalPayment": { - "description": "Total payment received for the reservation.", - "$ref": "#/definitions/currencyAmountType" + "links": { + "$ref": "#/definitions/links" }, - "totalRevenue": { - "description": "Total Revenue generated by the reservation.", - "$ref": "#/definitions/currencyAmountType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "resSharedGuestInfoType": { - "description": "Contains information regarding the share reservation.", + "airportsType": { + "type": "array", + "description": "Airport details for a hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/airportType" + } + }, + "airportType": { "type": "object", + "description": "Base details of the airport.", "properties": { - "firstName": { - "description": "Given name, first name or names", - "type": "string" + "description": { + "description": "Description of the airport.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "fullName": { - "description": "String representation of the full name", - "type": "string" + "distance": { + "description": "Distance from the hotel to the airport.", + "type": "number" }, - "lastName": { - "description": "Family name, last name.", - "type": "string" + "distanceType": { + "description": "Unit of distance for the Distance measurement.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "profileId": { - "$ref": "#/definitions/profileId" + "drivingTime": { + "description": "Driving time from the hotel to the airport.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "direction": { + "description": "Direction of the airport in relation to the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "website": { + "description": "URL of the airport's website.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "transportationOptions": { + "description": "Transportation option available for the airport.", + "type": "array", + "maxItems": 8, + "items": { + "$ref": "#/definitions/transportationInfoType" + } + }, + "sequence": { + "description": "Sequence number for displaying the airport.", + "type": "integer" + }, + "code": { + "description": "Airport code identifying the airport.", + "type": "string", + "minLength": 0, + "maxLength": 3 + }, + "hotelId": { + "description": "Hotel code that the airport belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "resSharedGuestListType": { - "description": "Collection of shared guest reservations.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/resSharedGuestInfoType" + "airportsCriteria": { + "type": "object", + "description": "Request object for creating new airports for hotels.", + "properties": { + "airports": { + "description": "Collection of airports to be created.", + "$ref": "#/definitions/airportsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "reservationAllowedActionType": { - "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.", - "type": "string", - "enum": [ - "Cancel", - "Move", - "PreCharge", - "PostCharge", - "FacilitySchedule", - "Upsell", - "PreCheckIn", - "PostToNoShowCancel", - "NoShow", - "NameChange", - "Discount", - "EnrollToPrimaryMembership", - "EnrollInProgress" - ] + "airportsToBeChanged": { + "type": "object", + "description": "Request object for modifying airports for hotels.", + "properties": { + "airports": { + "description": "Collection of airports to be modified.", + "$ref": "#/definitions/airportsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } }, - "reservationAllowedActionsType": { - "description": "Allowed action.", - "type": "array", - "maxItems": 11, - "items": { - "$ref": "#/definitions/reservationAllowedActionType" + "alternateHotelsCriteria": { + "type": "object", + "description": "Request object for creating new Alternate Hotels for hotels.", + "properties": { + "alternateHotels": { + "description": "Collection of Alternate Hotels to be created.", + "$ref": "#/definitions/alternateHotelsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "alternateHotelsToBeChanged": { + "type": "object", + "description": "Request object for changing hotel Alternate Hotels for hotels.", + "properties": { + "alternateHotels": { + "description": "Collection of Alternate Hotels to be modified.", + "$ref": "#/definitions/alternateHotelsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "reservationBlockType": { - "description": "Key information about the block for a reservation.", + "amenitiesDetails": { "type": "object", + "description": "Response object for fetching amenities at the property level.", "properties": { - "blockIdList": { - "description": "Collection of unique block identifiers for the reservation.", - "$ref": "#/definitions/blockIdList" + "hotelAmenities": { + "description": "Collection of amenities specified at the property level.", + "$ref": "#/definitions/configHotelAmenitiesType" }, - "blockName": { - "description": "The Name of the block that is attached to the reservation.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "hotelId": { - "description": "This is the HotelCode of the Block.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "reservationDepositType": { - "description": "Reservation Deposit Type.", + "configHotelAmenitiesType": { + "type": "array", + "description": "This type holds a collection of amenities at the property level.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configHotelAmenityType" + } + }, + "configHotelAmenityType": { "type": "object", + "description": "Base details used for amenities.", "properties": { - "amountOwed": { - "description": "Deposit Amount Owed.", - "type": "number" + "description": { + "description": "The description about amenity of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "amountPaid": { - "description": "Deposit Amount Paid.", - "type": "number" + "comments": { + "description": "The comments about amenity of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "amountRequired": { - "description": "Deposit Amount Required.", + "featureCode": { + "description": "Specifies the feature code (aka amenity code).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "orderSequence": { + "description": "Display Order sequence.", "type": "number" }, - "dueDate": { - "description": "Deposit Due Date.", + "amenityType": { + "description": "The type of amenity (general or meeting) selected from the list of values.", + "$ref": "#/definitions/amenityTypeType" + }, + "beginDate": { + "description": "The date the amenity is scheduled to become active.", "type": "string", "format": "date", "maxLength": 8 }, - "hasOutstanding": { - "description": "Resolves whether reservation has outstanding deposit.", - "type": "boolean" + "endDate": { + "description": "The date the amenity is scheduled to become inactive.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "hasPaid": { - "description": "Resolves whether reservation has paid deposit.", - "type": "boolean" + "newAmenityCode": { + "description": "The new amenity code which is used in the change method.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "postingDate": { - "description": "Deposit Posting Date.", + "newBeginDate": { + "description": "The new date the amenity is scheduled to become active.", "type": "string", "format": "date", "maxLength": 8 + }, + "hours": { + "description": "The hours of operation of the amenity in the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "priceRange": { + "description": "The price range of the amenity in the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "hotelId": { + "description": "Specifies the hotel code for which the amenity is specified.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "reservationFolioWindowType": { - "description": "Folio window view which holds the set of folios for a reservation.", + "amenitiesCriteria": { "type": "object", + "description": "Request object for creating amenities at the property level.", "properties": { - "balance": { - "description": "Running balance of the window.", - "$ref": "#/definitions/currencyAmountType" - }, - "folioWindowNo": { - "type": "integer" + "hotelAmenities": { + "description": "Collection containing details of amenities specified at the property level.", + "$ref": "#/definitions/configHotelAmenitiesType" }, - "payeeInfo": { - "description": "The window's configured payee information.", - "$ref": "#/definitions/payeeInfoType" + "links": { + "$ref": "#/definitions/links" }, - "paymentMethod": { - "description": "Payment Method Type", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "reservationFolioWindowsType": { - "description": "Collection of reservation folio windows.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/reservationFolioWindowType" + "amenitiesToBeChanged": { + "type": "object", + "description": "Request object for changing amenities at the property level.", + "properties": { + "hotelAmenities": { + "description": "Collection containing details of amenities specified at the property level.", + "$ref": "#/definitions/configHotelAmenitiesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "reservationHistoryFutureInfoType": { - "description": "Information of History and Future Reservation details attached to Profiles.", + "attractionsDetails": { "type": "object", + "description": "Response object for information regarding attraction.", "properties": { - "futureList": { - "description": "Refer to Future list type document.", - "$ref": "#/definitions/futureListType" + "attractions": { + "description": "Collection of attractions and their information.", + "$ref": "#/definitions/attractionCodesType" }, - "historyList": { - "description": "Refer to History list type document.", - "$ref": "#/definitions/historyListType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "reservationIdList": { - "description": "Unique Id that references an object uniquely in the system.", + "attractionCodesType": { "type": "array", + "description": "Collection of hotel level alert codes with attached alert types.", "maxItems": 4000, "items": { - "$ref": "#/definitions/uniqueID_Type" + "$ref": "#/definitions/attractionCodeType" } }, - "reservationInfoType": { - "description": "The Reservation class contains the current reservation being created or altered.", + "attractionCodeType": { "type": "object", + "description": "Information about the attractions near the hotel.", "properties": { - "accessRestriction": { - "description": "Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.", - "$ref": "#/definitions/resAccessRestrictionType" - }, - "advanceCheckIn": { - "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", - "$ref": "#/definitions/advanceCheckInType" - }, - "allowMobileCheckout": { - "description": "Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.", - "type": "boolean" - }, - "allowMobileViewFolio": { - "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.", - "type": "boolean" - }, - "allowedActions": { - "description": "Collection of reservation allowed actions.", - "$ref": "#/definitions/reservationAllowedActionsType" - }, - "attachedProfiles": { - "description": "List of attached profiles", - "$ref": "#/definitions/resAttachedProfileListType" - }, - "cancellationInfo": { - "description": "Information regarding why reservation has been/was cancelled.", - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "date": { - "description": "Date when reservation was last cancelled.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "description": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - } - } - }, - "cashiering": { - "description": "Holds cashiering related information for the reservation.", - "$ref": "#/definitions/resCashieringType" - }, - "commissionPayoutTo": { - "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.", - "$ref": "#/definitions/commissionPayoutToType" - }, - "computedReservationStatus": { - "description": "Indicates the status of the reservation.", - "$ref": "#/definitions/pMS_ResStatusType" + "name": { + "description": "Attraction name for the hotel.", + "$ref": "#/definitions/translationTextType2000" }, - "createDateTime": { - "description": "Time stamp of the creation.", + "type": { + "description": "The type of the attraction.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 60 }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "class": { + "description": "The class of the attraction.", "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "deposit": { - "description": "Holds reservation deposit information.", - "$ref": "#/definitions/reservationDepositType" + "minLength": 0, + "maxLength": 60 }, - "displayColor": { - "description": "Color setting of the reservation.", + "generalDirections": { + "description": "Directions to the attraction from the hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "expectedServiceTime": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "relativePosition": { + "$ref": "#/definitions/relativePositionType" }, - "externalReferences": { - "description": "External Reference information for Reservation.", - "$ref": "#/definitions/externalReferencesType" + "address": { + "description": "Address of the attraction.", + "$ref": "#/definitions/addressType" }, - "guestPreferredCurrency": { - "description": "Currency code preferred by guest.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "website": { + "description": "Website for the attraction.", + "$ref": "#/definitions/uRLType" }, - "hotelId": { + "priceRange": { + "description": "Price range for the attraction.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "hotelInterfaceStatusList": { - "description": "Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/reservationInterfaceStatusType" - } + "minLength": 0, + "maxLength": 40 }, - "hotelName": { + "operationHours": { + "description": "Price range for the attraction.", "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "housekeeping": { - "description": "Information regarding housekeeping for this reservation.", - "$ref": "#/definitions/resHousekeepingType" + "minLength": 0, + "maxLength": 20 }, - "keyCount": { - "description": "Number of keys created for the reservation.", + "displaySeq": { + "description": "Display sequence of the attraction.", "type": "integer" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "code": { "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", + "region": { + "description": "The region in which this attraction is located.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 20 }, - "lastPrivacyPromptDate": { - "description": "Last Privacy Prompt Date", + "inactiveDate": { + "description": "The date the record was marked as inactive.", "type": "string", "format": "date", "maxLength": 8 }, - "mobileNotifications": { - "description": "Denotes the status of Room Ready, Key Ready messages.", - "$ref": "#/definitions/resMobileNotificationsType" - }, - "openFolio": { - "description": "Returns true when reservation has an open folio.", - "type": "boolean" + "latitude": { + "type": "number", + "minimum": -90, + "maximum": 90 }, - "optedForCommunication": { - "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.", - "type": "boolean" + "longitude": { + "description": "The longitude of the location from which the organism or observation was collected, expressed in decimal degrees. Positive values are East of the Greenwich Meridian, negative values are West of the Greenwich Meridian.", + "type": "number", + "minimum": -180, + "maximum": 180 }, - "paymentMethod": { - "description": "Payment Method.", + "hotelId": { + "description": "Hotel Code for attraction.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "attractionsCriteria": { + "type": "object", + "description": "Request object for creating a new group of attractions.", + "properties": { + "attractions": { + "description": "Group of attractions to be created.", + "$ref": "#/definitions/attractionCodesType" }, - "preRegistered": { - "description": "Defines if the reservation is pre-registered or not.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "attractionsToBeChanged": { + "type": "object", + "description": "Request object for modifying an existing attraction.", + "properties": { + "attractions": { + "description": "Attraction group to be changed.", + "$ref": "#/definitions/attractionCodesType" }, - "queue": { - "description": "Information about the time and duration this reservation was on Queue for Checkin.", - "$ref": "#/definitions/reservationQueueInformationType" + "links": { + "$ref": "#/definitions/links" }, - "reservationCommunication": { - "description": "Collection of reservation communication details.", - "$ref": "#/definitions/resCommunicationType" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "hotelContactsCriteria": { + "type": "object", + "description": "Request object for creating new Contacts for hotels.", + "properties": { + "hotelContacts": { + "description": "Collection of hotel contacts to be created.", + "$ref": "#/definitions/hotelContactsType" }, - "reservationFolioWindows": { - "description": "Collection of reservation folio windows.", - "$ref": "#/definitions/reservationFolioWindowsType" + "links": { + "$ref": "#/definitions/links" }, - "reservationGuest": { - "description": "Collection of guests associated with the reservation.", - "$ref": "#/definitions/resGuestInfoType" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "hotelContactsToBeChanged": { + "type": "object", + "description": "Request object for changing hotel Contacts for hotels.", + "properties": { + "hotelContacts": { + "description": "Collection of Contacts to be modified.", + "$ref": "#/definitions/hotelContactsType" }, - "reservationIdList": { - "description": "Unique identifiers for the reservation for both internal and external systems", - "$ref": "#/definitions/reservationIdList" + "links": { + "$ref": "#/definitions/links" }, - "reservationIndicators": { - "description": "Indicators of additional information attached to the reservation", - "$ref": "#/definitions/indicatorsType" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "countriesDetails": { + "type": "object", + "description": "Response object for fetching Countries.", + "properties": { + "countries": { + "description": "Collection of Countries.", + "$ref": "#/definitions/countriesType" }, - "reservationPaymentMethod": { - "description": "Payment method used for this reservation", - "$ref": "#/definitions/reservationPaymentMethodType" + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "reservationStatus": { - "description": "Indicates the status of the reservation.", - "$ref": "#/definitions/pMS_ResStatusType" + "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" }, - "revenuesAndBalances": { - "description": "Revenues and Balances Amount summary for the reservation.", - "$ref": "#/definitions/resRevenueBalanceType" + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "roomStatus": { - "description": "Current room status", - "$ref": "#/definitions/housekeepingRoomStatusType" + "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" }, - "roomStay": { - "description": "Collection of room stays.", - "$ref": "#/definitions/stayInfoType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "roomStayReservation": { - "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.", - "type": "boolean" + "count": { + "description": "Total number of rows returned", + "type": "integer" }, - "searchMatches": { - "description": "Super Search matching terms.", - "$ref": "#/definitions/searchMatchesType" + "links": { + "$ref": "#/definitions/links" }, - "sharedGuests": { - "description": "Collection of guests who share this reservation.", - "$ref": "#/definitions/resSharedGuestListType" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "countriesType": { + "type": "array", + "description": "Country details.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/countryType" + } + }, + "countryType": { + "type": "object", + "description": "Base details of the country.", + "properties": { + "name": { + "description": "Name for the country.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "sourceOfSale": { - "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", - "$ref": "#/definitions/sourceOfSaleType" + "statisticCode": { + "description": "Statistic code for the country.", + "type": "string", + "minLength": 0, + "maxLength": 3 }, - "specials": { - "description": "Set of reservation preferences which belongs to the Specials group.", + "guestAddressFormat": { + "description": "Guest Address format Codes for confirmation letter.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "taxType": { - "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", - "$ref": "#/definitions/taxTypeType" + "addressDoctorMode": { + "description": "Defines the mode used to invoke address doctor service.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "turndownInfo": { - "description": "Currency code preferred by guest.", - "$ref": "#/definitions/reservationTurndownInfoType" + "mainGroup": { + "description": "Main Group of Country. Used in statistic reports.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "waitlist": { - "description": "Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.", - "$ref": "#/definitions/waitlistResType" + "regionCode": { + "description": "Regin to which the Country belongs.", + "type": "string", + "minLength": 0, + "maxLength": 3 + }, + "isoCode": { + "description": "ISO standard code for country.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "isoName": { + "description": "ISO standard name for country.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "displaySequence": { + "description": "Sequence number for displaying the countries.", + "type": "number" + }, + "printSequence": { + "description": "Print Sequence number for report.", + "type": "number" }, - "walkInIndicator": { - "description": "When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.", + "displayFlag": { + "description": "Indicates if the country flag should be displayed.", "type": "boolean" }, - "welcomeOffer": { - "description": "This flag will determine wheather the reservation is eligible for Welcome Offer or not.", - "type": "boolean" + "countryCode": { + "description": "Country code identifying the country.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel code the country belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "reservationInterfaceStatusType": { - "description": "Hotel Interface Type for a reservation and status of the various services", + "countriesToBeChanged": { "type": "object", + "description": "Request object for modifying Countries for hotels.", "properties": { - "hotelInterface": { - "description": "Hotel interface information for the reservation", - "$ref": "#/definitions/hotelInterfaceType" + "countries": { + "description": "Collection of Countries to be modified.", + "$ref": "#/definitions/countriesType" }, - "interfaceRights": { - "description": "Contains a list of status/rights for the various services under this interface", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/interfaceRightsStatusType" - } + "links": { + "$ref": "#/definitions/links" }, - "roomExtension": { - "description": "Identifier for the room extension", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "reservationPaymentMethodType": { + "creditCardTypesDetails": { "type": "object", + "description": "Response object for fetching Credit Card Types.", "properties": { - "authorizationRule": { - "$ref": "#/definitions/authorizationRuleType" + "creditCardTypes": { + "description": "Collection of Credit Card Types.", + "$ref": "#/definitions/creditCardTypesType" }, - "balance": { - "$ref": "#/definitions/currencyAmountType" + "links": { + "$ref": "#/definitions/links" }, - "description": { + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "creditCardTypesType": { + "type": "array", + "description": "List of Credit Card Types.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/creditCardTypeType" + } + }, + "creditCardTypeType": { + "type": "object", + "description": "Contains Common Master configuration detail.", + "properties": { + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "emailFolioInfo": { - "description": "Information on an email for the customer.", - "type": "object", - "properties": { - "email": { - "description": "eMail deatils for the profile.", - "$ref": "#/definitions/emailType" - }, - "emailFolio": { - "type": "boolean" - }, - "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", - "maxLength": 80, - "minLength": 0 - }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 - } - } + "minLength": 0, + "maxLength": 40 }, - "folioView": { - "type": "integer" + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "paymentCard": { - "$ref": "#/definitions/resPaymentCardType" + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" }, - "paymentMethod": { + "hotelId": { + "description": "Hotel of the record.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "reservationProfileType": { + "creditCardTypesToBeChanged": { "type": "object", + "description": "Request object for changing Credit Card Types.", "properties": { - "profile": { - "description": "Provides detailed information regarding either a company or a customer profile.", - "$ref": "#/definitions/profileType" + "creditCardTypes": { + "description": "Credit Card Types to be changed.", + "$ref": "#/definitions/creditCardTypesType" }, - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", - "$ref": "#/definitions/profileIdList" + "links": { + "$ref": "#/definitions/links" }, - "reservationProfileType": { - "$ref": "#/definitions/resProfileTypeType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "reservationQueueInformationType": { - "description": "Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.", + "creditCardTypesCriteria": { "type": "object", + "description": "Request object for creating Credit Card Types.", "properties": { - "averageQueueTimeCurrentReservations": { - "description": "The average time, in seconds, of the reservations currently in queue.", - "type": "integer" - }, - "averageQueueTimeToCheckIn": { - "description": "The average time, in seconds, a reservation was on queue prior to Check-In.", - "type": "integer" - }, - "guestTextInfo": { - "description": "Information for the message sent to the user", - "$ref": "#/definitions/queueTextInfoType" - }, - "priority": { - "description": "The Queue Priority given to this reservation.", - "type": "integer" + "creditCardTypes": { + "description": "Credit Card Types to be created.", + "$ref": "#/definitions/creditCardTypesType" }, - "queueDate": { - "description": "The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.", - "type": "string", - "format": "date", - "maxLength": 8 + "links": { + "$ref": "#/definitions/links" }, - "timeSpan": { - "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.", - "type": "object", - "properties": { - "duration": { - "type": "string" - }, - "durationInSeconds": { - "description": "The total duration, in seconds, the reservation is on Queue.", - "type": "integer" - }, - "endDate": { - "type": "string", - "format": "date", - "maxLength": 8 - }, - "startDate": { - "type": "string", - "format": "date", - "maxLength": 8 - } - } + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "reservationStayHistoryFutureInfoType": { - "description": "Information of History and Future Reservation details attached to Profiles.", + "hotelDayTypeCodesDetails": { "type": "object", + "description": "Response object for fetching day type codes for a hotel.", "properties": { - "futureList": { - "description": "Refer to Future list type document.", - "$ref": "#/definitions/stayFutureListType" + "hotelDayTypeCodes": { + "description": "Collection of hotel level day type codes.", + "$ref": "#/definitions/hotelDayTypeCodesType" }, - "historyList": { - "description": "Refer to History list type document.", - "$ref": "#/definitions/stayHistoryListType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "reservationTaxTypeInfo": { - "description": "Provides information about the Tax Type.", + "hotelDayTypeCodesType": { + "type": "array", + "description": "Details for day type code at hotel level.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelDayTypeCodeType" + } + }, + "hotelDayTypeCodeType": { "type": "object", + "description": "Base structure for Day Type Code at both template and hotel levels.", "properties": { "code": { - "description": "Code of the Tax Type.", + "description": "Code of a Day Type.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "collectingAgentTax": { - "description": "A boolean flag for Collecting Agent Tax", - "type": "boolean" + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the Tax Type.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "hotelId": { - "description": "Code of the Hotel.", + "description": "Description of a Day Type.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 100 }, - "minimumLengthOfStay": { - "description": "Minimun Length of Stay.", - "type": "integer" + "multiplier": { + "description": "Value by which the rates will be multiplied on a day.", + "type": "number" }, - "printAutoAdjust": { - "description": "Print auto adjust information for this tax type on the tax exempt report.", - "type": "boolean" + "adder": { + "description": "Value that will be added to rate on a day.", + "type": "number" }, - "reportExemptDays": { - "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.", - "type": "integer" + "color": { + "description": "Color used to represent Day Type.", + "$ref": "#/definitions/colorType" }, - "reportTaxPercentage": { - "description": "Tax percentage. Only used for tax exempt report.", - "type": "number", - "maximum": 100, - "minimum": 0 + "sellSequence": { + "description": "Sell sequence for a Day Type.", + "type": "number" }, - "taxExemptNo": { - "description": "Tax exempt number on the profile.", + "hotel": { + "description": "Hotel code to which the Day Type is associated.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "reservationTurndownInfoType": { - "description": "Turndown information for a reservation", + "hotelDayTypeCodesToBeChanged": { "type": "object", + "description": "Request object for modifying day type codes for a hotel.", "properties": { - "allowed": { - "description": "Indicates if turndown is allowed or not", - "type": "boolean" + "hotelDayTypeCodes": { + "description": "Collection of hotel day type codes to be changed.", + "$ref": "#/definitions/hotelDayTypeCodesType" }, - "status": { - "description": "Indicates turndown status, values could be required, not required, completed", - "$ref": "#/definitions/turndownStatusType" - } - } - }, - "restaurantCategoryType": { - "description": "Simple type for Hotel Restaurant.", - "type": "string", - "enum": [ - "Restaurant", - "Retail" - ] - }, - "roomAmenitiesCriteria": { - "description": "Request object for creating Room Amenities.", - "type": "object", - "properties": { "links": { "$ref": "#/definitions/links" }, - "roomAmenities": { - "description": "Room Amenitiesto be created.", - "$ref": "#/definitions/roomAmenitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "roomAmenitiesDetails": { - "description": "Response object for fetching Room Amenities.", + "hotelDayTypeCodesCriteria": { "type": "object", + "description": "Request object for creating new day type codes for a hotel.", "properties": { + "hotelDayTypeCodes": { + "description": "Collection of hotel day type codes to be created.", + "$ref": "#/definitions/hotelDayTypeCodesType" + }, "links": { "$ref": "#/definitions/links" }, - "roomAmenities": { - "description": "Collection of Room Amenities.", - "$ref": "#/definitions/roomAmenitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "roomAmenitiesToBeChanged": { - "description": "Request object for changing Room Amenities.", + "setHotelEvents": { "type": "object", + "description": "Request object for setting hotel events for specified date range.", "properties": { + "hotelEvents": { + "description": "Collection of hotel calendar event entries to be created.", + "$ref": "#/definitions/hotelEventCodesType" + }, "links": { "$ref": "#/definitions/links" }, - "roomAmenities": { - "description": "Room Amenitiesto be changed.", - "$ref": "#/definitions/roomAmenitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "roomAmenitiesType": { - "description": "List of Room Amenities.", + "hotelEventCodesType": { "type": "array", + "description": "Collection of hotel events.", "maxItems": 4000, "items": { - "$ref": "#/definitions/roomAmenityType" + "$ref": "#/definitions/hotelEventCodeType" } }, - "roomAmenityType": { - "description": "Contains Common Master configuration detail.", + "hotelEventCodeType": { "type": "object", + "description": "Details of Event to be used to set events for a hotel.", "properties": { - "code": { - "description": "Common Master unique code.", + "hotelId": { + "description": "Code of the hotel for which the events are being set.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "eventCode": { + "description": "Event code selected.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "dateRange": { + "description": "Date Range with days of week where the range update has to be applied.", + "$ref": "#/definitions/timeSpanDaysOfWeekType" } } }, - "roomRateAvailReasonType": { - "description": "Indicates the Room Rate is not available due to unavailability of enough items for the rate code.", - "type": "string", - "enum": [ - "Available", - "Restricted", - "RestrictedDueToInventory", - "RestrictedDueToOccupancy", - "RestrictedDueToItemInventory" - ] - }, - "roomRateType": { + "hotelBrochureDetails": { "type": "object", + "description": "Response object for fetching Basic Property information.", "properties": { - "availability": { - "description": "Used to specify an availability status for the room rate. When available value could be either not specified or \"Available\".", - "$ref": "#/definitions/roomRateAvailReasonType" - }, - "awards": { - "description": "Membership Awards code applied on the reservation.", - "$ref": "#/definitions/resAwardsType" - }, - "barRanking": { - "description": "Best Available rates ranking.", - "type": "integer" - }, - "bogoDiscount": { - "description": "Indicates if the Rate Code has BOGO(Bye one Get one) indicator.", - "type": "boolean" - }, - "commissionAmount": { - "description": "Indicates commission amount used by the rate plan.", - "type": "integer" - }, - "commissionCode": { - "description": "Commission Code applicable for commission calculation for Travel Agent/Company.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "commissionPercentage": { - "description": "Indicates commission percentage used by the rate plan.", - "type": "integer" - }, - "commissionable": { - "description": "Indicates Commission is applicable for commission calculation for Travel Agent/Company.", - "type": "boolean" - }, - "complimentary": { - "description": "Indicates this reservation rate is complimentary.", - "type": "boolean" - }, - "credentialsRequired": { - "description": "If true, indicates that credentials is required to sell the rate code.", - "type": "boolean" - }, - "discountAllowed": { - "description": "Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.", - "type": "boolean" - }, - "end": { - "description": "The ending value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "fixedRate": { - "description": "Fixed Rate Indicator.", - "type": "boolean" - }, - "foreignExchange": { - "description": "Exchange Type information for the postings.", - "$ref": "#/definitions/foreignExchangeType" - }, - "guestCounts": { - "description": "A collection of Guest Counts associated with the room rate.", - "$ref": "#/definitions/guestCountsType" - }, - "houseUseOnly": { - "description": "Indicates this reservation is for House use.", - "type": "boolean" - }, - "inventoryLender": { - "description": "Indicates whether the room type inventory was taken from the allotment or House availability.", - "type": "string" - }, - "marketCode": { - "description": "The code that relates to the market being sold to (e.g., the corporate market, packages).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "marketCodeDescription": { - "description": "Description of the market code.", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "mealPlans": { - "description": "Meal plan codes for rate plan code.", - "$ref": "#/definitions/mealPlansType" - }, - "numberOfUnits": { - "description": "The number of rooms.", - "type": "integer" - }, - "packages": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/packageElementType" - } - }, - "promotionCode": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "pseudoRoom": { - "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.", - "type": "boolean" - }, - "rateDescription": { - "description": "Rate code description.", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "rateGroup": { - "description": "For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "rateLevel": { - "description": "Rate plan type like Corporate,Regular,Military,Weekend etc.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "ratePlanCode": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "rates": { - "$ref": "#/definitions/ratesType" - }, - "reservationBlock": { - "description": "Key information about the block for this reservation.", - "$ref": "#/definitions/reservationBlockType" - }, - "roomId": { - "description": "A string value representing the unique identification of a room.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "roomRateInfo": { - "description": "Information about the Room Rate Combination.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "roomType": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "roomTypeCharged": { - "description": "Room Type used for the Rate calculation.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "sourceCode": { - "description": "To specify where the business came from e.g. radio, newspaper ad, etc.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "sourceCodeDescription": { - "description": "Description of the source of business.", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "start": { - "description": "The starting value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "stayProfiles": { - "description": "Profile associated with the room Stay.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/reservationProfileType" - } - }, - "suppressRate": { - "type": "boolean" - }, - "taxFreeGuestCounts": { - "description": "A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.", - "$ref": "#/definitions/guestCountsType" - }, - "taxIncluded": { - "description": "If true, indicates if tax is included in the rate code.", - "type": "boolean" + "hotelBrochure": { + "$ref": "#/definitions/hotelBrochureType" }, - "total": { - "$ref": "#/definitions/totalType" + "links": { + "$ref": "#/definitions/links" }, - "totalPoints": { - "$ref": "#/definitions/pointsType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "roomStayType": { + "hotelBrochureType": { "type": "object", + "description": "Contains the basic configuration information about a Hotel.", "properties": { - "arrivalDate": { - "type": "string", - "format": "date" - }, - "availableUpsellOfferCount": { - "description": "Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request", - "type": "integer" - }, - "bookingMedium": { - "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "bookingMediumDescription": { - "description": "Description of the booking medium.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "currentRoomInfo": { - "description": "Room information of the reservation for the current day.", - "$ref": "#/definitions/currentRoomInfoType" - }, - "departureDate": { - "type": "string", - "format": "date" + "primaryDetails": { + "description": "Primary Information of the hotel.", + "type": "object", + "properties": { + "legalOwner": { + "description": "Legal owner of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } }, - "expectedTimes": { - "description": "The Expected Arrival and Departure Times.", - "$ref": "#/definitions/resExpectedTimesType" + "generalInformation": { + "description": "General Information of the hotel.", + "type": "object", + "properties": { + "hotelType": { + "description": "The type of the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomCount": { + "description": "The total number of rooms in the Hotel.", + "type": "integer" + }, + "bedCount": { + "description": "The total number of beds in the Hotel.", + "type": "integer" + }, + "floorCount": { + "description": "The total number of floors of the Hotel.", + "type": "integer" + }, + "checkInTime": { + "description": "The official check in time of the Hotel.", + "type": "string", + "format": "date-time" + }, + "checkOutTime": { + "description": "The official check out time of the Hotel.", + "type": "string", + "format": "date-time" + }, + "hotelInfoWebsite": { + "description": "URL where property information is located.", + "$ref": "#/definitions/uRLType" + }, + "longitude": { + "description": "Longitude of the hotel.", + "type": "number" + }, + "latitude": { + "description": "Latitude of the hotel.", + "type": "number" + }, + "baseLanguage": { + "description": "The base language of the Hotel.", + "$ref": "#/definitions/languageType" + } + } }, - "guarantee": { - "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.", - "$ref": "#/definitions/resGuaranteeType" + "accommodationDetails": { + "description": "Accommodation Details of the hotel.", + "type": "object", + "properties": { + "singleRooms": { + "description": "The number of Single Rooms of the Hotel.", + "type": "integer" + }, + "doubleRooms": { + "description": "The number of Double Rooms of the Hotel.", + "type": "integer" + }, + "twinRooms": { + "description": "The number of Twin Rooms of the Hotel.", + "type": "integer" + }, + "familyRooms": { + "description": "The number of Family Rooms of the Hotel.", + "type": "integer" + }, + "connectingRooms": { + "description": "The number of Connecting Rooms of the Hotel.", + "type": "integer" + }, + "accessibleRooms": { + "description": "The number of Accessible Rooms of the Hotel.", + "type": "integer" + }, + "nonSmokingRooms": { + "description": "The number of Non-Smoking Rooms of the Hotel.", + "type": "integer" + }, + "maxAdultsInFamilyRoom": { + "description": "Maximum Adults for Family Room Type.", + "type": "integer" + }, + "maxChildrenInFamilyRoom": { + "description": "Maximum Children for Family Room Type.", + "type": "integer" + }, + "guestRoomFloors": { + "description": "The total number of the Guest Room Floors.", + "type": "integer" + }, + "guestRoomElevators": { + "description": "The number of Guest Room Elevators.", + "type": "integer" + }, + "suites": { + "description": "The number of Suites of the Hotel.", + "type": "integer" + }, + "executiveFloorNo": { + "description": "The floor number of Executive Floors of the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "roomAmenties": { + "description": "The information about the Room Amenities.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "shopDescription": { + "description": "The Description of the shops in the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } }, - "guestCounts": { - "$ref": "#/definitions/guestCountsType" + "propertyControls": { + "description": "Property controls information configuration of the hotel.", + "type": "object", + "properties": { + "sellControls": { + "description": "The sell controls information configuration of the hotel.", + "type": "object", + "properties": { + "startDate": { + "description": "Date when the hotel become valid for use.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "description": "The end date of the hotel.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "hotelId": { + "description": "The hotel code.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "currencyFormatting": { + "description": "Currency Formatting information configuration of the hotel.", + "type": "object", + "properties": { + "currencyCode": { + "description": "The base currency code for this hotel..", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencyFormat": { + "description": "Format for the local currency.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "currencySymbol": { + "description": "Symbol to designate the default currency of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "decimalPositions": { + "description": "Number of decimal positions used for this currency type.", + "type": "integer" + } + } + }, + "cateringCurrencyFormatting": { + "description": "Catering Currency Formatting information configuration of the hotel.", + "type": "object", + "properties": { + "currencyCode": { + "description": "The base currency code for this hotel..", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencyFormat": { + "description": "Format for the local currency.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "dateTimeFormatting": { + "description": "Date Time Formatting information configuration of the hotel", + "type": "object", + "properties": { + "longDateFormat": { + "description": "Long date format of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "shortDateFormat": { + "description": "Short date format of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "timeFormat": { + "description": "Time format for the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "timeZoneRegion": { + "description": "Time zone region of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "applicationMode": { + "description": "Application Mode information configuration of the hotel.", + "type": "object", + "properties": { + "configurationMode": { + "description": "The hotel's configuration mode if applicable.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "countryMode": { + "description": "The hotel's country code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "expHotelCode": { + "description": "Hotel Code used for third party exports.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "touristNumber": { + "description": "The Tourist Number of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "mbsSupported": { + "description": "Indicates if the hotel uses MBS (Marriott Business Services).", + "type": "boolean" + } + } + } + } }, - "mobileNotifications": { - "description": "Denotes the status of Room Ready and Key Ready messages.", - "$ref": "#/definitions/resMobileNotificationsType" + "communication": { + "description": "Communication information of the hotel.", + "type": "object", + "properties": { + "phoneNumber": { + "description": "The direct dial phone number of the hotel.", + "$ref": "#/definitions/telephoneType" + }, + "tollFreeNumber": { + "description": "Toll free phone number of the hotel.", + "$ref": "#/definitions/telephoneType" + }, + "faxNumber": { + "description": "Fax phone number of the hotel.", + "$ref": "#/definitions/telephoneType" + }, + "emailAddress": { + "description": "Email address of the hotel.", + "$ref": "#/definitions/basicEmailType" + }, + "webPage": { + "description": "The web address of the hotel.", + "$ref": "#/definitions/uRLType" + } + } }, - "multiValueAttrs": { - "description": "Informative indicators indicating different values of an attribute exists over the stay.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "maxLength": 2000 + "address": { + "description": "Provides address information.", + "type": "object", + "properties": { + "isValidated": { + "description": "Indicator to define if the Address is validated by the Address Validation System.", + "type": "boolean" + }, + "addressLine": { + "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", + "type": "array", + "maxItems": 4, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 80 + } + }, + "cityName": { + "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "postalCode": { + "description": "Post Office Code number.", + "type": "string", + "minLength": 0, + "maxLength": 15 + }, + "cityExtension": { + "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "county": { + "description": "County or District Name (e.g., Fairfax). This is read only.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "state": { + "description": "State or Province name (e.g., Texas).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "country": { + "description": "Country name (e.g., Ireland).", + "$ref": "#/definitions/countryNameType" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "type": { + "description": "Defines the type of address (e.g. home, business, other).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "typeDescription": { + "description": "Describes the type code", + "type": "string" + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "updateReservations": { + "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.", + "type": "boolean" + }, + "barCode": { + "description": "The postal barcode for the address.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" + }, + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "regionCode": { + "description": "The region code of the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } } }, - "originalTimeSpan": { - "description": "The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.", - "$ref": "#/definitions/timeSpanType" + "hotelRestaurants": { + "description": "Names of restaurants which can be found in the Hotel.", + "$ref": "#/definitions/hotelRestaurantsType" }, - "ownerReservationType": { - "description": "Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation.", - "$ref": "#/definitions/ownerResTypeType" + "hotelRateRanges": { + "description": "The rate ranges which are offered by the hotels.", + "$ref": "#/definitions/hotelRateRangesType" }, - "primaryShareType": { - "description": "This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed.", - "$ref": "#/definitions/primaryShareTypeType" + "alternateHotels": { + "description": "Informations about alternative hotels provided by the Hotel.", + "$ref": "#/definitions/alternateHotelsType" }, - "printRate": { - "description": "This control whether rate info will be printed in confirmation letter.", - "type": "boolean" + "hotelContacts": { + "description": "The contacts information the hotels.", + "$ref": "#/definitions/hotelContactsType" }, - "promotion": { - "description": "Promotions applied to the reservation to get the promotional rate.", - "$ref": "#/definitions/promotionType" + "hotelEventSpaces": { + "description": "Even Space information of the hotel.", + "$ref": "#/definitions/hotelEventSpacesType" }, - "registrationNumber": { - "description": "Registration Number of the reservation for the current day.", - "$ref": "#/definitions/uniqueID_Type" + "hotelNotes": { + "description": "List of notes for the hotel.", + "$ref": "#/definitions/hotelNotesType" }, - "remoteCheckInAllowed": { - "description": "Indicates whether the reservation is pre-registered for internet check-in or not.", - "type": "boolean" + "hotelCorporateInformations": { + "$ref": "#/definitions/hotelCorporateInformationsType" }, - "roomNumberLocked": { - "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.", - "type": "boolean" + "attractions": { + "description": "List of Attractions for the hotel.", + "$ref": "#/definitions/hotelAttractionsType" }, - "roomRates": { - "description": "A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/roomRateType" - } + "meetingRooms": { + "description": "List of Meeting Rooms for the hotel.", + "$ref": "#/definitions/meetingRoomsType" }, - "suiteWith": { - "description": "Connecting Rooms.", + "chainCode": { + "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "total": { - "description": "The total amount charged for the Room Stay.", - "$ref": "#/definitions/totalType" - }, - "totalPoints": { - "description": "The total number of Points charged for the Room Stay.", - "$ref": "#/definitions/pointsType" + "minLength": 0, + "maxLength": 20 }, - "upsellInfo": { - "description": "Indicates Upsell Information to be applied on Reservation.", - "$ref": "#/definitions/upsellInfoType" - } - } - }, - "salesInfoType": { - "description": "Provides sales information about the profiles of type company, travel agent, source and contact.", - "type": "object", - "properties": { - "accountSource": { - "description": "Defines the account source.", + "hotelId": { + "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "accountType": { - "description": "Defines the account type.", + "hotelCityCode": { + "description": "The IATA city code; for example DCA, ORD.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "actionCode": { - "description": "Defines the action code.", + "hotelName": { + "description": "A text field used to communicate the proper name of the hotel.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "businessSegments": { - "description": "Defines the Business segments.", + "hotelCodeContext": { + "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "competitionCode": { - "description": "Defines the competition code.", + "chainName": { + "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "hotelId": { - "description": "Hotel Code used to filter the sales information.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "baseLanguage": { + "description": "The base language of the Hotel.", + "$ref": "#/definitions/languageType" }, - "industryCode": { - "description": "Defines the industry code.", + "currentTime": { + "description": "The time when login hotel brochure.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "influence": { - "description": "Defines the influence for the contact profile.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "hotelAttractions": { + "description": "Information about attractive places that can be found around the Hotel.", + "$ref": "#/definitions/hotelAttractionsType" }, - "preferredRoom": { - "description": "Defines the Preferred Room for profile.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "hotelPackages": { + "description": "Packages and offers offered by the Hotel.", + "$ref": "#/definitions/hotelPackagesType" }, - "priority": { - "description": "Defines the priority.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "hotelTransportations": { + "description": "List of different transportation companies around the Hotel.", + "$ref": "#/definitions/hotelTransportationsType" }, - "roomsPotential": { - "description": "Defines the rooms potential.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "hotelConferenceFacilities": { + "description": "Information about the conference rooms in the Hotel.", + "$ref": "#/definitions/hotelConferenceFacilitiesType" }, - "scope": { - "description": "Defines the scope.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "hotelFeatures": { + "description": "Lists of features provided by the Hotel", + "$ref": "#/definitions/hotelFeaturesType" }, - "scopeCity": { - "description": "Defines the scope city.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - } - } - }, - "searchMatchType": { - "description": "Search match indicating attribute and the matching value.", - "type": "object", - "properties": { - "attribute": { - "description": "Search match attribute.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "directions": { + "description": "Instructions and direction to help reaching the Hotel.", + "$ref": "#/definitions/directionsType" }, - "value": { - "description": "Search match value.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "generalNotes": { + "description": "General Notes provided about the Hotel.", + "$ref": "#/definitions/generalNotesType" + }, + "hotelAirports": { + "description": "Informations about different airports near by.", + "$ref": "#/definitions/hotelAirportsType" + }, + "hotelMiscellaneousInformation": { + "description": "General user defined information provided about the Hotel.", + "$ref": "#/definitions/hotelUserDefinedFieldsType" } } }, - "searchMatchesType": { - "description": "List of Generic Name-Value-Pair Parameters used for super search matches.", + "hotelPackagesType": { "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/searchMatchType" + "$ref": "#/definitions/hotelPackageType" } }, - "sellMessageType": { - "description": "The SellMessagesType defines the standard attributes that will be retrieved with the sell message.", + "hotelPackageType": { "type": "object", + "description": "Information about the packages of the hotel.", "properties": { + "packageName": { + "description": "The name of the package.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, "beginDate": { - "description": "This is the Begin date for the configured SellMessage.", + "description": "The begin date of the package.", "type": "string", "format": "date", "maxLength": 8 }, - "chainCode": { - "description": "This is the chain code.", + "endDate": { + "description": "The end date of the package.", "type": "string", - "maxLength": 20, - "minLength": 0 + "format": "date", + "maxLength": 8 }, - "croCode": { - "description": "This is the Central Reservation office code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "packagePrice": { + "description": "The price of the package.", + "type": "number" }, - "hotelId": { - "description": "This is the hotel code or resort.", + "rateCode": { + "description": "Indicates the rate code for the package.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "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", - "maxLength": 80, - "minLength": 0 + "pointsRequired": { + "description": "Indicates the required membership points for the package.", + "type": "number" }, - "idContext": { - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "packageCode": { "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "hotelTransportationsType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelTransportationType" + } + }, + "hotelTransportationType": { + "type": "object", + "description": "Information about the transportations of the hotel.", + "properties": { + "phoneNumber": { + "description": "The name of the package.", + "$ref": "#/definitions/telephoneType" }, - "idExtension": { - "description": "Additional identifying value assigned by the creating system.", - "type": "integer" + "relativePosition": { + "$ref": "#/definitions/relativePositionType" }, - "instance": { - "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", + "description": { + "description": "The description of the transportation.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 1000 }, - "languageCode": { - "description": "This is the language code.", + "comments": { + "description": "Comments about the transportation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "message": { - "description": "This is the message text.", + "priceRange": { + "description": "The price range of the transportation.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "ratePlanCode": { - "description": "This represents the rate plan code of the room type.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "website": { + "description": "Web address associated with transportation.", + "$ref": "#/definitions/uRLType" }, - "roomType": { - "description": "This represents the room type code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "keyOptions": { + "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", + "$ref": "#/definitions/codeListType" }, - "stickyFlagYn": { - "description": "Flag which tells if this message is Sticky (Y/N).", + "transportationCode": { "type": "string", - "maxLength": 1, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "label": { "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "url": { - "description": "URL that identifies the location associated with the record identified by the UniqueID.", - "type": "string" - }, - "usedInModule": { - "description": "This represents the correct moduletype which should be used for fetching SellMessages.", - "$ref": "#/definitions/usedInModuleType" - } - } - }, - "sellMessagesType": { - "description": "The SellMessagesType is the list of message and attributes returned by web service.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "sellMessage": { - "description": "This is the message text.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/sellMessageType" - } + "minLength": 0, + "maxLength": 1 }, - "totalResults": { - "description": "Total number of rows queried", + "orderBy": { "type": "integer" } } }, - "setDayTypes": { - "description": "Request object for setting day type for specified date range.", + "hotelConferenceFacilitiesType": { "type": "object", "properties": { - "hotelDayTypes": { - "description": "Collection of day type entries to be created for specified date range.", - "$ref": "#/definitions/hotelDayTypesType" - }, - "links": { - "$ref": "#/definitions/links" + "hotelBanquetSpace": { + "description": "Banquet Space of the hotel.", + "$ref": "#/definitions/hotelBanquetSpaceType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "hotelConferenceRooms": { + "description": "Conference Rooms of the Hotel.", + "$ref": "#/definitions/hotelConferenceRoomsType" } } }, - "setHotelEvents": { - "description": "Request object for setting hotel events for specified date range.", + "hotelBanquetSpaceType": { "type": "object", + "description": "Defines the Banquet and Meeting Area of the Hotel", "properties": { - "hotelEvents": { - "description": "Collection of hotel calendar event entries to be created.", - "$ref": "#/definitions/hotelEventCodesType" + "banquetSeats": { + "type": "integer" }, - "links": { - "$ref": "#/definitions/links" + "meetingRooms": { + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "shareDistributionInstructionType": { - "description": "The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -> Full Rate for each Sharer. SPLIT-> Split the Rate amount between Sharer Reservations. ENTIRE -> This Sharer will get the total amount of the rate code for all the Sharer Reservations.", - "type": "string", - "enum": [ - "Full", - "Entire", - "Split", - "CustomSplit" - ] - }, - "sourceOfSaleType": { - "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", - "type": "object", - "properties": { - "sourceCode": { - "description": "The entity/channel who made the reservation.", + "banquetArea": { + "description": "Defines the BanquetArea of the Hotel", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 50 }, - "sourceType": { - "description": "Type of entity/channel who made the reservation..", + "meetingArea": { + "description": "Defines the Meeting Area of the hotel", + "type": "number" + }, + "unitOfMeasureCode": { + "description": "The unit of measure in a code format.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "status": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "hotelConferenceRoomsType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelConferenceRoomType" } }, - "stayFutureListType": { - "description": "A collection of reservation history details attached to Profiles.", + "hotelConferenceRoomType": { "type": "object", + "description": "Information about the Conference rooms in the hotel.", "properties": { - "count": { - "description": "Total number of rows returned", - "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" + "roomName": { + "description": "The name of the Restaurant.", + "type": "string", + "minLength": 0, + "maxLength": 1000 }, - "reservationInfo": { - "description": "Additional reservation information attached to the profile . Eg : Future reservation details", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stayReservationInfoType" - } + "roomType": { + "description": "The Type of Restaurant.", + "type": "string", + "minLength": 0, + "maxLength": 1000 }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "roomCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "stayHistoryListType": { - "description": "A collection of reservation history details attached to Profiles.", - "type": "object", - "properties": { - "count": { - "description": "Total number of rows returned", - "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" - }, - "reservationInfo": { - "description": "Additional reservation information attached to the profile . Eg : History reservation details", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stayReservationInfoType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - } + "hotelFeaturesType": { + "type": "array", + "description": "Collection of Features in the Hotel", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelFeatureType" } }, - "stayInfoType": { - "description": "Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.", + "hotelFeatureType": { "type": "object", + "description": "Base details used for amenities.", "properties": { - "adultCount": { - "description": "A collection of Guest Counts associated with Room Stay.", - "type": "integer" - }, - "arrivalDate": { - "type": "string", - "format": "date" - }, - "assignedByAI": { - "description": "Represents the room was assigned by AI Room Assignment.", - "type": "boolean" - }, - "balance": { - "description": "Balance amount", - "$ref": "#/definitions/currencyAmountType" - }, - "bookingChannelCode": { - "description": "Booking channel code", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "childCount": { - "description": "A collection of Child Counts associated with Room Stay.", - "type": "integer" - }, - "compBalance": { - "description": "Comp Balance amount", - "$ref": "#/definitions/currencyAmountType" - }, - "componentRoomType": { - "description": "True indicates room type is a component type.", - "type": "boolean" - }, - "departureDate": { - "type": "string", - "format": "date" - }, - "depositPayments": { - "description": "A collection of deposit and/or payments for the Room Stay.", - "$ref": "#/definitions/currencyAmountType" - }, - "expectedTimes": { - "description": "The expected arrival, return and departure times of the guest.", - "$ref": "#/definitions/resExpectedTimesType" - }, - "fixedRate": { - "description": "True if the rate is a fixed rate, otherwise false", - "type": "boolean" - }, - "guarantee": { - "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.", - "$ref": "#/definitions/resGuaranteeType" - }, - "guestServiceStatus": { - "description": "Service Status of In House guest like DND or MUP", - "$ref": "#/definitions/guestHousekeepingServiceRequestType" - }, - "linkCode": { - "description": "Party code", + "description": { + "description": "The description about amenity of the hotel.", "type": "string", + "minLength": 0, "maxLength": 2000 }, - "marketCode": { - "description": "Market code", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "marketDescription": { - "description": "Description of Market code", + "comments": { + "description": "The comments about amenity of the hotel.", "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "numberOfRooms": { - "description": "Room Id", - "type": "integer" - }, - "originalTimeSpan": { - "description": "The Original Time Span covers the Room Stay dates of the original reservation.", - "$ref": "#/definitions/timeSpanType" - }, - "points": { - "description": "The Points contains the number of points used to book a particular room type.", - "$ref": "#/definitions/pointsType" - }, - "promotion": { - "description": "Promotion Codes", - "$ref": "#/definitions/promotionType" - }, - "pseudoRoom": { - "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.", - "type": "boolean" - }, - "rateAmount": { - "description": "Rate amount", - "$ref": "#/definitions/currencyAmountType" + "minLength": 0, + "maxLength": 2000 }, - "ratePlanCode": { - "description": "Rate plan code", + "featureCode": { + "description": "Specifies the feature code (aka amenity code).", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "rateSuppressed": { - "description": "Whether this rate should be suppressed from view", - "type": "boolean" - }, - "reservationBlock": { - "description": "Key information about the block for this reservation.", - "$ref": "#/definitions/reservationBlockType" + "minLength": 0, + "maxLength": 20 }, - "roomClass": { - "description": "Room class code", - "type": "string", - "maxLength": 20, - "minLength": 0 + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" }, - "roomId": { - "description": "Room Id", + "hours": { + "description": "The hours of operation of the amenity in the hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "roomNumberLocked": { - "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.", - "type": "boolean" + "minLength": 0, + "maxLength": 1000 }, - "roomType": { - "description": "Room type code", + "priceRange": { + "description": "The price range of the amenity in the hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "roomTypeCharged": { - "description": "Room type code that was charged", + "minLength": 0, + "maxLength": 40 + } + } + }, + "directionsType": { + "type": "array", + "description": "Collection of direction details to get into Hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/directionType" + } + }, + "directionType": { + "type": "object", + "description": "Direction details to get into Hotel.", + "properties": { + "description": { + "description": "Description about the Hotel direction.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 4000 }, - "scheduledCheckoutTime": { - "description": "Indicates that this reservation is scheduled for automated check out.", + "title": { + "description": "Title of Hotel direction.", "type": "string", - "format": "date" - }, - "sourceCode": { - "description": "Source of business", + "minLength": 0, + "maxLength": 200 + } + } + }, + "generalNotesType": { + "type": "array", + "description": "Collection of general notes about the Hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/generalNoteType" + } + }, + "generalNoteType": { + "type": "object", + "description": "General note/information about the Hotel.", + "properties": { + "note": { + "description": "The body of the note.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 4000 }, - "sourceCodeDescription": { - "description": "Description of the source of business.", + "title": { + "description": "The note's title.", "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "totalAmount": { - "description": "The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.", - "$ref": "#/definitions/currencyAmountType" - }, - "upgradedByAI": { - "description": "Represents the room was assigned by AI Room Assignment.", - "type": "boolean" + "minLength": 0, + "maxLength": 200 } } }, - "stayReservationInfoType": { - "description": "The Reservation class contains the current reservation being created or altered.", + "hotelAirportsType": { + "type": "array", + "description": "Collection of Airport details of the Hotel", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelAirportType" + } + }, + "hotelAirportType": { "type": "object", + "description": "Airport details of the Hotel", "properties": { - "attachedProfiles": { - "description": "List of attached profiles", - "$ref": "#/definitions/resAttachedProfileListType" + "description": { + "description": "Description of the airport", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "computedReservationStatus": { - "description": "Indicates the status of the reservation.", - "$ref": "#/definitions/pMS_ResStatusType" + "relativePosition": { + "$ref": "#/definitions/relativePositionType" }, - "hotelId": { + "direction": { + "description": "Directions from the airport to the Hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "reservationIdList": { - "description": "Unique identifiers for the reservation for both internal and external systems", - "$ref": "#/definitions/reservationIdList" + "transportationList": { + "description": "List of Transportation available from Airport to Hotel.", + "$ref": "#/definitions/transportationCodeListType" }, - "reservationStatus": { - "description": "Indicates the status of the reservation.", - "$ref": "#/definitions/pMS_ResStatusType" + "airportCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "roomStay": { - "description": "Collection of room stays.", - "$ref": "#/definitions/stayInfoType" + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" } } }, - "surnameType": { - "description": "Family name, last name.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "transportationCodeListType": { + "type": "array", + "description": "List of available transportations from airport to get into Hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/transportationCodeType" + } }, - "taxType": { - "description": "Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.", + "transportationCodeType": { "type": "object", + "description": "Transportation Code available from Airport to the Hotel.", "properties": { - "amount": { - "description": "A monetary amount.", - "type": "number" - }, "code": { - "description": "Code identifying the fee (e.g.,agency fee, municipality fee).", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "hotelUserDefinedFieldsType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelUserDefinedFieldType" + } + }, + "hotelUserDefinedFieldType": { + "type": "object", + "description": "User defined information(UDF) for the hotel.", + "properties": { + "category": { + "description": "The UDF Category for this information.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "currencyCode": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "infoType": { + "description": "The UDF Type for this information.", "type": "string", - "maxLength": 3, - "minLength": 3 + "minLength": 0, + "maxLength": 60 }, - "description": { + "information": { + "description": "The UDF attribute for this information.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 60 + } + } + }, + "hotelDetailsDetails": { + "type": "object", + "description": "Response object for fetching hotel details at the property level.", + "properties": { + "hotelDetails": { + "description": "Collection of hotel details specified at the property level.", + "$ref": "#/definitions/hotelDetailsType" }, - "type": { - "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).", - "$ref": "#/definitions/amountDeterminationType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "taxTypeType": { - "description": "Provides information about the Tax Type.", + "hotelDetailsType": { + "type": "array", + "description": "Collection of property level hotel details.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelDetailType" + } + }, + "hotelDetailType": { "type": "object", + "description": "Base details used for storing information about a hotel detail.", "properties": { "code": { - "description": "Code of the Tax Type.", + "description": "Specifies the hotel detail code.", "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "collectingAgentTax": { - "description": "A boolean flag for Collecting Agent Tax", - "type": "boolean" + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the Tax Type.", + "description": "Specifies the hotel detail description.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "hotelId": { - "description": "Code of the Hotel.", + "category": { + "description": "Specifies the hotel detail category.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "minimumLengthOfStay": { - "description": "Minimun Length of Stay.", + "sequence": { + "description": "Specifies the sorting sequence number for the hotel detail.", "type": "integer" }, - "printAutoAdjust": { - "description": "Print auto adjust information for this tax type on the tax exempt report.", - "type": "boolean" - }, - "reportExemptDays": { - "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.", - "type": "integer" + "hotelId": { + "description": "Specifies the hotel code of the hotel detail.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "reportTaxPercentage": { - "description": "Tax percentage. Only used for tax exempt report.", - "type": "number", - "maximum": 100, - "minimum": 0 + "hotelDetailValues": { + "description": "Collection of values which are associated with the hotel detail.", + "$ref": "#/definitions/hotelDetailValuesType" } } }, - "taxesType": { - "description": "A collection of taxes.", + "hotelDetailValuesType": { + "type": "array", + "description": "Collection of property level hotel detail values.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelDetailValueType" + } + }, + "hotelDetailValueType": { "type": "object", + "description": "This type holds the base information of the hotel detail value which will be associated with a hotel detail.", "properties": { - "amount": { - "description": "A monetary amount.", - "type": "number" + "code": { + "description": "Specifies the hotel detail value code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "currencyCode": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "description": { + "description": "Specifies the description of the hotel detail value.", "type": "string", - "maxLength": 3, - "minLength": 3 + "minLength": 0, + "maxLength": 200 }, - "tax": { - "description": "An individual tax.", - "type": "array", - "maxItems": 99, - "items": { - "$ref": "#/definitions/taxType" - } + "sequence": { + "description": "Specifies the sorting sequence number for the hotel detail value.", + "type": "integer" + }, + "newCode": { + "description": "Specifies the new hotel detail value code.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "telephoneBookCategoriesCriteria": { - "description": "Request object for Telephone Book Category.", + "jobTitlesDetails": { "type": "object", + "description": "Response object for fetching job titles configured for hotels.", "properties": { + "jobTitles": { + "description": "Collection of job titles.", + "$ref": "#/definitions/jobTitlesType" + }, "links": { "$ref": "#/definitions/links" }, - "telephoneCategories": { - "description": "Collection of telephone categories to create.", - "$ref": "#/definitions/telephoneCategoriesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "telephoneBookCategoriesDetails": { - "description": "Response object for fetch Telephone Categories.", + "jobTitlesType": { + "type": "array", + "description": "Job Title details for a hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/jobTitleType" + } + }, + "jobTitleType": { "type": "object", + "description": "Base details common between both template and hotel job titles.", "properties": { - "links": { - "$ref": "#/definitions/links" + "code": { + "description": "Job Title Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "telephoneCategories": { - "description": "Collection of telephone categories.", - "$ref": "#/definitions/telephoneCategoriesType" + "description": { + "description": "Description of the job title.", + "$ref": "#/definitions/translationTextType80" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "displayClosingScript": { + "description": "Flag to indicate if display reservation closing script.", + "type": "boolean" + }, + "hotelId": { + "description": "Property Code where the job title belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "telephoneBookCategoriesToBeChanged": { - "description": "Request object for Telephone Book Category.", + "translationTextType80": { "type": "object", + "description": "Contains Multiple translated texts and language codes.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "telephoneCategories": { - "description": "Collection of telephone categories to change.", - "$ref": "#/definitions/telephoneCategoriesType" + "defaultText": { + "description": "Default text with Character length from 0 to 80.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "translatedTexts": { + "description": "List of translated text and language codes.", + "$ref": "#/definitions/translationsTextType" } } }, - "telephoneBookEntriesCriteria": { - "description": "Request object for Telephone Book Entries.", + "jobTitlesCriteria": { "type": "object", + "description": "Request object for creating new job titles for hotels.", "properties": { + "jobTitles": { + "description": "Collection of job titles to be created.", + "$ref": "#/definitions/jobTitlesType" + }, "links": { "$ref": "#/definitions/links" }, - "telephoneBookEntries": { - "description": "Telephone Book Entries to be created.", - "$ref": "#/definitions/telephoneBookEntriesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "telephoneBookEntriesDetails": { - "description": "Response object for fetch Telephone Book Entries.", + "jobTitlesToBeChanged": { "type": "object", + "description": "Request object for modifying job titles for hotels.", "properties": { + "jobTitles": { + "description": "Collection of job titles to be modified.", + "$ref": "#/definitions/jobTitlesType" + }, "links": { "$ref": "#/definitions/links" }, - "telephoneBookEntries": { - "description": "Collection of telephone book entries.", - "$ref": "#/definitions/telephoneBookEntriesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "telephoneBookEntriesToBeChanged": { - "description": "Request object for Telephone Book Entries.", + "marketingCitiesDetails": { "type": "object", + "description": "Response object for fetching marketing cities configured for hotels.", "properties": { + "marketingCities": { + "description": "Collection of marketing cities.", + "$ref": "#/definitions/marketingCitiesType" + }, + "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" }, - "telephoneBookEntries": { - "description": "Telephone Book Entries to be changed.", - "$ref": "#/definitions/telephoneBookEntriesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "telephoneBookEntriesType": { - "description": "This type holds collection of Telephone Book Entries with complete information.", + "marketingCitiesType": { "type": "array", + "description": "Marketing city details for a hotel.", "maxItems": 4000, "items": { - "$ref": "#/definitions/telephoneBookEntryType" + "$ref": "#/definitions/marketingCityConfigType" } }, - "telephoneBookEntryType": { - "description": "This type definition of Telephone Book Entry Type.", + "marketingCityConfigType": { "type": "object", + "description": "Base details of the marketing city.", "properties": { - "category": { + "description": { + "description": "Description of the marketing city.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "categoryDescription": { + "distance": { + "description": "Distance from the hotel to the marketing city.", + "type": "number" + }, + "distanceType": { + "description": "Unit of distance for the Distance measurement.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "categorySequence": { - "type": "integer" + "drivingTime": { + "description": "Driving time from the hotel to the marketing city.", + "type": "string", + "minLength": 0, + "maxLength": 100 }, - "hotelId": { + "direction": { + "description": "Direction of the marketing city in relation to the hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "id": { - "$ref": "#/definitions/uniqueID_Type" + "sequence": { + "description": "Sequence number for displaying the marketing city.", + "type": "integer" }, - "name": { - "type": "string", - "maxLength": 200, - "minLength": 0 + "inactive": { + "description": "Flag to indicate whether the marketing city is inactive or not.", + "type": "boolean" }, - "remarks": { + "marketingCity": { + "description": "Marketing city code.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "telephone": { + "regionCode": { + "description": "Region that the marketing city belongs to.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "url": { + "hotelId": { + "description": "Hotel the marketing city belongs to.", "type": "string", - "maxLength": 1000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "telephoneCategoriesType": { - "description": "This type holds collection of Telephone Categories with complete information.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/telephoneCategoryType" - } - }, - "telephoneCategoryType": { - "description": "This type definition of Telephone Category Type.", + "marketingCitiesCriteria": { "type": "object", + "description": "Request object for creating new marketing cities for hotels.", "properties": { - "code": { - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "description": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "generic": { - "type": "boolean" + "marketingCities": { + "description": "Collection of marketing cities to be created.", + "$ref": "#/definitions/marketingCitiesType" }, - "hotelId": { - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "orderBy": { - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "telephoneInfoType": { - "description": "Information on a telephone number for the customer.", + "marketingCitiesToBeChanged": { "type": "object", + "description": "Request object for modifying marketing cities for hotels.", "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", - "maxLength": 80, - "minLength": 0 + "marketingCities": { + "description": "Collection of marketing cities to be modified.", + "$ref": "#/definitions/marketingCitiesType" }, - "telephone": { - "description": "Phone details for the profile.", - "$ref": "#/definitions/telephoneType" + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "telephoneType": { - "description": "Information on a telephone number for the customer.", + "hotelNotesCriteria": { "type": "object", + "description": "Request object for creating new Notes for the hotels", "properties": { - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "extension": { - "description": "Extension to reach a specific party at the phone number.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" - }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" - }, - "phoneNumber": { - "description": "Telephone number assigned to a single location.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "phoneTechType": { - "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "phoneUseType": { - "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "phoneUseTypeDescription": { - "description": "Description of the PhoneUseType code", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "hotelNotes": { + "description": "Collection of hotel notes to be created.", + "$ref": "#/definitions/hotelNotesType" }, - "primaryInd": { - "description": "When true, indicates a primary information.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "templateAirportType": { - "description": "Base details of the airport.", + "hotelNotesToBeChanged": { "type": "object", + "description": "Request object for changing hotel Notes for hotels.", "properties": { - "code": { - "description": "Airport code identifying the airport.", - "type": "string", - "maxLength": 3, - "minLength": 0 - }, - "description": { - "description": "Description of the airport.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "direction": { - "description": "Direction of the airport in relation to the hotel.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "distance": { - "description": "Distance from the hotel to the airport.", - "type": "number" - }, - "distanceType": { - "description": "Unit of distance for the Distance measurement.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "drivingTime": { - "description": "Driving time from the hotel to the airport.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "sequence": { - "description": "Sequence number for displaying the airport.", - "type": "integer" + "hotelNotes": { + "description": "Collection of Hotel Notes to be modified.", + "$ref": "#/definitions/hotelNotesType" }, - "transportationOptions": { - "description": "Transportation option available for the airport.", - "type": "array", - "maxItems": 8, - "items": { - "$ref": "#/definitions/transportationInfoType" - } + "links": { + "$ref": "#/definitions/links" }, - "website": { - "description": "URL of the airport's website.", - "type": "string", - "maxLength": 100, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "templateAirportsCriteria": { - "description": "Request object for creating new template airports.", + "operaHotelContextDetails": { "type": "object", + "description": "The result element returned with general hotel contextual information.", "properties": { + "hotelContext": { + "description": "A record containing hotel contextual information, stored as attributes.", + "type": "object", + "properties": { + "hotelId": { + "description": "The hotel code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelName": { + "description": "The hotel name.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "businessDate": { + "description": "The hotel's business date.", + "type": "string", + "format": "date" + }, + "configurationMode": { + "description": "The hotel's configuration mode if applicable.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "countryMode": { + "description": "The hotel's country code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "languageCode": { + "description": "The hotel's language code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencyCode": { + "description": "Provides the hotel's currency code.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "cateringCurrencyCode": { + "description": "Catering Currency Code, used when Catering Currency differs from base currency.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "checkInTime": { + "description": "The hotel's check-in time.", + "type": "string", + "format": "date" + }, + "checkOutTime": { + "description": "The hotel's check-out time.", + "type": "string", + "format": "date" + }, + "timezone": { + "description": "The hotel's timezone.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "loginUserId": { + "description": "The login user.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "chainCode": { + "description": "The hotel's chain code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, "links": { "$ref": "#/definitions/links" }, - "templateAirports": { - "description": "Collection of template airports to be created.", - "$ref": "#/definitions/templateAirportsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateAirportsDetails": { - "description": "Response object for fetching template airports.", + "hotelRateRangesCriteria": { "type": "object", + "description": "Request object for creating new Rate Ranges for hotels.", "properties": { + "hotelRateRanges": { + "description": "Collection of Rate Range to be created.", + "$ref": "#/definitions/hotelRateRangesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateAirports": { - "description": "Collection of template airports.", - "$ref": "#/definitions/templateAirportsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateAirportsToBeChanged": { - "description": "Request object for modifying template airports.", + "hotelRateRangesToBeChanged": { "type": "object", + "description": "Request object for changing hotel Rate Ranges for hotels.", "properties": { + "hotelRateRanges": { + "description": "Collection of Rate Ranges to be modified.", + "$ref": "#/definitions/hotelRateRangesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateAirports": { - "description": "Collection of template airports to be modified.", - "$ref": "#/definitions/templateAirportsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateAirportsType": { - "description": "Template airport details.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/templateAirportType" - } - }, - "templateAmenitiesCriteria": { - "description": "Request object for creating amenities at the template level.", + "hotelRestaurantsCriteria": { "type": "object", + "description": "Request object for creating new restaurants for hotels.", "properties": { + "hotelRestaurants": { + "description": "Collection of restaurants to be created.", + "$ref": "#/definitions/hotelRestaurantsType" + }, "links": { "$ref": "#/definitions/links" }, - "templateAmenities": { - "description": "Collection containing details of amenities specified at the template level.", - "$ref": "#/definitions/configTemplateAmenitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateAmenitiesDetails": { - "description": "Response object for fetching amenities at the template level.", + "hotelRestaurantsToBeChanged": { "type": "object", + "description": "Request object for changing hotel restaurants for hotels.", "properties": { + "hotelRestaurants": { + "description": "Collection of restaurants to be modified.", + "$ref": "#/definitions/hotelRestaurantsType" + }, "links": { "$ref": "#/definitions/links" }, - "templateAmenities": { - "description": "Collection of amenities specified at the template level.", - "$ref": "#/definitions/configTemplateAmenitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateAmenitiesToBeChanged": { - "description": "Request object for changing amenities at the template level.", + "telephoneBookCategoriesDetails": { "type": "object", + "description": "Response object for fetch Telephone Categories.", "properties": { + "telephoneCategories": { + "description": "Collection of telephone categories.", + "$ref": "#/definitions/telephoneCategoriesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateAmenities": { - "description": "Collection containing details of amenities specified at the template level.", - "$ref": "#/definitions/configTemplateAmenitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateCodeType": { - "description": "Contains Common Master configuration detail.", + "telephoneCategoriesType": { + "type": "array", + "description": "This type holds collection of Telephone Categories with complete information.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/telephoneCategoryType" + } + }, + "telephoneCategoryType": { "type": "object", + "description": "This type definition of Telephone Category Type.", "properties": { + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "code": { - "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "orderBy": { + "type": "integer" }, - "inactive": { - "description": "Determines whether this code is inactive or not.", + "generic": { "type": "boolean" } } }, - "templateCodesCriteria": { - "description": "Request object for creating Template Codes.", + "telephoneBookCategoriesCriteria": { "type": "object", + "description": "Request object for Telephone Book Category.", "properties": { + "telephoneCategories": { + "description": "Collection of telephone categories to create.", + "$ref": "#/definitions/telephoneCategoriesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateCodes": { - "description": "Template Codes to be created.", - "$ref": "#/definitions/templateCodesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateCodesDetails": { - "description": "Response object for fetching Template Codes.", + "telephoneBookCategoriesToBeChanged": { "type": "object", + "description": "Request object for Telephone Book Category.", "properties": { + "telephoneCategories": { + "description": "Collection of telephone categories to change.", + "$ref": "#/definitions/telephoneCategoriesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateCodes": { - "description": "Collection of Template Codes.", - "$ref": "#/definitions/templateCodesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateCodesToBeChanged": { - "description": "Request object for changing Template Codes.", + "telephoneBookEntriesDetails": { "type": "object", + "description": "Response object for fetch Telephone Book Entries.", "properties": { + "telephoneBookEntries": { + "description": "Collection of telephone book entries.", + "$ref": "#/definitions/telephoneBookEntriesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateCodes": { - "description": "Template Codes to be changed.", - "$ref": "#/definitions/templateCodesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateCodesType": { - "description": "List of Template Codes.", + "telephoneBookEntriesType": { "type": "array", + "description": "This type holds collection of Telephone Book Entries with complete information.", "maxItems": 4000, "items": { - "$ref": "#/definitions/templateCodeType" + "$ref": "#/definitions/telephoneBookEntryType" } }, - "templateCountriesCriteria": { - "description": "Request object for creating new template Countries.", + "telephoneBookEntryType": { + "type": "object", + "description": "This type definition of Telephone Book Entry Type.", + "properties": { + "id": { + "$ref": "#/definitions/uniqueID_Type" + }, + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "category": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "categorySequence": { + "type": "integer" + }, + "categoryDescription": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "name": { + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "telephone": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "url": { + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "remarks": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "telephoneBookEntriesCriteria": { "type": "object", + "description": "Request object for Telephone Book Entries.", "properties": { + "telephoneBookEntries": { + "description": "Telephone Book Entries to be created.", + "$ref": "#/definitions/telephoneBookEntriesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateCountries": { - "description": "Collection of template of Countries to be created.", - "$ref": "#/definitions/templateCountriesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateCountriesDetails": { - "description": "Response object for fetching template Countries.", + "telephoneBookEntriesToBeChanged": { "type": "object", + "description": "Request object for Telephone Book Entries.", "properties": { + "telephoneBookEntries": { + "description": "Telephone Book Entries to be changed.", + "$ref": "#/definitions/telephoneBookEntriesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateCountries": { - "description": "Collection of template Countries.", - "$ref": "#/definitions/templateCountriesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateCountriesToBeChanged": { - "description": "Request object for modifying template Countries.", + "transportationDetails": { "type": "object", + "description": "Response object for information regarding transportation.", "properties": { + "transportationList": { + "$ref": "#/definitions/transportationListType" + }, "links": { "$ref": "#/definitions/links" }, - "templateCountries": { - "description": "Collection of template of Countries to be modified.", - "$ref": "#/definitions/templateCountriesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateCountriesType": { - "description": "Template of country details.", + "transportationListType": { "type": "array", + "description": "Collection of hotel level transportation.", "maxItems": 4000, "items": { - "$ref": "#/definitions/templateCountryType" + "$ref": "#/definitions/transportationType" } }, - "templateCountryType": { - "description": "Base details of the country", + "transportationType": { "type": "object", + "description": "Information about the transportations of the hotel.", "properties": { - "addressDoctorMode": { - "description": "Defines the mode used to invoke address doctor service.", + "phoneNumber": { + "description": "The name of the package.", + "$ref": "#/definitions/telephoneType" + }, + "relativePosition": { + "$ref": "#/definitions/relativePositionType" + }, + "description": { + "description": "The description of the transportation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 1000 }, - "countryCode": { - "description": "Country code identifying the country.", + "comments": { + "description": "Comments about the transportation.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "displayFlag": { - "description": "Indicates if the country flag should be displayed.", - "type": "boolean" + "priceRange": { + "description": "The price range of the transportation.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "displaySequence": { - "description": "Sequence number for displaying the countries.", - "type": "number" + "website": { + "description": "Web address associated with transportation.", + "$ref": "#/definitions/uRLType" }, - "guestAddressFormat": { - "description": "Guest Address format Codes for confirmation letter.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "keyOptions": { + "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", + "$ref": "#/definitions/codeListType" }, - "isoCode": { - "description": "ISO standard code for country.", + "transportationCode": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "isoName": { - "description": "ISO standard name for country.", + "label": { "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "mainGroup": { - "description": "Main Group of Country. Used in statistic reports.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "orderBy": { + "type": "integer" }, - "name": { - "description": "Name for the country.", + "hotelId": { + "description": "Hotel code for the transportation.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + } + } + }, + "transportationCriteria": { + "type": "object", + "description": "Request object for creating transportation.", + "properties": { + "transportationList": { + "$ref": "#/definitions/transportationListType" }, - "printSequence": { - "description": "Print Sequence number for report.", - "type": "number" + "links": { + "$ref": "#/definitions/links" }, - "regionCode": { - "description": "Regin to which the Country belongs.", - "type": "string", - "maxLength": 3, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "transportationToBeChanged": { + "type": "object", + "description": "Request object for modifying transportation.", + "properties": { + "transportationList": { + "$ref": "#/definitions/transportationListType" }, - "statisticCode": { - "description": "Statistic code for the country.", - "type": "string", - "maxLength": 3, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "templateDayTypeCodeType": { - "description": "Base structure for Day Type Code at both template and hotel levels.", + "yieldAdjustmentCodesDetails": { "type": "object", + "description": "Response object for fetching Yield AdjustmentCodes configurations.", "properties": { - "adder": { - "description": "Value that will be added to rate on a day.", - "type": "number" + "yieldAdjustmentCodes": { + "description": "Collection of Yield AdjustmentCodes configurations.", + "$ref": "#/definitions/yieldAdjustmentCodesType" }, - "code": { - "description": "Code of a Day Type.", + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "yieldAdjustmentCodesType": { + "type": "array", + "description": "Holds Yield AdjustmentCodes details.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/yieldAdjustmentCodeType" + } + }, + "yieldAdjustmentCodeType": { + "type": "object", + "description": "Provides information about the Adjustment Codes.", + "properties": { + "hotelId": { + "description": "Code of the Hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "color": { - "description": "Color used to represent Day Type.", - "$ref": "#/definitions/colorType" + "code": { + "description": "Code of the Adjustment Codes.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of a Day Type.", + "description": "Description of the Adjustment Codes.", "type": "string", - "maxLength": 100, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "multiplier": { - "description": "Value by which the rates will be multiplied on a day.", - "type": "number" + "type": { + "description": "Yield Adjustment Type. e.g. Per Stay for ST", + "$ref": "#/definitions/yieldAdjustmentTypeType" }, - "sellSequence": { - "description": "Sell sequence for a Day Type.", + "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 } } }, - "templateDayTypeCodesCriteria": { - "description": "Request object for creating new template day type codes.", + "yieldAdjustmentTypeType": { + "type": "string", + "description": "Defines values for Yield Adjustment Types.", + "enum": [ + "PerStay", + "PerNight", + "PerPersonPerNight", + "PerPersonPerStay" + ] + }, + "yieldAdjustmentCodesCriteria": { "type": "object", + "description": "Request object for creating new Yield AdjustmentCodes Configurations.", "properties": { + "yieldAdjustmentCodes": { + "description": "Yield AdjustmentCodes Configurations to be created.", + "$ref": "#/definitions/yieldAdjustmentCodesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateDayTypeCodes": { - "description": "Collection of template day type codes to be created.", - "$ref": "#/definitions/templateDayTypeCodesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateDayTypeCodesDetails": { - "description": "Response object for fetching template day type codes.", + "yieldAdjustmentCodesToBeChanged": { "type": "object", + "description": "Request object for changing existing Yield AdjustmentCodes Configurations.", "properties": { + "yieldAdjustmentCodes": { + "description": "Yield AdjustmentCodes Configurations to be changed.", + "$ref": "#/definitions/yieldAdjustmentCodesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateDayTypeCodes": { - "description": "Collection of template level day type codes.", - "$ref": "#/definitions/templateDayTypeCodesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateDayTypeCodesToBeChanged": { - "description": "Request object for modifying template day type codes.", + "yieldCategoriesDetails": { "type": "object", + "description": "Response object for fetching Yield Category configurations.", "properties": { + "yieldCategories": { + "description": "Collection of Yield Category configurations.", + "$ref": "#/definitions/yieldCategoriesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateDayTypeCodes": { - "description": "Collection of template day type codes to be changed.", - "$ref": "#/definitions/templateDayTypeCodesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateDayTypeCodesType": { - "description": "Details for day type code at template level.", + "yieldCategoriesType": { "type": "array", + "description": "Holds Yield Category details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/templateDayTypeCodeType" + "$ref": "#/definitions/yieldCategoryType" } }, - "templateHotelDetailIDType": { - "description": "Base details used for uniquely identifying a hotel detail.", + "yieldCategoryType": { "type": "object", + "description": "Provides information about the Yield Category.", "properties": { - "category": { - "description": "Specifies the hotel detail category.", + "hotelId": { + "description": "Code of the Hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "code": { - "description": "Specifies the hotel detail code.", + "description": "Code of the Yield Category.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "Description of the Yield Category.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "yieldCategoriesCriteria": { + "type": "object", + "description": "Request object for creating new Yield Category Configurations.", + "properties": { + "hotelId": { + "description": "Code of the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "code": { + "description": "Code of the Yield Category.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "Description of the Yield Category.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "templateHotelDetailType": { - "description": "Base details used for storing information about a hotel detail.", + "yieldCategoriesToBeChanged": { "type": "object", + "description": "Request object for changing existing Yield Category Configurations.", "properties": { - "category": { - "description": "Specifies the hotel detail category.", + "hotelId": { + "description": "Code of the Hotel.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "code": { - "description": "Specifies the hotel detail code.", + "description": "Code of the Yield Category.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Specifies the hotel detail description.", + "description": "Description of the Yield Category.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "sequence": { - "description": "Specifies the sorting sequence number for the hotel detail.", - "type": "integer" + "links": { + "$ref": "#/definitions/links" }, - "templateHotelDetailValues": { - "description": "Collection of values which are associated with the hotel detail.", - "$ref": "#/definitions/templateHotelDetailValuesType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "templateHotelDetailValueType": { - "description": "This type holds the base information of the hotel detail value which will be associated with a hotel detail.", + "copyDepartments": { "type": "object", "properties": { - "code": { - "description": "Specifies the hotel detail value code.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "departments": { + "type": "array", + "description": "List of the departments to be copied.", + "items": { + "$ref": "#/definitions/copyConfigurationCodeType" + } }, - "description": { - "description": "Specifies the description of the hotel detail value.", - "type": "string", - "maxLength": 200, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "sequence": { - "description": "Specifies the sorting sequence number for the hotel detail value.", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "templateHotelDetailValuesType": { - "description": "Collection of template level hotel detail values.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/templateHotelDetailValueType" + "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 + } } }, - "templateHotelDetailsCriteria": { - "description": "Request object for creating hotel details at the template level.", + "copyYieldAdjustmentCodes": { "type": "object", "properties": { + "yieldAdjustmentCodes": { + "type": "array", + "description": "List of the Yield AdjustmentCodes to be copied.", + "items": { + "$ref": "#/definitions/copyConfigurationCodeType" + } + }, "links": { "$ref": "#/definitions/links" }, - "templateHotelDetails": { - "description": "Collection containing information of hotel details to be created at the template level.", - "$ref": "#/definitions/templateHotelDetailsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateHotelDetailsDetails": { - "description": "Response object for fetching hotel details at the template level.", + "copyYieldCategories": { "type": "object", "properties": { + "yieldCategories": { + "type": "array", + "description": "List of the Yield Category to be copied.", + "items": { + "$ref": "#/definitions/copyConfigurationCodeType" + } + }, "links": { "$ref": "#/definitions/links" }, - "templateHotelDetails": { - "description": "Collection of hotel details specified at the template level.", - "$ref": "#/definitions/templateHotelDetailsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateHotelDetailsIDType": { - "description": "Collection of template level hotel detail identifiers.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/templateHotelDetailIDType" - } - }, - "templateHotelDetailsToBeChanged": { - "description": "Request object for changing hotel details at the template level.", + "templateJobTitlesDetails": { "type": "object", + "description": "Response object for fetching template job titles.", "properties": { + "templateJobTitles": { + "description": "Collection of template job titles.", + "$ref": "#/definitions/templateJobTitlesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateHotelDetails": { - "description": "Collection containing information of hotel details to be changed at the template level.", - "$ref": "#/definitions/templateHotelDetailsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateHotelDetailsType": { - "description": "Collection of template level hotel details.", + "templateJobTitlesType": { "type": "array", + "description": "Template job title details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/templateHotelDetailType" + "$ref": "#/definitions/templateJobTitleType" } }, "templateJobTitleType": { - "description": "Base details common between both template and hotel job titles.", "type": "object", + "description": "Base details common between both template and hotel job titles.", "properties": { "code": { "description": "Job Title Code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { "description": "Description of the job title.", @@ -52573,132 +47745,186 @@ } }, "templateJobTitlesCriteria": { - "description": "Request object for creating new template job titles.", "type": "object", + "description": "Request object for creating new template job titles.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "templateJobTitles": { "description": "Collection of template job titles to be created.", "$ref": "#/definitions/templateJobTitlesType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateJobTitlesDetails": { - "description": "Response object for fetching template job titles.", + "templateJobTitlesToBeChanged": { "type": "object", + "description": "Request object for modifying template job titles.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, "templateJobTitles": { - "description": "Collection of template job titles.", + "description": "Collection of template job titles to be modified.", "$ref": "#/definitions/templateJobTitlesType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateJobTitlesToBeChanged": { - "description": "Request object for modifying template job titles.", + "languagesDetails": { "type": "object", + "description": "Response object for fetching languages.", "properties": { + "languages": { + "description": "Collection of languages.", + "$ref": "#/definitions/configLanguagesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateJobTitles": { - "description": "Collection of template job titles to be modified.", - "$ref": "#/definitions/templateJobTitlesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateJobTitlesType": { - "description": "Template job title details.", + "configLanguagesType": { "type": "array", + "description": "This type holds a collection of languages.", "maxItems": 4000, "items": { - "$ref": "#/definitions/templateJobTitleType" + "$ref": "#/definitions/configLanguageType" } }, - "templateMarketingCitiesCriteria": { - "description": "Request object for creating new template marketing cities.", + "configLanguageType": { "type": "object", + "description": "This gives detailed information about a language.", "properties": { - "links": { - "$ref": "#/definitions/links" + "description": { + "description": "Description gives the full text language name associated with the code.", + "$ref": "#/definitions/translationTextType50" }, - "templateMarketingCities": { - "description": "Collection of template marketing cities to be created.", - "$ref": "#/definitions/templateMarketingCitiesType" + "translationLanguageCode": { + "description": "Translation Language Code is required for the Translation Studio program to display language into which object has been translated.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "reportDateLanguage": { + "description": "Report Date Language if filled will represent correctly in the report language date elements that might be spelled out, like the day-of-week or the month.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "useAsAlternateLanguage": { + "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", + "type": "boolean" + }, + "locale": { + "description": "Geographic, political or cultural region.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "localeDescription": { + "description": "Description for the locale.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "languageCode": { + "description": "Language Code is a user definable code that identifies a language.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "templateMarketingCitiesDetails": { - "description": "Response object for fetching template marketing cities.", + "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" + } + } + }, + "languagesCriteria": { "type": "object", + "description": "Request object for creating new language records.", "properties": { + "languages": { + "description": "Collection containing details of languages to be created.", + "$ref": "#/definitions/configLanguagesType" + }, "links": { "$ref": "#/definitions/links" }, - "templateMarketingCities": { - "description": "Collection of template marketing cities.", - "$ref": "#/definitions/templateMarketingCitiesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateMarketingCitiesToBeChanged": { - "description": "Request object for modifying template marketing cities.", + "languagesToBeChanged": { "type": "object", + "description": "Request object for changing details of existing language records.", "properties": { + "languages": { + "description": "Collection containing details of languages to be changed.", + "$ref": "#/definitions/configLanguagesType" + }, "links": { "$ref": "#/definitions/links" }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "templateMarketingCitiesDetails": { + "type": "object", + "description": "Response object for fetching template marketing cities.", + "properties": { "templateMarketingCities": { - "description": "Collection of template marketing cities to be modified.", + "description": "Collection of template marketing cities.", "$ref": "#/definitions/templateMarketingCitiesType" }, + "links": { + "$ref": "#/definitions/links" + }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateMarketingCitiesType": { - "description": "Template marketing city details.", "type": "array", + "description": "Template marketing city details.", "maxItems": 4000, "items": { "$ref": "#/definitions/templateMarketingCityConfigType" } }, "templateMarketingCityConfigType": { - "description": "Base details of the marketing city.", "type": "object", + "description": "Base details of the marketing city.", "properties": { "description": { "description": "Description of the marketing city.", "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "direction": { - "description": "Direction of the marketing city in relation to the hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, "distance": { "description": "Distance from the hotel to the marketing city.", @@ -52707,14 +47933,24 @@ "distanceType": { "description": "Unit of distance for the Distance measurement.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "drivingTime": { "description": "Driving time from the hotel to the marketing city.", "type": "string", - "maxLength": 100, - "minLength": 0 + "minLength": 0, + "maxLength": 100 + }, + "direction": { + "description": "Direction of the marketing city in relation to the hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sequence": { + "description": "Sequence number for displaying the marketing city.", + "type": "integer" }, "inactive": { "description": "Flag to indicate whether the marketing city is inactive or not.", @@ -52723,753 +47959,756 @@ "marketingCity": { "description": "Marketing city code.", "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "newRegionCode": { - "description": "New region code to change the marketing city to. Template marketing cities allow editing of the region code. Because this is a key field we need to retain the original region code to locate the appropriate record to update. The original region code element is located in MarketingCityBaseType.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "regionCode": { "description": "Region that the marketing city belongs to.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "sequence": { - "description": "Sequence number for displaying the marketing city.", - "type": "integer" + "newRegionCode": { + "description": "New region code to change the marketing city to. Template marketing cities allow editing of the region code. Because this is a key field we need to retain the original region code to locate the appropriate record to update. The original region code element is located in MarketingCityBaseType.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "templateMarketingCityInfoType": { - "description": "Template marketing city details.", + "templateMarketingCitiesCriteria": { "type": "object", + "description": "Request object for creating new template marketing cities.", "properties": { - "marketingCity": { - "description": "Marketing city code.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "templateMarketingCities": { + "description": "Collection of template marketing cities to be created.", + "$ref": "#/definitions/templateMarketingCitiesType" }, - "regionCode": { - "description": "Region code the marketing city belongs to.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "tierAdministrationType": { - "description": "Do not upgrade membership. The membership may be downgraded.", - "type": "string", - "enum": [ - "Disabled", - "NoUpgrade" - ] - }, - "timeSpanDaysOfWeekType": { - "description": "Container for Time span with days of week.", + "copyMarketingCities": { "type": "object", + "description": "Request object for copying template marketing cities to hotel(s).", "properties": { - "friday": { - "type": "boolean" - }, - "monday": { - "type": "boolean" - }, - "saturday": { - "type": "boolean" - }, - "sunday": { - "type": "boolean" - }, - "thursday": { - "type": "boolean" - }, - "timeSpan": { - "$ref": "#/definitions/timeSpanType" + "copyInstructions": { + "description": "List of the template marketing city(s) to be copied to hotel(s).", + "$ref": "#/definitions/copyMarketingCitiesType" }, - "tuesday": { - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "wednesday": { - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "timeSpanType": { - "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.", + "copyMarketingCitiesType": { "type": "object", + "description": "Copy instructions for template marketing cities to hotel(s).", "properties": { - "duration": { - "type": "string" - }, - "endDate": { - "type": "string", - "format": "date", - "maxLength": 8 + "hotelCodes": { + "description": "Hotel codes to copy the marketing city templates to.", + "$ref": "#/definitions/codeListType" }, - "startDate": { - "type": "string", - "format": "date", - "maxLength": 8 + "templateMarketingCities": { + "description": "Marketing city template to be copied to the hotel(s).", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/templateMarketingCityInfoType" + } } } }, - "totalType": { - "description": "The total amount charged for the service including additional amounts and fees.", + "templateMarketingCityInfoType": { "type": "object", + "description": "Template marketing city details.", "properties": { - "amountAfterTax": { - "description": "The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).", - "type": "number" - }, - "amountBeforeTax": { - "description": "The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).", - "type": "number" - }, - "code": { - "description": "Type of charge.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "marketingCity": { + "description": "Marketing city code.", "type": "string", - "maxLength": 10, - "minLength": 0 - }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", - "type": "integer" + "minLength": 0, + "maxLength": 40 }, - "description": { + "regionCode": { + "description": "Region code the marketing city belongs to.", "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "fees": { - "description": "A collection of fees or service charges.", - "$ref": "#/definitions/feesType" - }, - "rateOverride": { - "description": "When true indicates that the rate amount has been overridden.", - "type": "boolean" - }, - "taxes": { - "description": "A collection of taxes.", - "$ref": "#/definitions/taxesType" + "minLength": 0, + "maxLength": 20 } } }, - "translationTextType2000": { - "description": "Contains Multiple translated texts and language codes.", + "templateMarketingCitiesToBeChanged": { "type": "object", + "description": "Request object for modifying template marketing cities.", "properties": { - "defaultText": { - "description": "Default text with Character length from 0 to 2000.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "templateMarketingCities": { + "description": "Collection of template marketing cities to be modified.", + "$ref": "#/definitions/templateMarketingCitiesType" }, - "translatedTexts": { - "description": "List of translated text and language codes.", - "$ref": "#/definitions/translationsTextType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "translationTextType30": { - "description": "Contains Multiple translated texts and language codes.", + "marketingCitiesByRegionDetails": { "type": "object", "properties": { - "defaultText": { - "description": "Default text with Character length from 0 to 30.", - "type": "string", - "maxLength": 30, - "minLength": 0 + "marketingCities": { + "$ref": "#/definitions/regionsType" }, - "translatedTexts": { - "description": "List of translated text and language codes.", - "$ref": "#/definitions/translationsTextType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "translationTextType50": { - "description": "Contains Multiple translated texts and language codes.", + "regionsType": { + "type": "array", + "description": "List of Regions.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/regionType" + } + }, + "regionType": { "type": "object", "properties": { - "defaultText": { - "description": "Default text with Character length from 0 to 50.", + "marketingCities": { + "description": "Marketing Cities under this Region.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/marketingCityType" + } + }, + "regionCode": { + "description": "Code of this Region.", "type": "string", - "maxLength": 50, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "translatedTexts": { - "description": "List of translated text and language codes.", - "$ref": "#/definitions/translationsTextType" + "description": { + "description": "Description of the Region", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "translationTextType80": { - "description": "Contains Multiple translated texts and language codes.", + "marketingCityType": { "type": "object", "properties": { - "defaultText": { - "description": "Default text with Character length from 0 to 80.", + "cityHotels": { + "description": "Hotels under this Marketing City.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/cityHotelInfoType" + } + }, + "marketingCity": { + "description": "Hotels under this Marketing City.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "translatedTexts": { - "description": "List of translated text and language codes.", - "$ref": "#/definitions/translationsTextType" + "description": { + "description": "Description of the Marketing City", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "translationsTextType": { - "description": "Language code for the translation.", - "type": "array", - "maxItems": 4000, - "items": { - "description": "Language code for the translation.", - "type": "object", - "properties": { - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "value": { - "description": "Used for Character Strings, length 0 to 2000.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - } + "cityHotelInfoType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Hotels under this Marketing City.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "name": { + "description": "Hotel Name for the Hotel Code.", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, - "transportationCodeListType": { - "description": "List of available transportations from airport to get into Hotel.", + "marketingRegionsDetails": { + "type": "object", + "description": "Response object for fetching Marketing Regions.", + "properties": { + "marketingRegions": { + "description": "Collection of Marketing Regions.", + "$ref": "#/definitions/marketingRegionsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "marketingRegionsType": { "type": "array", + "description": "List of Marketing Regions.", "maxItems": 4000, "items": { - "$ref": "#/definitions/transportationCodeType" + "$ref": "#/definitions/marketingRegionType" } }, - "transportationCodeType": { - "description": "Transportation Code available from Airport to the Hotel.", + "marketingRegionType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 + }, + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" + }, + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "transportationCriteria": { - "description": "Request object for creating transportation.", + "marketingRegionsCriteria": { "type": "object", + "description": "Request object for creating Marketing Regions.", "properties": { + "marketingRegions": { + "description": "Marketing Regionsto be created.", + "$ref": "#/definitions/marketingRegionsType" + }, "links": { "$ref": "#/definitions/links" }, - "transportationList": { - "$ref": "#/definitions/transportationListType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "transportationDetails": { - "description": "Response object for information regarding transportation.", + "marketingRegionsToBeChanged": { "type": "object", + "description": "Request object for changing Marketing Regions.", "properties": { + "marketingRegions": { + "description": "Marketing Regionsto be changed.", + "$ref": "#/definitions/marketingRegionsType" + }, "links": { "$ref": "#/definitions/links" }, - "transportationList": { - "$ref": "#/definitions/transportationListType" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "noteTypesDetails": { + "type": "object", + "description": "Response object for fetching Note Types of specific Notes Group.", + "properties": { + "noteTypes": { + "description": "Collection of Note Types.", + "$ref": "#/definitions/noteTypesType" + }, + "links": { + "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "transportationInfoType": { - "description": "Information about the transportation type.", + "noteTypesType": { + "type": "array", + "description": "Note Types Collection element.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/noteTypeType" + } + }, + "noteTypeType": { "type": "object", "properties": { + "noteGroup": { + "description": "Notes Group of the Note Types code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "code": { - "description": "Code for the transportation type.", + "description": "Code of the Note Types.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the transportation type.", + "description": "Description of the Note Types Code.", "type": "string", - "maxLength": 1000, - "minLength": 0 + "minLength": 0, + "maxLength": 100 }, - "label": { - "description": "Single character label for the transportation type.", + "notificationAreas": { + "description": "Display Sequence.", + "$ref": "#/definitions/codeListType" + }, + "displaySequence": { + "description": "Display Sequence.", + "type": "number" + }, + "inactive": { + "description": "Indicates if the Note Types Code is inactive.", + "type": "boolean" + }, + "internal": { + "description": "Indicates if the Note Types Code is internal.", + "type": "boolean" + }, + "overrideInternal": { + "description": "Indicates if the Note Types Code is override internal.", + "type": "boolean" + }, + "defaultNoteType": { + "description": "Indicates if the Note Types Code is default.", + "type": "boolean" + }, + "departmentNotes": { + "description": "Indicates if the Note Types Code has department notes.", + "type": "boolean" + }, + "globalAllowed": { + "description": "Indicates if the Note Types Code is globally allowed.", + "type": "boolean" + }, + "departments": { + "description": "Departments that can see Department Notes of the Note Types Code.", + "$ref": "#/definitions/genericHotelCodeCodeListType" + }, + "defaultText": { + "description": "Indicates if the Note Types Code has at least one default text defined.", + "type": "boolean" + }, + "defaultNoteText": { + "description": "Default Note Text if Note Type has default note.", "type": "string", - "maxLength": 1, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 + }, + "propertyDefaultNoteTexts": { + "description": "Collection of multiple Default Note Text for different Properties/Global for specific Note Type/Node Code.", + "$ref": "#/definitions/defaultNoteTextsDetailType" } - } + }, + "description": "Note Types Information Type." }, - "transportationListType": { - "description": "Collection of hotel level transportation.", + "genericHotelCodeCodeListType": { "type": "array", + "description": "List of HotelCode and Code combinations.", "maxItems": 4000, "items": { - "$ref": "#/definitions/transportationType" + "$ref": "#/definitions/genericHotelCodeCodeType" } }, - "transportationTemplatesCriteria": { - "description": "Request object for creating transportation templates.", + "genericHotelCodeCodeType": { "type": "object", + "description": "Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "transportationTemplates": { - "$ref": "#/definitions/transportationTemplatesType" + "hotelId": { + "description": "Hotel where the code is configured.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "code": { + "description": "Configuration code.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "transportationTemplatesDetails": { - "description": "Response object for fetching transportation templates.", + "defaultNoteTextsDetailType": { + "type": "array", + "description": "Collection of individual Default Note Text details.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/defaultNoteTextDetailType" + } + }, + "noteTypesCriteria": { "type": "object", + "description": "Request object for creating new Note Types.", "properties": { + "noteTypes": { + "description": "Note Types to be created.", + "$ref": "#/definitions/noteTypesType" + }, "links": { "$ref": "#/definitions/links" }, - "transportationTemplates": { - "$ref": "#/definitions/transportationTemplatesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "transportationTemplatesToBeChanged": { - "description": "Request object for modifying transportation templates.", + "noteTypesToBeChanged": { "type": "object", + "description": "Request object for changing existing Note Types.", "properties": { + "noteTypes": { + "description": "Note Types to be changed.", + "$ref": "#/definitions/noteTypesType" + }, "links": { "$ref": "#/definitions/links" }, - "transportationTemplates": { - "$ref": "#/definitions/transportationTemplatesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "transportationTemplatesType": { - "description": "Collection of transportation templates.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelTransportationType" - } - }, - "transportationToBeChanged": { - "description": "Request object for modifying transportation.", + "operaParametersDetails": { "type": "object", + "description": "The result element containing a collection of the requested application parameters.", "properties": { + "parameters": { + "description": "Represents a single application parameter and its value.", + "type": "array", + "items": { + "$ref": "#/definitions/applicationSettingSimpleType" + } + }, "links": { "$ref": "#/definitions/links" }, - "transportationList": { - "$ref": "#/definitions/transportationListType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "transportationType": { - "description": "Information about the transportations of the hotel.", + "applicationSettingSimpleType": { "type": "object", + "description": "Internal settings that is mainly used to get a quick information on the type.", "properties": { - "comments": { - "description": "Comments about the transportation.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "description": { - "description": "The description of the transportation.", - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "hotelId": { - "description": "Hotel code for the transportation.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "keyOptions": { - "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", - "$ref": "#/definitions/codeListType" + "configurations": { + "description": "This element is used for additional items (Key-Value-Pair) that has relevance to the operation.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/applicationSettingSimpleType" + } }, - "label": { + "name": { "type": "string", - "maxLength": 1, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "orderBy": { - "type": "integer" - }, - "phoneNumber": { - "description": "The name of the package.", - "$ref": "#/definitions/telephoneType" + "levelType": { + "$ref": "#/definitions/applicationSettingLevelType" }, - "priceRange": { - "description": "The price range of the transportation.", + "levelCode": { "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "relativePosition": { - "$ref": "#/definitions/relativePositionType" + "minLength": 0, + "maxLength": 20 }, - "transportationCode": { + "value": { "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "website": { - "description": "Web address associated with transportation.", - "$ref": "#/definitions/uRLType" + "minLength": 0, + "maxLength": 2000 } } }, - "turndownStatusType": { - "description": "Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.", + "applicationSettingLevelType": { "type": "string", "enum": [ - "Required", - "NotRequired", - "Compeleted" + "Global", + "Hotel", + "Cro" ] }, - "uRLInfoType": { - "description": "Web site address.", + "propertyDetailCategoriesDetails": { "type": "object", + "description": "Response object for fetching Property Detail Categories.", "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", - "maxLength": 80, - "minLength": 0 + "propertyDetailCategories": { + "description": "Collection of Property Detail Categories.", + "$ref": "#/definitions/propertyDetailCategoriesType" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "url": { - "description": "Provides URL information.", - "$ref": "#/definitions/uRLType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "uRLType": { - "description": "Web site address, in IETF(The Internet Engineering Task Force) specified format.", + "propertyDetailCategoriesType": { + "type": "array", + "description": "List of Property Detail Categories.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/propertyDetailCategoryType" + } + }, + "propertyDetailCategoryType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { - "orderSequence": { - "description": "Display Order sequence.", + "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" + } + } + }, + "propertyDetailCategoriesCriteria": { + "type": "object", + "description": "Request object for creating Property Detail Categories.", + "properties": { + "propertyDetailCategories": { + "description": "Property Detail Categories to be created.", + "$ref": "#/definitions/propertyDetailCategoriesType" }, - "primaryInd": { - "description": "When true, indicates a primary information.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "Defines the purpose of the URL address, such as personal, business, public, etc.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "propertyDetailCategoriesToBeChanged": { + "type": "object", + "description": "Request object for changing Property Detail Categories.", + "properties": { + "propertyDetailCategories": { + "description": "Property Detail Categories to be changed.", + "$ref": "#/definitions/propertyDetailCategoriesType" }, - "typeDescription": { - "description": "Describes the Type code", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "value": { - "description": "Property Value", - "type": "string" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "uniqueIDListType": { - "description": "Unique Id that references an object uniquely in the system.", + "propertyTypesDetails": { + "type": "object", + "description": "Response object for fetching Property Types.", + "properties": { + "propertyTypes": { + "description": "Collection of Property Types.", + "$ref": "#/definitions/propertyTypesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "propertyTypesType": { "type": "array", + "description": "List of Property Types.", "maxItems": 4000, "items": { - "$ref": "#/definitions/uniqueID_Type" + "$ref": "#/definitions/propertyTypeType" } }, - "uniqueID_Type": { - "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).", + "propertyTypeType": { "type": "object", + "description": "Contains Common Master configuration detail.", "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.", + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" + }, + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "upsellInfoType": { - "description": "Information regarding upsell for a reservation.", + "propertyTypesCriteria": { "type": "object", + "description": "Request object for creating Property Types.", "properties": { - "originalInfo": { - "description": "Original Values of the reservation prior to upgrade.", - "type": "object", - "properties": { - "nights": { - "description": "The number of nights of the reservation before being upgraded.", - "type": "integer" - }, - "rateCode": { - "description": "The Rate Code of the Reservation before it was upgraded", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "roomType": { - "description": "Original Reservation Room Type before being upgraded.", - "$ref": "#/definitions/codeDescriptionType" - }, - "totalAmount": { - "description": "Total Amount of the reservation before it was upgraded.", - "$ref": "#/definitions/currencyAmountType" - } - } + "propertyTypes": { + "description": "Property Typesto be created.", + "$ref": "#/definitions/propertyTypesType" }, - "upsellInfo": { - "description": "Information of a reservation during the process of upgrade.", - "type": "object", - "properties": { - "firstNightUpsellAmount": { - "description": "First Night Total Amount including Upsell.", - "$ref": "#/definitions/currencyAmountType" - }, - "firstNightUpsellCharge": { - "description": "First Night Upsell Charges.", - "$ref": "#/definitions/currencyAmountType" - }, - "percentageSavings": { - "description": "Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)", - "type": "number", - "maximum": 100, - "minimum": 0 - }, - "roomLongDescription": { - "description": "Detail description of the Room Type.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "roomType": { - "description": "Reservation Room Type for Upsell.", - "$ref": "#/definitions/codeDescriptionType" - }, - "ruleCode": { - "description": "Upsell rule code", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "ruleDescription": { - "description": "Upsell rule description", - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "ruleId": { - "description": "Upsell Rule Id.", - "type": "integer" - }, - "totalActualRateAmount": { - "description": "Actual Total Room Rate for the Target Upsell Room Type.", - "$ref": "#/definitions/currencyAmountType" - }, - "totalUpsellCharge": { - "description": "Amount that was charged for the upsell.", - "$ref": "#/definitions/currencyAmountType" - }, - "totalUpsellMoneyAmount": { - "description": "Total Amount that was charged including upsell.", - "$ref": "#/definitions/currencyAmountType" - }, - "totalUpsellPoints": { - "description": "Total Upsell Points.", - "type": "integer" - }, - "upsellDate": { - "description": "The date on which reservation is upgraded.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "upsellUser": { - "description": "User who upgraded the reservation.", - "type": "string", - "maxLength": 40, - "minLength": 0 - } - } + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "propertyTypesToBeChanged": { + "type": "object", + "description": "Request object for changing Property Types.", + "properties": { + "propertyTypes": { + "description": "Property Typesto be changed.", + "$ref": "#/definitions/propertyTypesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "usedInModuleType": { - "description": "Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control.", - "type": "string", - "enum": [ - "Blocks", - "Reservations", - "FunctionDiary", - "LookToBookSales", - "GroupRoomsControl" - ] - }, - "userDefinedFieldGroupDataType": { - "description": "Simple type used for User Defined Field Group Data Type.", - "type": "string", - "enum": [ - "Integer", - "Char" - ] - }, - "userDefinedFieldGroupType": { - "description": "Information representation of User Defined Field Group.", + "regionsCodeDetails": { "type": "object", + "description": "Response object for fetching Regions Code.", "properties": { - "dataLength": { - "description": "Length of field values of User Defined Field Group.", - "type": "number" + "regionsCode": { + "description": "Collection of Regions Code.", + "$ref": "#/definitions/regionsCodeType" }, - "dataType": { - "description": "The Data Type of User Defined Field Group(eg. Integer, Char and null).", - "$ref": "#/definitions/userDefinedFieldGroupDataType" + "links": { + "$ref": "#/definitions/links" }, - "description": { - "description": "The Description of User Defined Field Group.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "regionsCodeType": { + "type": "array", + "description": "List of Regions Code.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/regionCodeType" + } + }, + "regionCodeType": { + "type": "object", + "description": "Contains Common Master configuration detail.", + "properties": { + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "groupCode": { - "description": "The Code of User Defined Field Group.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "description": { + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "protected": { - "description": "Indicates that if the group could be deleted. This is a readonly element an it is only used in the fetch operation.", - "type": "boolean" + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" } } }, - "userDefinedFieldGroupsCriteria": { - "description": "Request object for creating User Defined Field Groups.", + "regionsCodeCriteria": { "type": "object", + "description": "Request object for creating Regions Code.", "properties": { + "regionsCode": { + "description": "Regions Code to be created.", + "$ref": "#/definitions/regionsCodeType" + }, "links": { "$ref": "#/definitions/links" }, - "userDefinedFieldGroups": { - "description": "User Defined Field Groups to be created.", - "$ref": "#/definitions/userDefinedFieldGroupsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "userDefinedFieldGroupsDetails": { - "description": "Response object for fetching User Defined Field Groups.", + "regionsCodeToBeChanged": { "type": "object", + "description": "Request object for changing Regions Code.", "properties": { + "regionsCode": { + "description": "Regions Code to be changed.", + "$ref": "#/definitions/regionsCodeType" + }, "links": { "$ref": "#/definitions/links" }, - "userDefinedFieldGroups": { - "description": "Collection of User Defined Field Groups.", - "$ref": "#/definitions/userDefinedFieldGroupsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "userDefinedFieldGroupsToBeChanged": { - "description": "Request object for changing User Defined Field Groups.", + "roomAmenitiesDetails": { "type": "object", + "description": "Response object for fetching Room Amenities.", "properties": { + "roomAmenities": { + "description": "Collection of Room Amenities.", + "$ref": "#/definitions/roomAmenitiesType" + }, "links": { "$ref": "#/definitions/links" }, - "userDefinedFieldGroups": { - "description": "User Defined Field Groups to be changed.", - "$ref": "#/definitions/userDefinedFieldGroupsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "userDefinedFieldGroupsType": { - "description": "A recurring element that identifies the User Defined Field Group.", + "roomAmenitiesType": { "type": "array", + "description": "List of Room Amenities.", "maxItems": 4000, "items": { - "$ref": "#/definitions/userDefinedFieldGroupType" + "$ref": "#/definitions/roomAmenityType" } }, - "userDefinedFieldValueType": { - "description": "Contains Common Master configuration detail.", + "roomAmenityType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { "description": "Description of the Master code.", @@ -53478,462 +48717,662 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" - }, - "groupCode": { - "description": "The group which the User Defined Field Value belongs to.", - "type": "string", - "maxLength": 40, - "minLength": 0 } } }, - "userDefinedFieldValuesCriteria": { - "description": "Request object for creating User Defined Field Values.", + "roomAmenitiesCriteria": { "type": "object", + "description": "Request object for creating Room Amenities.", "properties": { + "roomAmenities": { + "description": "Room Amenitiesto be created.", + "$ref": "#/definitions/roomAmenitiesType" + }, "links": { "$ref": "#/definitions/links" }, - "userDefinedFieldValues": { - "description": "User Defined Field Value to be created.", - "$ref": "#/definitions/userDefinedFieldValuesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "userDefinedFieldValuesDetails": { - "description": "Response object for fetching User Defined Field Values.", + "roomAmenitiesToBeChanged": { "type": "object", + "description": "Request object for changing Room Amenities.", "properties": { + "roomAmenities": { + "description": "Room Amenitiesto be changed.", + "$ref": "#/definitions/roomAmenitiesType" + }, "links": { "$ref": "#/definitions/links" }, - "userDefinedFieldValues": { - "description": "Collection of User Defined Field Values.", - "$ref": "#/definitions/userDefinedFieldValuesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "userDefinedFieldValuesToBeChanged": { - "description": "Request object for changing User Defined Field Values.", + "operaVersion": { "type": "object", + "description": "Response for Ping operation.", "properties": { + "operaVersion": { + "description": "Opera version number.", + "$ref": "#/definitions/operaVersionNumberType" + }, "links": { "$ref": "#/definitions/links" }, - "userDefinedFieldValues": { - "description": "User Defined Field Values to be changed.", - "$ref": "#/definitions/userDefinedFieldValuesType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "userDefinedFieldValuesType": { - "description": "A recurring element that identifies the User Defined Field Value.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/userDefinedFieldValueType" + "operaVersionNumberType": { + "type": "string", + "description": "Current Opera Version Number", + "minLength": 0, + "maxLength": 40 + }, + "operaSettingsDetails": { + "type": "object", + "description": "The result element containing the requested application settings.", + "properties": { + "activeFunctions": { + "description": "Count of active property services functions.", + "type": "integer" + }, + "groups": { + "description": "Contains a collection of application settings for a particular group.", + "type": "array", + "items": { + "$ref": "#/definitions/applicationSettingGroupType" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "userDefinedFieldsType": { - "description": "A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.", + "applicationSettingGroupType": { "type": "object", + "description": "This element simply groups the different Application Functions.", "properties": { - "characterUDFs": { - "description": "Collection of user defined fields of Character/String Type.", - "$ref": "#/definitions/characterUDFsType" + "appSettings": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/applicationSettingType" + } }, - "dateUDFs": { - "description": "Collection of user defined fields of Date Type.", - "$ref": "#/definitions/dateUDFsType" + "groupName": { + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "numericUDFs": { - "description": "Collection of user defined fields of Numeric Type.", - "$ref": "#/definitions/numericUDFsType" + "groupDisplayName": { + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, - "vIPType": { - "description": "The supplier's ranking of the customer.", + "applicationSettingType": { "type": "object", + "description": "Internal settings that can be of a certain valueType.", "properties": { - "vipCode": { - "description": "VIP Code.", + "shortDescription": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "vipDescription": { - "description": "VIP Description.", + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "wildCardMatch": { + "description": "A flag which indicate whether a wild card search should be made.", + "type": "boolean" + }, + "name": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "displayName": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "type": { + "$ref": "#/definitions/applicationSettingTypeType" + }, + "hotelId": { + "description": "Each configuration item will come with a HotelCode which will help the configuration to specify what context the update has to be. Eg. _Global,ORS,'CRO', etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sequence": { + "type": "number" + }, + "editAllowed": { + "type": "boolean" + }, + "value": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "scope": { + "type": "string", + "enum": [ + "P", + "G", + "Ch", + "C" + ] + }, + "valueType": { + "type": "string", + "enum": [ + "Yn", + "Integer", + "String", + "SingleSelectLov", + "MultiSelectLov", + "ShuttleLov", + "Custom", + "Double", + "Secure" + ] + }, + "conversionType": { + "description": "Represents whether the value is OXI Parameter or Conversion code default.", + "$ref": "#/definitions/applicationSettingConversionType" + }, + "settings": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/baseApplicationSettingType" + } + }, + "levelType": { + "$ref": "#/definitions/applicationSettingLevelType" + }, + "levelCode": { "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "subscriptionCountEligible": { + "description": "Indicates if this OPERA Setting is part of subscription count.", + "type": "boolean" } } }, - "waitlistResType": { - "description": "Information regarding why reservation is being /has been waitlisted.", + "applicationSettingTypeType": { + "type": "string", + "enum": [ + "Function", + "Parameter", + "Setting" + ] + }, + "applicationSettingConversionType": { + "type": "string", + "enum": [ + "Default", + "Parameter" + ] + }, + "baseApplicationSettingType": { "type": "object", + "description": "Internal settings that can be of a certain valueType.", "properties": { + "shortDescription": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, "description": { - "description": "Description why the reservation is being /has been waitlisted.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "priorityCode": { - "description": "Waitlist Priority Code.", + "wildCardMatch": { + "description": "A flag which indicate whether a wild card search should be made.", + "type": "boolean" + }, + "name": { "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "priorityDescription": { - "description": "Waitlist priority Description.", + "displayName": { "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 80 }, - "reasonCode": { - "description": "Waitlist Reason Code.", + "type": { + "$ref": "#/definitions/applicationSettingTypeType" + }, + "hotelId": { + "description": "Each configuration item will come with a HotelCode which will help the configuration to specify what context the update has to be. Eg. _Global,ORS,'CRO', etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sequence": { + "type": "number" + }, + "editAllowed": { + "type": "boolean" + }, + "value": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "scope": { + "type": "string", + "enum": [ + "P", + "G", + "Ch", + "C" + ] + }, + "valueType": { + "type": "string", + "enum": [ + "Yn", + "Integer", + "String", + "SingleSelectLov", + "MultiSelectLov", + "ShuttleLov", + "Custom", + "Double", + "Secure" + ] + }, + "conversionType": { + "description": "Represents whether the value is OXI Parameter or Conversion code default.", + "$ref": "#/definitions/applicationSettingConversionType" + }, + "subscriptionCountEligible": { + "description": "Indicator if the function does not count against the OPERA Control function count limit or not.", + "type": "boolean" + } + } + }, + "templateCodesDetails": { + "type": "object", + "description": "Response object for fetching Template Codes.", + "properties": { + "templateCodes": { + "description": "Collection of Template Codes.", + "$ref": "#/definitions/templateCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "templateCodesType": { + "type": "array", + "description": "List of Template Codes.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/templateCodeType" + } + }, + "templateCodeType": { + "type": "object", + "description": "Contains Common Master configuration detail.", + "properties": { + "code": { + "description": "Common Master unique code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "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" + } + } + }, + "templateCodesCriteria": { + "type": "object", + "description": "Request object for creating Template Codes.", + "properties": { + "templateCodes": { + "description": "Template Codes to be created.", + "$ref": "#/definitions/templateCodesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "copyTemplateCodes": { + "type": "object", + "properties": { + "templateName": { + "description": "Template name to be copied.", + "$ref": "#/definitions/copyTemplateType" + }, + "codes": { + "description": "List of template codes to be copied.", + "$ref": "#/definitions/codeListType" + }, + "hotelCodes": { + "description": "List of hotel codes for which the template needs to be copied.", + "$ref": "#/definitions/hotelCodeListType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "copyTemplateType": { + "type": "string", + "description": "Template name for template copy operation. Eg: RateCategory", + "enum": [ + "RateCategory", + "PromotionCode", + "RateClass", + "DepositPolicy", + "CancellationPolicy", + "GuaranteeCode", + "MarketCode", + "MarketGroup", + "SourceCode", + "SourceGroup", + "RoomType", + "RoomClass", + "CustomNumbers", + "AlertCode", + "AttractionCode", + "Transportation", + "RoomCondition", + "RateSeason", + "Amenity", + "TransactionCode", + "CompTransactionCode", + "PkgForecastGroup", + "RoomMaintenance", + "DayTypeCode", + "TurnawayCodes", + "EventCode", + "MessageCode", + "Airport", + "OutOfService", + "Floor", + "TransactionGroup", + "LocatorCode", + "RoomFeatures", + "JobTitle", + "DeviceLocations", + "ShiftDropLocations", + "HousekeepingTasks", + "HousekeepingRoomSchedules" + ] + }, + "hotelCodeListType": { + "type": "array", + "description": "Hotel code.", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "templateCodesToBeChanged": { + "type": "object", + "description": "Request object for changing Template Codes.", + "properties": { + "templateCodes": { + "description": "Template Codes to be changed.", + "$ref": "#/definitions/templateCodesType" }, - "reasonDescription": { - "description": "Waitlist Reason Description.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "telephone": { - "description": "Guest telephone number.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "warningType": { - "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", + "transportationTemplatesDetails": { "type": "object", + "description": "Response object for fetching transportation templates.", "properties": { - "code": { - "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "docURL": { - "description": "If present, this URL refers to an online description of the error that occurred.", - "type": "string", - "maxLength": 2000 - }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "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 - }, - "rph": { - "description": "Reference Place Holder used as an index for this warning.", - "type": "string", - "maxLength": 8, - "minLength": 1 - }, - "shortText": { - "description": "An abbreviated version of the error in textual format.", - "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 + "transportationTemplates": { + "$ref": "#/definitions/transportationTemplatesType" }, - "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", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "value": { - "description": "Property Value", - "type": "string" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "warningsType": { - "description": "Used in conjunction with the Success element to define a business error.", + "transportationTemplatesType": { "type": "array", + "description": "Collection of transportation templates.", "maxItems": 4000, "items": { - "$ref": "#/definitions/warningType" + "$ref": "#/definitions/hotelTransportationType" } }, - "webUserAccountType": { - "description": "Web User Account of the guest.", + "transportationTemplatesCriteria": { "type": "object", + "description": "Request object for creating transportation templates.", "properties": { - "autoGeneratePassword": { - "description": "A flag which determines if the password is auto generated.", - "type": "boolean" - }, - "comments": { - "description": "Comments.", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "domainCode": { - "description": "Domain code.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "history": { - "description": "Web User Account History.", - "$ref": "#/definitions/webUserHistoryType" - }, - "inactive": { - "description": "Boolean flag that indicates whether the web account is inactive or not.", - "type": "boolean" + "transportationTemplates": { + "$ref": "#/definitions/transportationTemplatesType" }, - "locked": { - "description": "Boolean flag that indicates whether the web account is locked or not.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "loginName": { - "description": "Login Name of the guest.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "transportationTemplatesToBeChanged": { + "type": "object", + "description": "Request object for modifying transportation templates.", + "properties": { + "transportationTemplates": { + "$ref": "#/definitions/transportationTemplatesType" }, - "newLoginName": { - "description": "New Login Name of the guest.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "newPassword": { - "description": "Login Password.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "userDefinedFieldGroupsDetails": { + "type": "object", + "description": "Response object for fetching User Defined Field Groups.", + "properties": { + "userDefinedFieldGroups": { + "description": "Collection of User Defined Field Groups.", + "$ref": "#/definitions/userDefinedFieldGroupsType" }, - "securityAnswer": { - "description": "Answer to the Security Question.", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "securityQuestion": { - "description": "Security Question and its Code associated with the account to verify the user.", - "$ref": "#/definitions/codeDescriptionType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "webUserAccountsType": { - "description": "Web User Accounts List.", + "userDefinedFieldGroupsType": { "type": "array", + "description": "A recurring element that identifies the User Defined Field Group.", "maxItems": 4000, "items": { - "$ref": "#/definitions/webUserAccountType" + "$ref": "#/definitions/userDefinedFieldGroupType" } }, - "webUserHistoryType": { - "description": "Creation date time, Creator Id, last modification date time and last Modifier Id.", + "userDefinedFieldGroupType": { "type": "object", + "description": "Information representation of User Defined Field Group.", "properties": { - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "inactiveDate": { - "description": "Inactive date.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "lastLogin": { - "description": "Last login date.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "groupCode": { + "description": "The Code of User Defined Field Group.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", + "description": { + "description": "The Description of User Defined Field Group.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 40 }, - "lastPasswordChange": { - "description": "Last Password change date.", - "type": "string", - "format": "date", - "maxLength": 8 + "dataType": { + "description": "The Data Type of User Defined Field Group(eg. Integer, Char and null).", + "$ref": "#/definitions/userDefinedFieldGroupDataType" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", - "type": "string", - "format": "date", - "maxLength": 8 - } - } - }, - "yieldAdjustmentCodeType": { - "description": "Provides information about the Adjustment Codes.", - "type": "object", - "properties": { - "amount": { - "description": "A monetary amount.", + "dataLength": { + "description": "Length of field values of User Defined Field Group.", "type": "number" }, - "code": { - "description": "Code of the Adjustment Codes.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "currencyCode": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "maxLength": 3, - "minLength": 3 - }, - "description": { - "description": "Description of the Adjustment Codes.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "hotelId": { - "description": "Code of the Hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "type": { - "description": "Yield Adjustment Type. e.g. Per Stay for ST", - "$ref": "#/definitions/yieldAdjustmentTypeType" + "protected": { + "description": "Indicates that if the group could be deleted. This is a readonly element an it is only used in the fetch operation.", + "type": "boolean" } } }, - "yieldAdjustmentCodesCriteria": { - "description": "Request object for creating new Yield AdjustmentCodes Configurations.", + "userDefinedFieldGroupDataType": { + "type": "string", + "description": "Simple type used for User Defined Field Group Data Type.", + "enum": [ + "Integer", + "Char" + ] + }, + "userDefinedFieldGroupsCriteria": { "type": "object", + "description": "Request object for creating User Defined Field Groups.", "properties": { + "userDefinedFieldGroups": { + "description": "User Defined Field Groups to be created.", + "$ref": "#/definitions/userDefinedFieldGroupsType" + }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" - }, - "yieldAdjustmentCodes": { - "description": "Yield AdjustmentCodes Configurations to be created.", - "$ref": "#/definitions/yieldAdjustmentCodesType" } } }, - "yieldAdjustmentCodesDetails": { - "description": "Response object for fetching Yield AdjustmentCodes configurations.", + "userDefinedFieldGroupsToBeChanged": { "type": "object", + "description": "Request object for changing User Defined Field Groups.", "properties": { + "userDefinedFieldGroups": { + "description": "User Defined Field Groups to be changed.", + "$ref": "#/definitions/userDefinedFieldGroupsType" + }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" - }, - "yieldAdjustmentCodes": { - "description": "Collection of Yield AdjustmentCodes configurations.", - "$ref": "#/definitions/yieldAdjustmentCodesType" } } }, - "yieldAdjustmentCodesToBeChanged": { - "description": "Request object for changing existing Yield AdjustmentCodes Configurations.", + "userDefinedFieldValuesDetails": { "type": "object", + "description": "Response object for fetching User Defined Field Values.", "properties": { + "userDefinedFieldValues": { + "description": "Collection of User Defined Field Values.", + "$ref": "#/definitions/userDefinedFieldValuesType" + }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" - }, - "yieldAdjustmentCodes": { - "description": "Yield AdjustmentCodes Configurations to be changed.", - "$ref": "#/definitions/yieldAdjustmentCodesType" } } }, - "yieldAdjustmentCodesType": { - "description": "Holds Yield AdjustmentCodes details.", + "userDefinedFieldValuesType": { "type": "array", + "description": "A recurring element that identifies the User Defined Field Value.", "maxItems": 4000, "items": { - "$ref": "#/definitions/yieldAdjustmentCodeType" + "$ref": "#/definitions/userDefinedFieldValueType" } }, - "yieldAdjustmentTypeType": { - "description": "Defines values for Yield Adjustment Types.", - "type": "string", - "enum": [ - "PerStay", - "PerNight", - "PerPersonPerNight", - "PerPersonPerStay" - ] - }, - "yieldCategoriesCriteria": { - "description": "Request object for creating new Yield Category Configurations.", + "userDefinedFieldValueType": { "type": "object", + "description": "Contains Common Master configuration detail.", "properties": { "code": { - "description": "Code of the Yield Category.", + "description": "Common Master unique code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, "description": { - "description": "Description of the Yield Category.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "description": "Description of the Master code.", + "$ref": "#/definitions/translationTextType2000" }, - "hotelId": { - "description": "Code of the Hotel.", + "displayOrder": { + "description": "Common Master record sequence number.", + "type": "number" + }, + "groupCode": { + "description": "The group which the User Defined Field Value belongs to.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 + } + } + }, + "userDefinedFieldValuesCriteria": { + "type": "object", + "description": "Request object for creating User Defined Field Values.", + "properties": { + "userDefinedFieldValues": { + "description": "User Defined Field Value to be created.", + "$ref": "#/definitions/userDefinedFieldValuesType" }, "links": { "$ref": "#/definitions/links" @@ -53943,43 +49382,29 @@ } } }, - "yieldCategoriesDetails": { - "description": "Response object for fetching Yield Category configurations.", + "userDefinedFieldValuesToBeChanged": { "type": "object", + "description": "Request object for changing User Defined Field Values.", "properties": { + "userDefinedFieldValues": { + "description": "User Defined Field Values to be changed.", + "$ref": "#/definitions/userDefinedFieldValuesType" + }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" - }, - "yieldCategories": { - "description": "Collection of Yield Category configurations.", - "$ref": "#/definitions/yieldCategoriesType" } } }, - "yieldCategoriesToBeChanged": { - "description": "Request object for changing existing Yield Category Configurations.", + "yieldMarketTypesDetails": { "type": "object", + "description": "Response object for fetching Yield Market Types.", "properties": { - "code": { - "description": "Code of the Yield Category.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "description": { - "description": "Description of the Yield Category.", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "hotelId": { - "description": "Code of the Hotel.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "yieldMarketTypes": { + "description": "Collection of Yield Market Types.", + "$ref": "#/definitions/yieldMarketTypesType" }, "links": { "$ref": "#/definitions/links" @@ -53989,103 +49414,119 @@ } } }, - "yieldCategoriesType": { - "description": "Holds Yield Category details.", + "yieldMarketTypesType": { "type": "array", + "description": "List of Yield Market Type to be configured or fetched", "maxItems": 4000, "items": { - "$ref": "#/definitions/yieldCategoryType" + "$ref": "#/definitions/yieldMarketTypeType" } }, - "yieldCategoryType": { - "description": "Provides information about the Yield Category.", + "yieldMarketTypeType": { "type": "object", + "description": "Details for Yield Market Type.", "properties": { "code": { - "description": "Code of the Yield Category.", + "description": "Yield Market Code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel code for which the yield market type belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, "description": { - "description": "Description of the Yield Category.", + "description": "Description for the yield market code.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "hotelId": { - "description": "Code of the Hotel.", + "alternativeCode": { + "description": "If the yield market code does not return a result, this alternative yield market code is used instead.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "default": { + "description": "Indicates the default yield market type.", + "type": "boolean" } } }, - "yieldMarketTypeType": { - "description": "Details for Yield Market Type.", + "yieldMarketTypesCriteria": { "type": "object", + "description": "Request object for creating new Yield Market Types.", "properties": { - "alternativeCode": { - "description": "If the yield market code does not return a result, this alternative yield market code is used instead.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, "code": { "description": "Yield Market Code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "default": { - "description": "Indicates the default yield market type.", - "type": "boolean" + "hotelId": { + "description": "Hotel code for which the yield market type belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, "description": { "description": "Description for the yield market code.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "hotelId": { - "description": "Hotel code for which the yield market type belong to.", + "alternativeCode": { + "description": "If the yield market code does not return a result, this alternative yield market code is used instead.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "default": { + "description": "Indicates the default yield market type.", + "type": "boolean" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "yieldMarketTypesCriteria": { - "description": "Request object for creating new Yield Market Types.", + "yieldMarketTypesToBeChanged": { "type": "object", + "description": "Request object for changing existing Yield Market Types.", "properties": { - "alternativeCode": { - "description": "If the yield market code does not return a result, this alternative yield market code is used instead.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, "code": { "description": "Yield Market Code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "default": { - "description": "Indicates the default yield market type.", - "type": "boolean" + "hotelId": { + "description": "Hotel code for which the yield market type belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, "description": { "description": "Description for the yield market code.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "hotelId": { - "description": "Hotel code for which the yield market type belong to.", + "alternativeCode": { + "description": "If the yield market code does not return a result, this alternative yield market code is used instead.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 + }, + "default": { + "description": "Indicates the default yield market type.", + "type": "boolean" }, "links": { "$ref": "#/definitions/links" @@ -54095,53 +49536,147 @@ } } }, - "yieldMarketTypesDetails": { - "description": "Response object for fetching Yield Market Types.", + "flexFieldCriteria": { + "type": "object", + "description": "Request object for flex fields.", + "properties": { + "flexFieldCriteriaType": { + "description": "Provides information about flex fields", + "$ref": "#/definitions/flexFieldType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "flexFieldsResponse": { "type": "object", + "description": "Response object for flex fields.", "properties": { + "flexFields": { + "description": "List of flex fields.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/flexFieldType" + } + }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" }, - "yieldMarketTypes": { - "description": "Collection of Yield Market Types.", - "$ref": "#/definitions/yieldMarketTypesType" + "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" } } }, - "yieldMarketTypesToBeChanged": { - "description": "Request object for changing existing Yield Market Types.", + "flexFieldType": { "type": "object", + "description": "Provides the details of a flex field", "properties": { - "alternativeCode": { - "description": "If the yield market code does not return a result, this alternative yield market code is used instead.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "module": { + "description": "Module to which the flex field belongs", + "$ref": "#/definitions/flexFieldModuleType", + "minLength": 0, + "maxLength": 40 }, "code": { - "description": "Yield Market Code.", + "description": "Flex field code", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "default": { - "description": "Indicates the default yield market type.", - "type": "boolean" + "flexFieldId": { + "description": "Unique ID of the flex field", + "type": "number" }, "description": { - "description": "Description for the yield market code.", + "description": "Description of the flex field", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "sequence": { + "description": "Sequence of the flex field", + "type": "number" + }, + "lovName": { + "description": "Name of the flex field LOV", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 40 + }, + "isMandatory": { + "description": "Indicates whether the flex field is mandatory or not", + "type": "boolean" + }, + "isLov": { + "description": "Indicates whether the flex field is a LOV or not", + "type": "boolean" + }, + "isMultiSelectLov": { + "description": "Indicates whether the flex field is multi-select or not", + "type": "boolean" + }, + "isInactive": { + "description": "Indicates whether the flex field is active or not", + "type": "boolean" }, "hotelId": { - "description": "Hotel code for which the yield market type belong to.", + "description": "Hotel Code", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + "profileType": { + "description": "Profile Type", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 1, + "maxLength": 200 + } + } + }, + "flexFieldModuleType": { + "type": "string", + "description": "Flex field module type.", + "enum": [ + "Profile", + "Reservation" + ] + }, + "hotelToBeChanged": { + "type": "object", + "description": "Request object for changing Property general information.", + "properties": { + "hotelInfo": { + "description": "The basic configuration information about a Hotel.", + "$ref": "#/definitions/hotelInfoType" }, "links": { "$ref": "#/definitions/links" @@ -54150,27 +49685,19 @@ "$ref": "#/definitions/warningsType" } } - }, - "yieldMarketTypesType": { - "description": "List of Yield Market Type to be configured or fetched", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/yieldMarketTypeType" - } } }, "tags": [ { - "description": "The ChainConfigService Web Service offers capability of creating, managing, and retrieving of chain configuration.", - "name": "ChainConfig" + "name": "ChainConfig", + "description": "The ChainConfigService Web Service offers capability of creating, managing, and retrieving of chain configuration." }, { "name": "ExternalConfig" }, { - "description": "The Hotel Config Service Web Service offers capability to configure Master Data needed for Hotel Configuration such as managing Room Classes, Room Types, Rooms, etc.", - "name": "HotelConfig" + "name": "HotelConfig", + "description": "The Hotel Config Service Web Service offers capability to configure Master Data needed for Hotel Configuration such as managing Room Classes, Room Types, Rooms, etc." } ], "externalDocs": { diff --git a/rest-api-specs/property/intcfg.json b/rest-api-specs/property/intcfg.json index 0ca5092..4262efe 100644 --- a/rest-api-specs/property/intcfg.json +++ b/rest-api-specs/property/intcfg.json @@ -1,15 +1,9 @@ { - "produces": [ - "application/json" - ], - "schemes": [ - "https" - ], "swagger": "2.0", "info": { - "description": "APIs catering to Integration Configuration in OPERA Cloud. Operations such as get Hotel Interface Types, or get UDF mappings can be found in this module.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, 2023 Oracle and/or its affiliates.
", "title": "OPERA Cloud Integration Configuration API", - "version": "23.2", + "description": "APIs catering to Integration Configuration in OPERA Cloud. Operations such as get Hotel Interface Types, or get UDF mappings can be found in this module.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, 2023 Oracle and/or its affiliates.
", + "version": "23.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality-integrations_ww@oracle.com" @@ -19,165 +13,92 @@ "url": "https://opensource.org/licenses/upl" } }, + "schemes": [ + "https" + ], "basePath": "/int/config/v1", + "produces": [ + "application/json" + ], "paths": { - "/deliveryMethods": { - "get": { - "description": "OperationId:getDeliveryMethods
", - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "ExternalSystemsConfig" - ], - "summary": "Operation to fetch delivery methods.", - "operationId": "getDeliveryMethods", + "/config/oxi/services/beProcessor/cache": { + "delete": { + "summary": "Operation to clear cache.", + "description": "OperationId:clearCacheBeProcessor
", + "operationId": "clearCacheBeProcessor", "parameters": [ { - "type": "string", - "description": "Property code.", - "name": "hotelId", - "in": "query" - }, - { - "type": "string", - "description": "CRO code.", - "name": "croCode", - "in": "query" - }, - { - "uniqueItems": true, - "type": "array", - "items": { - "enum": [ - "General", - "QueueReservation", - "Confirmation", - "GuestMessage", - "BillingFolio", - "QueueRush", - "AR", - "OtherFolio" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "Settings for Text Message Delivery of Queue Reservation status", - "name": "usages", - "in": "query" - }, - { - "type": "boolean", - "description": "If true this will include inactive records(This is only applicable for general SMTP delivery method ).", - "name": "includeInactive", - "in": "query" - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response to request to fetch the delivery method for a property/HUB/Chain and its configurations.", - "schema": { - "$ref": "#/definitions/fetchedDeliveryMethods" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "DeliveryMethods not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "OperationId:putDeliveryMethods
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -185,128 +106,87 @@ "application/json;charset=UTF-8" ], "tags": [ - "ExternalSystemsConfig" - ], - "summary": "Operation to change delivery methods.", - "operationId": "putDeliveryMethods", + "BEProcessor" + ] + } + }, + "/config/oxi/services/beProcessor/status": { + "get": { + "summary": "Operation to ping.", + "description": "OperationId:pingBeProcessor
", + "operationId": "pingBeProcessor", "parameters": [ { - "description": "Request to change the delivery method for a property/HUB/Chain and its configurations.", - "name": "changeDeliveryMethods", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/changeDeliveryMethods" - } - ] - } - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/changedDeliveryMethods" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "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": "pingBeProcessor not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "OperationId:postDeliveryMethods
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -314,128 +194,253 @@ "application/json;charset=UTF-8" ], "tags": [ - "ExternalSystemsConfig" - ], - "summary": "Operation to create delivery methods.", - "operationId": "postDeliveryMethods", + "BEProcessor" + ] + } + }, + "/configuredExternalDevices": { + "get": { + "summary": "Operation to fetch configured external devices.", + "description": "OperationId:getConfiguredExternalDevices
", + "operationId": "getConfiguredExternalDevices", "parameters": [ { - "description": "Request to create the delivery method for a property/HUB/Chain and its configurations.", - "name": "createDeliveryMethods", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/createDeliveryMethods" - } - ] - } + "name": "hotelId", + "in": "query", + "required": false, + "type": "string" }, { + "name": "active", + "in": "query", + "required": false, + "description": "Flag that indicates whether the device is active.", + "type": "boolean" + }, + { + "name": "id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "idEditable", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "label", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "deviceType", + "in": "query", + "required": false, "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "uniqueItems": true, + "enum": [ + "Scanner", + "CreditCard", + "Fiscal", + "Device" + ] }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", + "name": "deviceCode", + "in": "query", + "required": false, "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "uniqueItems": true, + "enum": [ + "TtiScannerMobile", + "TtiScannerDesktop", + "SamsotechScanner", + "GenScannerDesktop", + "GenScannerMobile", + "ChipAndPin", + "FiscalTerminal", + "Device" + ] + }, + { + "name": "deviceArea", + "in": "query", + "required": false, + "description": "The area where the device is installed", + "type": "string" + }, + { + "name": "displayName", + "in": "query", + "required": false, + "description": "External device display name.", + "type": "string" + }, + { + "name": "mobileYN", + "in": "query", + "required": false, + "description": "Indicator if device type is mobile or desktop.", + "type": "boolean" + }, + { + "name": "desktopYN", + "in": "query", + "required": false, + "description": "Indicator if device type is mobile or desktop.", + "type": "boolean" + }, + { + "name": "registerAddress", + "in": "query", + "required": false, + "description": "The address which the Cash Register ID ( Device ID ) is associated with.", + "type": "string" + }, + { + "name": "deviceValue", + "in": "query", + "required": false, + "description": "External device Value.", + "type": "string" + }, + { + "name": "parameterName", + "in": "query", + "required": false, + "description": "Name of the parameter.", + "type": "string" + }, + { + "name": "parameterValue", + "in": "query", + "required": false, + "description": "Value of the parameter.", + "type": "string" + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Flag to choose to include inactive external devices or not.", + "type": "boolean" }, { + "name": "fiscalPartnerCode", + "in": "query", + "required": false, "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "description": "Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { - "maxLength": 80, + "name": "partnerCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "fetchInstruction", + "in": "query", + "required": false, "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "description": "Fetch instructions that can be used for all or partner specific.", + "uniqueItems": true, + "enum": [ + "Default", + "Partner" + ] }, { + "name": "partnerPayloadType", + "in": "query", + "required": false, "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "description": "Used for searching a partner code configured with the specified fiscal payload type.", + "uniqueItems": true, + "enum": [ + "CheckOut", + "FolioGeneration" + ] + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" - }, - "Location": { - "type": "string", - "description": "Location of newly created resource" + "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/fetchedConfiguredExternalDevices" } }, + "204": { + "description": "ConfiguredExternalDevices not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "OperationId:deleteDeliveryMethods
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -444,166 +449,129 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to remove delivery methods.", - "operationId": "deleteDeliveryMethods", + ] + } + }, + "/deliveryMethods": { + "get": { + "summary": "Operation to fetch delivery methods.", + "description": "OperationId:getDeliveryMethods
", + "operationId": "getDeliveryMethods", "parameters": [ { - "type": "string", - "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", "name": "hotelId", - "in": "query" + "in": "query", + "required": false, + "description": "Property code.", + "type": "string" }, { - "uniqueItems": true, - "enum": [ - "General", - "QueueReservation", - "Confirmation", - "GuestMessage", - "BillingFolio", - "QueueRush", - "AR", - "OtherFolio" - ], - "type": "string", - "description": "Settings for Text Message Delivery of Queue Reservation status", - "name": "type", - "in": "query" + "name": "croCode", + "in": "query", + "required": false, + "description": "CRO code.", + "type": "string" }, { - "uniqueItems": true, + "name": "usages", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Settings for Text Message Delivery of Queue Reservation status", + "uniqueItems": true, "items": { + "type": "string", "enum": [ - "Email", - "Fax", - "TextMessage", - "Sftp" - ], - "type": "string" + "General", + "QueueReservation", + "Confirmation", + "GuestMessage", + "BillingFolio", + "QueueRush", + "AR", + "OtherFolio" + ] }, - "collectionFormat": "multi", - "description": "SFTP delivery configurations", - "name": "options", - "in": "query" + "required": false }, { - "type": "array", - "items": { - "type": "integer" - }, - "collectionFormat": "multi", - "description": "Unique id associated with this configuration", - "name": "configurationId", - "in": "query" + "name": "includeInactive", + "in": "query", + "required": false, + "description": "If true this will include inactive records(This is only applicable for general SMTP delivery method ).", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response to request to fetch the delivery method for a property/HUB/Chain and its configurations.", + "schema": { + "$ref": "#/definitions/fetchedDeliveryMethods" } }, + "204": { + "description": "DeliveryMethods not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/deviceLocations": { - "get": { - "description": "Use this API to get the template device locations.OperationId:getTemplateDeviceLocations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -611,144 +579,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Get the template device locations", - "operationId": "getTemplateDeviceLocations", + "ExternalSystemsConfig" + ] + }, + "put": { + "summary": "Operation to change delivery methods.", + "description": "OperationId:putDeliveryMethods
", + "operationId": "putDeliveryMethods", "parameters": [ { - "type": "boolean", - "default": "false", - "description": "Determines wether to fetch inactive records or not.", - "name": "fetchInactive", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "description": "Codes to be searched.", - "name": "codes", - "in": "query" - }, - { - "type": "string", - "description": "Wildcard search on the code.", - "name": "wildCard", - "in": "query" - }, - { - "type": "string", - "description": "Description of the code.", - "name": "description", - "in": "query" + "name": "changeDeliveryMethods", + "in": "body", + "required": true, + "description": "Request to change the delivery method for a property/HUB/Chain and its configurations.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeDeliveryMethods" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching template Device locations.", - "schema": { - "$ref": "#/definitions/templateDeviceLocationsDetails" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedDeliveryMethods" } }, - "204": { - "description": "TemplateDeviceLocations not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create the template device locations.OperationId:postTemplateDeviceLocations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -756,130 +679,140 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Create the template device locations", - "operationId": "postTemplateDeviceLocations", + "ExternalSystemsConfig" + ] + }, + "delete": { + "summary": "Operation to remove delivery methods.", + "description": "OperationId:deleteDeliveryMethods
", + "operationId": "deleteDeliveryMethods", "parameters": [ { - "description": "Request object for creating template Device locations.", - "name": "templateDeviceLocationsCriteria", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/templateDeviceLocationsCriteria" - } - ] - } + "name": "hotelId", + "in": "query", + "required": false, + "type": "string", + "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { + "name": "type", + "in": "query", + "required": false, "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "description": "Settings for Text Message Delivery of Queue Reservation status", + "uniqueItems": true, + "enum": [ + "General", + "QueueReservation", + "Confirmation", + "GuestMessage", + "BillingFolio", + "QueueRush", + "AR", + "OtherFolio" + ] }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "options", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "SFTP delivery configurations", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "Email", + "Fax", + "TextMessage", + "Sftp" + ] + }, + "required": false }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "name": "configurationId", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Unique id associated with this configuration", + "items": { + "type": "integer" + }, + "required": false }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/deviceLocations/{deviceLocationId}": { - "put": { - "description": "Use this API to update the template device locations.OperationId:changeTemplateDeviceLocations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -887,137 +820,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Change the template device locations", - "operationId": "changeTemplateDeviceLocations", + "ExternalSystemsConfig" + ] + }, + "post": { + "summary": "Operation to create delivery methods.", + "description": "OperationId:postDeliveryMethods
", + "operationId": "postDeliveryMethods", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of device location.", - "name": "deviceLocationId", - "in": "path", - "required": true - }, - { - "description": "Request object for changing template Device locations.", - "name": "templateDeviceLocationsToBeChanged", + "name": "createDeliveryMethods", "in": "body", "required": true, + "description": "Request to create the delivery method for a property/HUB/Chain and its configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/templateDeviceLocationsToBeChanged" + "$ref": "#/definitions/createDeliveryMethods" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to delete the template device locations.OperationId:removeTemplateDeviceLocations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1025,126 +920,121 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" - ], - "summary": "Delete the template device locations", - "operationId": "removeTemplateDeviceLocations", + "ExternalSystemsConfig" + ] + } + }, + "/deviceLocations": { + "get": { + "summary": "Get the template device locations", + "description": "Use this API to get the template device locations.OperationId:getTemplateDeviceLocations
", + "operationId": "getTemplateDeviceLocations", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of device location.", - "name": "deviceLocationId", - "in": "path", - "required": true + "name": "fetchInactive", + "in": "query", + "default": "false", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "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 Device locations.", + "schema": { + "$ref": "#/definitions/templateDeviceLocationsDetails" } }, + "204": { + "description": "TemplateDeviceLocations not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/externalSystems/{externalSystemCode}/hotels/{hotelId}/publishers": { - "post": { - "description": "OperationId:postPublishers
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1152,146 +1042,99 @@ "application/json;charset=UTF-8" ], "tags": [ - "ExternalSystemsConfig" - ], - "summary": "Operation to create publishers.", - "operationId": "postPublishers", + "ChainConfig" + ] + }, + "post": { + "summary": "Create the template device locations", + "description": "Use this API to create the template device locations.OperationId:postTemplateDeviceLocations
", + "operationId": "postTemplateDeviceLocations", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique OPERA Id used to find a property in OPERA.", - "name": "hotelId", - "in": "path", - "required": true - }, - { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique OPERA Code used to find External System in OPERA.", - "name": "externalSystemCode", - "in": "path", - "required": true - }, - { - "description": "Request to create publishers.", - "name": "createPublishers", + "name": "templateDeviceLocationsCriteria", "in": "body", "required": true, + "description": "Request object for creating template Device locations.", "schema": { "allOf": [ { - "$ref": "#/definitions/createPublishers" + "$ref": "#/definitions/templateDeviceLocationsCriteria" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "OperationId:deletePublisher
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1299,145 +1142,110 @@ "application/json;charset=UTF-8" ], "tags": [ - "ExternalSystemsConfig" - ], - "summary": "Operation to remove publisher.", - "operationId": "deletePublisher", + "ChainConfig" + ] + } + }, + "/deviceLocations/{deviceLocationId}": { + "put": { + "summary": "Change the template device locations", + "description": "Use this API to update the template device locations.OperationId:changeTemplateDeviceLocations
", + "operationId": "changeTemplateDeviceLocations", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique OPERA Id used to find a property in OPERA.", - "name": "hotelId", - "in": "path", - "required": true - }, - { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique OPERA Code used to find External System in OPERA.", - "name": "externalSystemCode", + "name": "deviceLocationId", "in": "path", - "required": true - }, - { + "required": true, "type": "string", - "name": "subscriberHotelId", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of device location." }, { - "type": "string", - "name": "code", - "in": "query" + "name": "templateDeviceLocationsToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing template Device locations.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/templateDeviceLocationsToBeChanged" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/externalSystems/{externalSystemCode}/publishers": { - "get": { - "description": "OperationId:getPublishers
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1445,130 +1253,95 @@ "application/json;charset=UTF-8" ], "tags": [ - "ExternalSystemsConfig" - ], - "summary": "Operation to fetch publishers.", - "operationId": "getPublishers", + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete the template device locations", + "description": "Use this API to delete the template device locations.OperationId:removeTemplateDeviceLocations
", + "operationId": "removeTemplateDeviceLocations", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique OPERA Code used to find External System in OPERA.", - "name": "externalSystemCode", + "name": "deviceLocationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of device location." }, { - "type": "string", - "name": "hotelId", - "in": "query" + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true - }, - { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response to request to fetch the external systems", - "schema": { - "$ref": "#/definitions/fetchedPublishers" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "Publishers not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotelInterfaceTypes": { - "get": { - "description": "OperationId:getHotelInterfaces
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1576,172 +1349,190 @@ "application/json;charset=UTF-8" ], "tags": [ - "ExternalSystemsConfig" - ], - "summary": "Operation to fetch hotel interfaces.", - "operationId": "getHotelInterfaces", + "ChainConfig" + ] + } + }, + "/externalDevices/configurations": { + "get": { + "summary": "Operation to fetch external device configurations.", + "description": "OperationId:getExternalDeviceConfigurations
", + "operationId": "getExternalDeviceConfigurations", "parameters": [ { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "hotelIds", - "in": "query" + "name": "hotelId", + "in": "query", + "required": false, + "type": "string" }, { - "uniqueItems": true, - "type": "array", - "items": { - "enum": [ - "Bms", - "Cas", - "Ccw", - "Dls", - "Eft", - "Exp", - "Mak", - "Mbs", - "Msc", - "Pbx", - "Pos", - "Svs", - "Tik", - "Vid", - "Vms", - "Www", - "Xml" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "XML Posting Interface", - "name": "interfaceTypes", - "in": "query" + "name": "active", + "in": "query", + "required": false, + "description": "Flag that indicates whether the device is active.", + "type": "boolean" }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "logosCodes", - "in": "query" + "name": "id", + "in": "query", + "required": false, + "type": "string" }, { - "type": "boolean", - "description": "If true this will set the criteria to include inactive records.", - "name": "includeInactive", - "in": "query" + "name": "idEditable", + "in": "query", + "required": false, + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "label", + "in": "query", + "required": false, + "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}$", + "name": "deviceType", + "in": "query", + "required": false, "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "uniqueItems": true, + "enum": [ + "Scanner", + "CreditCard", + "Fiscal", + "Device" + ] }, { + "name": "deviceCode", + "in": "query", + "required": false, "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "uniqueItems": true, + "enum": [ + "TtiScannerMobile", + "TtiScannerDesktop", + "SamsotechScanner", + "GenScannerDesktop", + "GenScannerMobile", + "ChipAndPin", + "FiscalTerminal", + "Device" + ] }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "name": "deviceArea", + "in": "query", + "required": false, + "description": "The area where the device is installed", + "type": "string" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "name": "displayName", + "in": "query", + "required": false, + "description": "External device display name.", + "type": "string" + }, + { + "name": "mobileYN", + "in": "query", + "required": false, + "description": "Indicator if device type is mobile or desktop.", + "type": "boolean" + }, + { + "name": "desktopYN", + "in": "query", + "required": false, + "description": "Indicator if device type is mobile or desktop.", + "type": "boolean" + }, + { + "name": "registerAddress", + "in": "query", + "required": false, + "description": "The address which the Cash Register ID ( Device ID ) is associated with.", + "type": "string" + }, + { + "name": "deviceValue", + "in": "query", + "required": false, + "description": "External device Value.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for retrieving Hotel Interfaces.", - "schema": { - "$ref": "#/definitions/fetchedHotelInterfaces" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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/fetchedExternalDeviceConfigurations" } }, "204": { - "description": "HotelInterfaces not found." + "description": "ExternalDeviceConfigurations not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/hotelInerface": { - "delete": { - "description": "OperationId:deleteHotelInterface
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1750,130 +1541,98 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to remove hotel interface.", - "operationId": "deleteHotelInterface", + ] + }, + "put": { + "summary": "Operation to change external device configurations.", + "description": "OperationId:putExternalDeviceConfigurations
", + "operationId": "putExternalDeviceConfigurations", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "name": "hotelId", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", - "name": "logo", - "in": "query" + "name": "changeExternalDeviceConfigurations", + "in": "body", + "required": true, + "description": "Request to change the external device activated for the hotel and its configurations.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeExternalDeviceConfigurations" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedExternalDeviceConfigurations" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/interfaceControllerRegistry": { - "get": { - "description": "OperationId:getHotelInterfaceControllerRegistry
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1882,121 +1641,87 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to fetch hotel interface controller registry.", - "operationId": "getHotelInterfaceControllerRegistry", + ] + } + }, + "/externalSystems/config/cache": { + "delete": { + "summary": "Operation to clear cache.", + "description": "OperationId:clearCache
", + "operationId": "clearCache", "parameters": [ { - "type": "string", - "description": "Used for Character Strings, length 0 to 40.", - "name": "machine", - "in": "query" - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for retrieving Hotel Interface Controller Registry.", - "schema": { - "$ref": "#/definitions/fetchedHotelInterfaceControllerRegistry" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "HotelInterfaceControllerRegistry not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/interfaceErrors": { - "get": { - "description": "OperationId:getHotelInterfaceErrors
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2005,184 +1730,86 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to fetch hotel interface errors.", - "operationId": "getHotelInterfaceErrors", + ] + } + }, + "/externalSystems/config/ping": { + "get": { + "summary": "Operation to ping.", + "description": "OperationId:ping
", + "operationId": "ping", "parameters": [ { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", - "name": "limit", - "in": "query" + "$ref": "#/parameters/authKey" }, { - "type": "integer", - "default": 0, - "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", - "name": "offset", - "in": "query" + "$ref": "#/parameters/x-app-key" }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "hotelIds", - "in": "query" + "$ref": "#/parameters/x-hotelid" }, { - "uniqueItems": true, - "type": "array", - "items": { - "enum": [ - "Bms", - "Cas", - "Ccw", - "Dls", - "Eft", - "Exp", - "Mak", - "Mbs", - "Msc", - "Pbx", - "Pos", - "Svs", - "Tik", - "Vid", - "Vms", - "Www", - "Xml" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "XML Posting Interface", - "name": "interfaceTypes", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "logoCodes", - "in": "query" - }, - { - "type": "boolean", - "description": "If true this will set the criteria to include inactive records.", - "name": "includeInactive", - "in": "query" - }, - { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true - }, - { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true - }, - { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true - }, - { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for retrieving Hotel Interface Errors.", - "schema": { - "$ref": "#/definitions/fetchedHotelInterfaceErrors" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "HotelInterfaceErrors not found." + "description": "ping not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/interfaceFailedMessages": { - "get": { - "description": "OperationId:getHotelInterfaceFailedMessages
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2191,184 +1818,118 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to fetch hotel interface failed messages.", - "operationId": "getHotelInterfaceFailedMessages", + ] + } + }, + "/externalSystems/{externalSystemCode}/hotels/{hotelId}/publishers": { + "post": { + "summary": "Operation to create publishers.", + "description": "OperationId:postPublishers
", + "operationId": "postPublishers", "parameters": [ { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "default": 0, - "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", - "name": "offset", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "hotelIds", - "in": "query" - }, - { - "uniqueItems": true, - "type": "array", - "items": { - "enum": [ - "Bms", - "Cas", - "Ccw", - "Dls", - "Eft", - "Exp", - "Mak", - "Mbs", - "Msc", - "Pbx", - "Pos", - "Svs", - "Tik", - "Vid", - "Vms", - "Www", - "Xml" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "XML Posting Interface", - "name": "interfaceTypes", - "in": "query" + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Id used to find a property in OPERA." }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "logoCodes", - "in": "query" + "name": "externalSystemCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Code used to find External System in OPERA." }, { - "type": "boolean", - "description": "If true this will set the criteria to include inactive records.", - "name": "includeInactive", - "in": "query" + "name": "createPublishers", + "in": "body", + "required": true, + "description": "Request to create publishers.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/createPublishers" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Response object for retrieving Hotel Interface Failed Messages.", - "schema": { - "$ref": "#/definitions/fetchedHotelInterfaceFailedMessages" - }, + "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "HotelInterfaceFailedMessages not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/interfaceRights": { - "get": { - "description": "OperationId:getInterfaceRights
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2377,143 +1938,115 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to fetch interface rights.", - "operationId": "getInterfaceRights", + ] + }, + "delete": { + "summary": "Operation to remove publisher.", + "description": "OperationId:deletePublisher
", + "operationId": "deletePublisher", "parameters": [ { - "type": "string", - "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", "name": "hotelId", - "in": "query" - }, - { + "in": "path", + "required": true, "type": "string", - "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.", - "name": "id", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Id used to find a property in OPERA." }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", - "name": "idExtension", - "in": "query" + "name": "externalSystemCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Code used to find External System in OPERA." }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "idContext", - "in": "query" + "name": "subscriberHotelId", + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "type", - "in": "query" + "name": "code", + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Collection of Hotel Interface Tasks.", - "schema": { - "$ref": "#/definitions/fetchedInterfaceRights" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "InterfaceRights not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "OperationId:putInterfaceRight
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2522,127 +2055,101 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to change interface right.", - "operationId": "putInterfaceRight", + ] + } + }, + "/externalSystems/{externalSystemCode}/publishers": { + "get": { + "summary": "Operation to fetch publishers.", + "description": "OperationId:getPublishers
", + "operationId": "getPublishers", "parameters": [ { - "description": "Request object for updating a Hotel Interface Right. It will create the Hotel Interface Right if it does not exist on the database.", - "name": "changeInterfaceRight", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/changeInterfaceRight" - } - ] - } + "name": "externalSystemCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Code used to find External System in OPERA." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "hotelId", + "in": "query", + "required": false, + "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}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/changedInterfaceRight" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response to request to fetch the external systems", + "schema": { + "$ref": "#/definitions/fetchedPublishers" } }, + "204": { + "description": "Publishers not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "OperationId:deleteInterfaceRight
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2651,170 +2158,200 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to remove interface right.", - "operationId": "deleteInterfaceRight", + ] + } + }, + "/hotelInerface": { + "post": { + "summary": "Operation to create hotel interface.", + "description": "OperationId:postHotelInterface
", + "operationId": "postHotelInterface", "parameters": [ { - "type": "string", - "description": "Hotel Code to which the Interface Right belongs to.", - "name": "hotelId", - "in": "query" + "name": "hotelInterface", + "in": "body", + "required": true, + "description": "Request object for creating a new Hotel Interface.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/hotelInterface" + } + ] + } }, { - "type": "string", - "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.", - "name": "id", - "in": "query" + "$ref": "#/parameters/authKey" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", - "name": "idExtension", - "in": "query" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "idContext", - "in": "query" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "type", - "in": "query" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "integer", - "description": "Internal code for each allowed right of a Hotel Interface record.", - "name": "right", - "in": "query" + "$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" + } }, - { - "type": "string", - "description": "User defined code for an Interface Right.", - "name": "code", - "in": "query" + "400": { + "$ref": "#/responses/400" }, - { - "type": "string", - "description": "User defined description for an Interface Right.", - "name": "description", - "in": "query" + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ExternalSystemsConfig" + ] + }, + "put": { + "summary": "Operation to change hotel interface.", + "description": "OperationId:putHotelInterface
", + "operationId": "putHotelInterface", + "parameters": [ { - "type": "string", - "description": "System Description of an allowed Interface Right.", - "name": "interfaceRightDescription", - "in": "query" + "name": "hotelInterface", + "in": "body", + "required": true, + "description": "Request object for updating a Hotel Interface.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/hotelInterface" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/interfaceSchemas": { - "get": { - "description": "OperationId:getHotelInterfaceSchemas
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2823,37 +2360,35 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to fetch hotel interface schemas.", - "operationId": "getHotelInterfaceSchemas", + ] + } + }, + "/hotelInterfaceTypes": { + "get": { + "summary": "Operation to fetch hotel interfaces.", + "description": "OperationId:getHotelInterfaces
", + "operationId": "getHotelInterfaces", "parameters": [ { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "default": 0, - "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", - "name": "offset", - "in": "query" - }, - { + "name": "hotelIds", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "hotelIds", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "interfaceTypes", + "in": "query", "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, + "description": "XML Posting Interface", "items": { + "type": "string", "enum": [ "Bms", "Cas", @@ -2872,135 +2407,106 @@ "Vms", "Www", "Xml" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "XML Posting Interface", - "name": "interfaceTypes", - "in": "query" + "required": false }, { + "name": "logosCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "logoCodes", - "in": "query" + "required": false }, { - "type": "boolean", - "description": "If true this will set the criteria to include inactive records.", "name": "includeInactive", - "in": "query" + "in": "query", + "required": false, + "description": "If true this will set the criteria to include inactive records.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "includeOutboundCode", + "in": "query", + "required": false, + "description": "If true this will set the criteria to include interfaces that are configured to use outbound code.", + "type": "boolean" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for retrieving Hotel Interface Schemas.", - "schema": { - "$ref": "#/definitions/fetchedHotelInterfaceSchemas" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for retrieving Hotel Interfaces.", + "schema": { + "$ref": "#/definitions/fetchedHotelInterfaces" } }, "204": { - "description": "HotelInterfaceSchemas not found." + "description": "HotelInterfaces not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/interfaces/{interfaceId}/databases/{databaseId}/availableResorts": { - "get": { - "description": "OperationId:getExternalDatabaseAvailableProperties
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3009,159 +2515,102 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to fetch external database available properties.", - "operationId": "getExternalDatabaseAvailableProperties", - "parameters": [ - { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "OPERA Id for Databsase", - "name": "databaseId", - "in": "path", - "required": true - }, + ] + } + }, + "/hotels/{hotelId}/hotelInerface": { + "delete": { + "summary": "Operation to remove hotel interface.", + "description": "OperationId:deleteHotelInterface
", + "operationId": "deleteHotelInterface", + "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "OPERA Id for interface", - "name": "interfaceId", + "name": "hotelId", "in": "path", - "required": true - }, - { - "type": "boolean", - "description": "Flag that indicates to include inactive records.", - "name": "includeInactive", - "in": "query" - }, - { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "interfaceCodes", - "in": "query" + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 }, { - "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, - "collectionFormat": "multi", - "name": "hotelIds", - "in": "query" + "name": "logo", + "in": "query", + "required": false, + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for retrieving the Available properties for External Databases.", - "schema": { - "$ref": "#/definitions/fetchedExternalDatabaseAvailableProperties" - }, "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "ExternalDatabaseAvailableProperties not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/udfMappings": { - "get": { - "description": "Operation to send a response to the Look-up of UDFs.OperationId:getUDFMappings
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3170,125 +2619,118 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to send a response to the Look up of UDFs.", - "operationId": "getUDFMappings", + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceId}/accounts": { + "post": { + "summary": "Operation to create interface account.", + "description": "OperationId:postInterfaceAccount
", + "operationId": "postInterfaceAccount", "parameters": [ { + "name": "interfaceId", + "in": "path", + "required": true, "type": "string", - "description": "A reference to the type of object defined by the Type for Reservation and Profile Type.", - "name": "type", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" }, { + "name": "hotelId", + "in": "path", + "required": true, "type": "string", - "description": "Name of the user-defined function (UDF) field.", - "name": "uDFName", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "createInterfaceAccount", + "in": "body", + "required": true, + "description": "Request object for creating an Interface Account of a Hotel Interface record.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/createInterfaceAccount" + } + ] + } }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Message received on an UDFs Lookup.", - "schema": { - "$ref": "#/definitions/fetchedUDFMappings" - }, + "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": "Audience language" + "description": "Location of newly created resource" } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "UDFMappings not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Operation to send a response to the Change in UDF.OperationId:putUDFMapping
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3297,1430 +2739,7237 @@ ], "tags": [ "ExternalSystemsConfig" - ], - "summary": "Operation to send a response to the Change in UDF.", - "operationId": "putUDFMapping", + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceId}/accounts/{accountId}": { + "put": { + "summary": "Operation to change interface account.", + "description": "OperationId:putInterfaceAccount
", + "operationId": "putInterfaceAccount", "parameters": [ { - "description": "Self-contained Request object that is used when Updating UDFMapping.", - "name": "changeUDFMapping", + "name": "accountId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Account" + }, + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" + }, + { + "name": "changeInterfaceAccount", "in": "body", "required": true, + "description": "Request object for updating an Interface Account of a Hotel Interface record.", "schema": { "allOf": [ { - "$ref": "#/definitions/changeUDFMapping" + "$ref": "#/definitions/changeInterfaceAccount" } ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/changedUDFMapping" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedInterfaceAccount" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - } - }, - "definitions": { - "arDeliveryMethodType": { - "description": "Delivery Method configuration for Email and Fax Delivery for Accounts Receivables.", - "type": "object", - "properties": { - "email": { - "$ref": "#/definitions/emailDeliveryConfigurationType" - }, - "fax": { - "$ref": "#/definitions/faxDeliveryConfigurationType" - } - } - }, - "billingFolioDeliveryMethodType": { - "description": "Billing folio delivery method configuration, settings for Email and Fax Delivery of Guest Folios", - "type": "object", - "properties": { - "email": { - "$ref": "#/definitions/emailDeliveryConfigurationType" - }, - "fax": { - "$ref": "#/definitions/faxDeliveryConfigurationType" - } - } - }, - "changeDeliveryMethods": { - "description": "Request to change the delivery method for a property/HUB/Chain and its configurations.", - "type": "object", - "properties": { - "deliveryMethods": { - "description": "Collection of delivery method types to change.", - "$ref": "#/definitions/configuredExternalDeliveryMethodsType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "changeInterfaceRight": { - "description": "Request object for updating a Hotel Interface Right. It will create the Hotel Interface Right if it does not exist on the database.", - "type": "object", - "properties": { - "details": { - "$ref": "#/definitions/interfaceRightType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "changeUDFMapping": { - "description": "Self-contained Request object that is used when Updating UDFMapping.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ExternalSystemsConfig" + ] + }, + "delete": { + "summary": "Operation to remove interface account.", + "description": "OperationId:deleteInterfaceAccount
", + "operationId": "deleteInterfaceAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Account" + }, + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" + }, + { + "name": "autoBalance", + "in": "query", + "required": false, + "description": "Auto balance flag of postings setup.", + "type": "boolean" + }, + { + "name": "paymentMethod", + "in": "query", + "required": false, + "description": "Payment method of posting accounts in transaction codes setup.", + "type": "string" + }, + { + "name": "account", + "in": "query", + "required": false, + "description": "Account of posting accounts in transaction codes setup.", + "type": "string" + }, + { + "name": "accountDescription", + "in": "query", + "required": false, + "description": "Account description of posting accounts in transaction codes setup.", + "type": "string" + }, + { + "name": "salesOutlet", + "in": "query", + "required": false, + "description": "Sales outlet of posting accounts in transaction codes setup.", + "type": "string" + }, + { + "name": "trxCode", + "in": "query", + "required": false, + "description": "Transaction code of posting accounts in transaction codes setup.", + "type": "string" + }, + { + "name": "description", + "in": "query", + "required": false, + "description": "Description of posting accounts in transaction codes setup.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "ExternalSystemsConfig" + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceId}/roomStatus": { + "get": { + "summary": "Operation to fetch interface room statuses.", + "description": "OperationId:getInterfaceRoomStatuses
", + "operationId": "getInterfaceRoomStatuses", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Collection of Hotel Interface Room Statuses.", + "schema": { + "$ref": "#/definitions/fetchedInterfaceRoomStatuses" + } + }, + "204": { + "description": "InterfaceRoomStatuses 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": [ + "ExternalSystemsConfig" + ] + }, + "put": { + "summary": "Operation to change interface room status.", + "description": "OperationId:putInterfaceRoomStatus
", + "operationId": "putInterfaceRoomStatus", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "changeInterfaceRoomStatus", + "in": "body", + "required": true, + "description": "Request object for updating a Hotel Interface Room Status. If it does not exist, then creates the Hotel Interface Room Status.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeInterfaceRoomStatus" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedInterfaceRoomStatus" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ExternalSystemsConfig" + ] + }, + "delete": { + "summary": "Operation to remove interface room status.", + "description": "OperationId:deleteInterfaceRoomStatus
", + "operationId": "deleteInterfaceRoomStatus", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "entryCode", + "in": "query", + "required": false, + "description": "Entry code of a Hotel Interface Room Status.", + "type": "string" + }, + { + "name": "status", + "in": "query", + "required": false, + "description": "Room Status which is either Vacant (V) or Occupied (O).", + "type": "string" + }, + { + "name": "housekeepingStatus", + "in": "query", + "required": false, + "description": "Housekeeping status of a room.", + "type": "string" + }, + { + "name": "customRoomTranslation", + "in": "query", + "required": false, + "description": "Custom Room Translation of a Hotel Interface. It is a concatenation of a Status (V-Vacant or O-Occupied) and Housekeeping Status (IS-Inspected, CL-Clean, etc.) The delimiter is a period. Sample values are V.IS, V.CL, O.IS, O.CL.", + "type": "string" + }, + { + "name": "description", + "in": "query", + "required": false, + "description": "Description of the Hotel Interface Room Status.", + "type": "string" + }, + { + "name": "interfaceRoomStatusId", + "in": "query", + "required": false, + "description": "Row number to identify all the records belonging to a single group of Hotel Interface Room Status.", + "type": "integer" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "ExternalSystemsConfig" + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceId}/rooms": { + "get": { + "summary": "Operation to fetch interface rooms.", + "description": "OperationId:getInterfaceRooms
", + "operationId": "getInterfaceRooms", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" + }, + { + "name": "fromRoom", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "From Room Number" + }, + { + "name": "toRoom", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "To Room Number" + }, + { + "name": "fromLineType", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "From Line Type" + }, + { + "name": "toLineType", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "To Line Type" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Collection of Hotel Interface Rooms.", + "schema": { + "$ref": "#/definitions/fetchedInterfaceRooms" + } + }, + "204": { + "description": "InterfaceRooms 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": [ + "ExternalSystemsConfig" + ] + }, + "post": { + "summary": "Operation to create interface room.", + "description": "OperationId:postInterfaceRoom
", + "operationId": "postInterfaceRoom", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" + }, + { + "name": "createInterfaceRoom", + "in": "body", + "required": true, + "description": "Request object for creating an Interface Room of a Hotel Interface record.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/createInterfaceRoom" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "ExternalSystemsConfig" + ] + }, + "delete": { + "summary": "Operation to remove interface room.", + "description": "OperationId:deleteInterfaceRoom
", + "operationId": "deleteInterfaceRoom", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" + }, + { + "name": "roomType", + "in": "query", + "required": false, + "description": "Front Office Room Type.", + "type": "string" + }, + { + "name": "roomNumber", + "in": "query", + "required": false, + "description": "Front Office Room Number.", + "type": "string" + }, + { + "name": "lineNumber", + "in": "query", + "required": false, + "description": "External System's extension number.", + "type": "string" + }, + { + "name": "oldLineNumber", + "in": "query", + "required": false, + "description": "External System's extension number. It is used for editing a record. It is logically part of the record ID, and can actually be updated.", + "type": "string" + }, + { + "name": "type", + "in": "query", + "required": false, + "description": "Line Type of an Interface Room.", + "type": "string" + }, + { + "name": "dataLine", + "in": "query", + "required": false, + "type": "string", + "uniqueItems": true, + "enum": [ + "In", + "Out" + ], + "description": "Line Out" + }, + { + "name": "dataLineId", + "in": "query", + "required": false, + "description": "Translation Table Id as defined in the IFC_CTRL table. It is also referred as Xlat Id.", + "type": "string" + }, + { + "name": "wakeUpCall", + "in": "query", + "required": false, + "description": "Value to set/check if the wake up call funtionality is enabled/disabled for the particular line number.", + "type": "boolean" + }, + { + "name": "doNotDisturb", + "in": "query", + "required": false, + "type": "string", + "description": "Do Not Disturb is set to available and freely switchable.", + "uniqueItems": true, + "enum": [ + "NotAvailable", + "AlwaysOn", + "AlwaysOff", + "FreelySwitchable" + ] + }, + { + "name": "classOfService", + "in": "query", + "required": false, + "type": "string", + "description": "Class Of Service is set to available and freely switchable.", + "uniqueItems": true, + "enum": [ + "NotAvailable", + "AlwaysOn", + "AlwaysOff", + "FreelySwitchable" + ] + }, + { + "name": "directInwardDial", + "in": "query", + "required": false, + "type": "string", + "description": "Direct Inward Dial is set to available and freely switchable.", + "uniqueItems": true, + "enum": [ + "NotAvailable", + "AlwaysOn", + "AlwaysOff", + "FreelySwitchable" + ] + }, + { + "name": "messageWaiting", + "in": "query", + "required": false, + "type": "string", + "description": "Message Waiting is set to available and freely switchable.", + "uniqueItems": true, + "enum": [ + "NotAvailable", + "AlwaysOn", + "AlwaysOff", + "FreelySwitchable" + ] + }, + { + "name": "maskDialNumber", + "in": "query", + "required": false, + "type": "string", + "description": "Mask the dialled digits as per the room configuration.", + "uniqueItems": true, + "enum": [ + "NoMasking", + "MaskLast2Digits", + "MaskLast4Digits", + "Mask4DigitsLeaveLast2Intact", + "MaskAllExceptFirst2", + "MaskAll", + "MaskingPerRoom" + ] + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "ExternalSystemsConfig" + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceId}/rooms/import": { + "post": { + "summary": "Operation to import interface rooms.", + "description": "OperationId:importInterfaceRooms
", + "operationId": "importInterfaceRooms", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" + }, + { + "name": "importInterfaceRooms", + "in": "body", + "required": true, + "description": "Request object for importing the Interface Rooms for a Hotel Interface record.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/importInterfaceRooms" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "ExternalSystemsConfig" + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceId}/rooms/{roomId}": { + "put": { + "summary": "Operation to change interface room.", + "description": "OperationId:putInterfaceRoom
", + "operationId": "putInterfaceRoom", + "parameters": [ + { + "name": "roomId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" + }, + { + "name": "changeInterfaceRoom", + "in": "body", + "required": true, + "description": "Request object for updating an Interface Room of a Hotel Interface record.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeInterfaceRoom" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedInterfaceRoom" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ExternalSystemsConfig" + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceId}/unitCharges": { + "get": { + "summary": "Operation to fetch interface unit charges.", + "description": "OperationId:getInterfaceUnitCharges
", + "operationId": "getInterfaceUnitCharges", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "logo", + "in": "query", + "required": false, + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 retrieving the Interface Unit Charges.", + "schema": { + "$ref": "#/definitions/fetchedInterfaceUnitCharges" + } + }, + "204": { + "description": "InterfaceUnitCharges 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": [ + "ExternalSystemsConfig" + ] + }, + "put": { + "summary": "Operation to change interface unit charges.", + "description": "OperationId:putInterfaceUnitCharges
", + "operationId": "putInterfaceUnitCharges", + "parameters": [ + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA id for Property" + }, + { + "name": "changeInterfaceUnitCharges", + "in": "body", + "required": true, + "description": "Request object for updating Hotel Interface Unit Charges.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeInterfaceUnitCharges" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedInterfaceUnitCharges" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ExternalSystemsConfig" + ] + } + }, + "/hotels/{hotelId}/logos/{logo}": { + "get": { + "summary": "Operation to fetch hotel interface details.", + "description": "OperationId:getHotelInterfaceDetails
", + "operationId": "getHotelInterfaceDetails", + "parameters": [ + { + "name": "logo", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Property" + }, + { + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, + "description": "Transaction codes of a Hotel Interface.", + "items": { + "type": "string", + "enum": [ + "PrimaryInfo", + "AdditionalInfo", + "GeneralInfo", + "CommunicationInfo", + "IfcTranslation", + "IfcClassOfService", + "IfcImportRooms", + "WorkstationSetupInfo", + "PostingsInfo", + "CustomDataInfo", + "ExportDataInfo", + "TransactionCodesInfo" + ] + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 retrieving the details of a Hotel Interface.", + "schema": { + "$ref": "#/definitions/fetchedHotelInterfaceDetails" + } + }, + "204": { + "description": "HotelInterfaceDetails 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": [ + "ExternalSystemsConfig" + ] + } + }, + "/interfaceControllerRegistry": { + "get": { + "summary": "Operation to fetch hotel interface controller registry.", + "description": "OperationId:getHotelInterfaceControllerRegistry
", + "operationId": "getHotelInterfaceControllerRegistry", + "parameters": [ + { + "name": "machine", + "in": "query", + "required": false, + "type": "string", + "description": "Used for Character Strings, length 0 to 40." + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 retrieving Hotel Interface Controller Registry.", + "schema": { + "$ref": "#/definitions/fetchedHotelInterfaceControllerRegistry" + } + }, + "204": { + "description": "HotelInterfaceControllerRegistry 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": [ + "ExternalSystemsConfig" + ] + } + }, + "/interfaceErrors": { + "get": { + "summary": "Operation to fetch hotel interface errors.", + "description": "OperationId:getHotelInterfaceErrors
", + "operationId": "getHotelInterfaceErrors", + "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", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "interfaceTypes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, + "description": "XML Posting Interface", + "items": { + "type": "string", + "enum": [ + "Bms", + "Cas", + "Ccw", + "Dls", + "Eft", + "Exp", + "Mak", + "Mbs", + "Msc", + "Pbx", + "Pos", + "Svs", + "Tik", + "Vid", + "Vms", + "Www", + "Xml" + ] + }, + "required": false + }, + { + "name": "logoCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "If true this will set the criteria to include inactive records.", + "type": "boolean" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 retrieving Hotel Interface Errors.", + "schema": { + "$ref": "#/definitions/fetchedHotelInterfaceErrors" + } + }, + "204": { + "description": "HotelInterfaceErrors 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": [ + "ExternalSystemsConfig" + ] + } + }, + "/interfaceFailedMessages": { + "get": { + "summary": "Operation to fetch hotel interface failed messages.", + "description": "OperationId:getHotelInterfaceFailedMessages
", + "operationId": "getHotelInterfaceFailedMessages", + "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", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "interfaceTypes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, + "description": "XML Posting Interface", + "items": { + "type": "string", + "enum": [ + "Bms", + "Cas", + "Ccw", + "Dls", + "Eft", + "Exp", + "Mak", + "Mbs", + "Msc", + "Pbx", + "Pos", + "Svs", + "Tik", + "Vid", + "Vms", + "Www", + "Xml" + ] + }, + "required": false + }, + { + "name": "logoCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "If true this will set the criteria to include inactive records.", + "type": "boolean" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 retrieving Hotel Interface Failed Messages.", + "schema": { + "$ref": "#/definitions/fetchedHotelInterfaceFailedMessages" + } + }, + "204": { + "description": "HotelInterfaceFailedMessages 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": [ + "ExternalSystemsConfig" + ] + } + }, + "/interfaceRights": { + "put": { + "summary": "Operation to change interface right.", + "description": "OperationId:putInterfaceRight
", + "operationId": "putInterfaceRight", + "parameters": [ + { + "name": "changeInterfaceRight", + "in": "body", + "required": true, + "description": "Request object for updating a Hotel Interface Right. It will create the Hotel Interface Right if it does not exist on the database.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeInterfaceRight" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedInterfaceRight" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ExternalSystemsConfig" + ] + }, + "delete": { + "summary": "Operation to remove interface right.", + "description": "OperationId:deleteInterfaceRight
", + "operationId": "deleteInterfaceRight", + "parameters": [ + { + "name": "hotelId", + "in": "query", + "required": false, + "description": "Hotel Code to which the Interface Right belongs to.", + "type": "string" + }, + { + "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": "idExtension", + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" + }, + { + "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": "right", + "in": "query", + "required": false, + "description": "Internal code for each allowed right of a Hotel Interface record.", + "type": "integer" + }, + { + "name": "code", + "in": "query", + "required": false, + "description": "User defined code for an Interface Right.", + "type": "string" + }, + { + "name": "description", + "in": "query", + "required": false, + "description": "User defined description for an Interface Right.", + "type": "string" + }, + { + "name": "interfaceRightDescription", + "in": "query", + "required": false, + "description": "System Description of an allowed Interface Right.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "ExternalSystemsConfig" + ] + }, + "get": { + "summary": "Operation to fetch interface rights.", + "description": "OperationId:getInterfaceRights
", + "operationId": "getInterfaceRights", + "parameters": [ + { + "name": "hotelId", + "in": "query", + "required": false, + "type": "string", + "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." + }, + { + "name": "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": "idExtension", + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" + }, + { + "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/x-app-key" + }, + { + "$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": "Collection of Hotel Interface Tasks.", + "schema": { + "$ref": "#/definitions/fetchedInterfaceRights" + } + }, + "204": { + "description": "InterfaceRights 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": [ + "ExternalSystemsConfig" + ] + } + }, + "/interfaceSchemas": { + "get": { + "summary": "Operation to fetch hotel interface schemas.", + "description": "OperationId:getHotelInterfaceSchemas
", + "operationId": "getHotelInterfaceSchemas", + "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", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "interfaceTypes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, + "description": "XML Posting Interface", + "items": { + "type": "string", + "enum": [ + "Bms", + "Cas", + "Ccw", + "Dls", + "Eft", + "Exp", + "Mak", + "Mbs", + "Msc", + "Pbx", + "Pos", + "Svs", + "Tik", + "Vid", + "Vms", + "Www", + "Xml" + ] + }, + "required": false + }, + { + "name": "logoCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "If true this will set the criteria to include inactive records.", + "type": "boolean" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 retrieving Hotel Interface Schemas.", + "schema": { + "$ref": "#/definitions/fetchedHotelInterfaceSchemas" + } + }, + "204": { + "description": "HotelInterfaceSchemas 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": [ + "ExternalSystemsConfig" + ] + } + }, + "/interfaces/{interfaceId}/databases/{databaseId}/availableResorts": { + "get": { + "summary": "Operation to fetch external database available properties.", + "description": "OperationId:getExternalDatabaseAvailableProperties
", + "operationId": "getExternalDatabaseAvailableProperties", + "parameters": [ + { + "name": "databaseId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for Databsase" + }, + { + "name": "interfaceId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for interface" + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Flag that indicates to include inactive records.", + "type": "boolean" + }, + { + "name": "interfaceCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 retrieving the Available properties for External Databases.", + "schema": { + "$ref": "#/definitions/fetchedExternalDatabaseAvailableProperties" + } + }, + "204": { + "description": "ExternalDatabaseAvailableProperties 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": [ + "ExternalSystemsConfig" + ] + } + }, + "/machines": { + "get": { + "summary": "Operation to fetch interface machines.", + "description": "OperationId:getInterfaceMachines
", + "operationId": "getInterfaceMachines", + "parameters": [ + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Collection of Hotel Interface Machines.", + "schema": { + "$ref": "#/definitions/fetchedInterfaceMachines" + } + }, + "204": { + "description": "InterfaceMachines 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": [ + "ExternalSystemsConfig" + ] + } + }, + "/machines/{machineId}": { + "put": { + "summary": "Operation to change interface machine.", + "description": "OperationId:putInterfaceMachine
", + "operationId": "putInterfaceMachine", + "parameters": [ + { + "name": "machineId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for machine" + }, + { + "name": "changeInterfaceMachine", + "in": "body", + "required": true, + "description": "Request object for updating a Hotel Interface Machine. If it does not exist, then creates the Hotel Interface Machine.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeInterfaceMachine" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedInterfaceMachine" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ExternalSystemsConfig" + ] + }, + "delete": { + "summary": "Operation to remove interface machine.", + "description": "OperationId:deleteInterfaceMachine
", + "operationId": "deleteInterfaceMachine", + "parameters": [ + { + "name": "machineId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "OPERA Id for machine" + }, + { + "name": "machine", + "in": "query", + "required": false, + "description": "Unique Machine name of the running Interface.", + "type": "string" + }, + { + "name": "program", + "in": "query", + "required": false, + "description": "Path and name of the Interface program running on every Machine.", + "type": "string" + }, + { + "name": "controllerPort", + "in": "query", + "required": false, + "description": "Opera Interface controller (server) port for the connecting clients.", + "type": "integer" + }, + { + "name": "vncPort", + "in": "query", + "required": false, + "description": "VNC server port for connecting to the VNC server.", + "type": "integer" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "ExternalSystemsConfig" + ] + } + }, + "/udfMappings": { + "get": { + "summary": "Operation to send a response to the Look up of UDFs.", + "description": "Operation to send a response to the Look-up of UDFs.OperationId:getUDFMappings
", + "operationId": "getUDFMappings", + "parameters": [ + { + "name": "type", + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the Type for Reservation and Profile Type.", + "type": "string" + }, + { + "name": "uDFName", + "in": "query", + "required": false, + "description": "Name of the user-defined function (UDF) field.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Message received on an UDFs Lookup.", + "schema": { + "$ref": "#/definitions/fetchedUDFMappings" + } + }, + "204": { + "description": "UDFMappings 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": [ + "ExternalSystemsConfig" + ] + }, + "put": { + "summary": "Operation to send a response to the Change in UDF.", + "description": "Operation to send a response to the Change in UDF.OperationId:putUDFMapping
", + "operationId": "putUDFMapping", + "parameters": [ + { + "name": "changeUDFMapping", + "in": "body", + "required": true, + "description": "Self-contained Request object that is used when Updating UDFMapping.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeUDFMapping" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "schema": { + "$ref": "#/definitions/changedUDFMapping" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ExternalSystemsConfig" + ] + } + } + }, + "parameters": { + "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-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": 80, + "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": { + "status": { + "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "properties": { + "warnings": { + "$ref": "#/definitions/warningsType" + }, + "links": { + "$ref": "#/definitions/links" + } + } + }, + "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 + } + } + }, + "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" + } + }, + "required": [ + "href", + "rel", + "method", + "operationId" + ] + }, + "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" + ] + }, + "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" + } + } + }, + "operaVersionNumberType": { + "type": "string", + "description": "Current Opera Version Number", + "minLength": 0, + "maxLength": 40 + }, + "fetchedDeliveryMethods": { + "type": "object", + "description": "Response to request to fetch the delivery method for a property/HUB/Chain and its configurations.", + "properties": { + "deliveryMethods": { + "description": "Collection of all delivery method types.", + "$ref": "#/definitions/configuredExternalDeliveryMethodsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "configuredExternalDeliveryMethodsType": { + "type": "object", + "description": "External system configuration delivery methods for a property(chain or hub).", + "properties": { + "general": { + "$ref": "#/definitions/generalDeliveryMethodType" + }, + "queueReservation": { + "$ref": "#/definitions/queueReservationDeliveryMethodType" + }, + "confirmation": { + "$ref": "#/definitions/confirmationDeliveryMethodType" + }, + "guestMessage": { + "$ref": "#/definitions/guestMessageDeliveryMethodType" + }, + "billingFolio": { + "$ref": "#/definitions/billingFolioDeliveryMethodType" + }, + "queueRush": { + "$ref": "#/definitions/queueRushDeliveryMethodType" + }, + "ar": { + "$ref": "#/definitions/arDeliveryMethodType" + }, + "otherFolios": { + "$ref": "#/definitions/otherFolioDeliveryMethodType" + } + } + }, + "generalDeliveryMethodType": { + "type": "object", + "description": "General delivery method SFTPConfigurationType configuration, settings for Email and Fax Delivery of General Letters", + "properties": { + "email": { + "$ref": "#/definitions/emailDeliveryConfigurationType" + }, + "fax": { + "$ref": "#/definitions/faxDeliveryConfigurationType" + }, + "sftpConfigurations": { + "$ref": "#/definitions/sftpConfigurationsListType" + } + } + }, + "emailDeliveryConfigurationType": { + "type": "object", + "description": "Email content configuration template", + "properties": { + "fromAddress": { + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "userId": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "userPassword": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "serverName": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "subject": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "body": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "format": { + "description": "EMAIL Format: HTML, RTF, PDF. Fax Format: TIF", + "$ref": "#/definitions/emailDeliveryFormatType" + }, + "type": { + "description": "Deliver Type, possible values: AR, BILLING, CONFIRMATION, LEADS, OWS, OVOS.", + "$ref": "#/definitions/emailDeliveryMethodType" + }, + "hotelId": { + "description": "Hotel code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "activateDelivery": { + "description": "This option must be selected in order to activate emailing from an SMTP compliant email server", + "type": "boolean" + }, + "hTMLFormatDelivery": { + "description": "Available for Confirmation Letters only and when Activate Email Delivery is selected", + "type": "boolean" + }, + "attachICalender": { + "type": "boolean" + } + } + }, + "emailDeliveryFormatType": { + "type": "string", + "description": "Email delivery format", + "enum": [ + "Htmlcss", + "Pdf", + "Rtf", + "Tif" + ] + }, + "emailDeliveryMethodType": { + "type": "string", + "description": "Email delivery method type", + "enum": [ + "Billing", + "Confirmation", + "General", + "Other", + "AR" + ] + }, + "faxDeliveryConfigurationType": { + "type": "object", + "description": "Email content configuration template", + "properties": { + "fromAddress": { + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "userId": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "userPassword": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "serverName": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "subject": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "body": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "format": { + "description": "EMAIL Format: HTML, RTF, PDF. Fax Format: TIF", + "$ref": "#/definitions/emailDeliveryFormatType" + }, + "type": { + "description": "Deliver Type, possible values: AR, BILLING, CONFIRMATION, LEADS, OWS, OVOS.", + "$ref": "#/definitions/emailDeliveryMethodType" + }, + "hotelId": { + "description": "Hotel code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "faxPrefix": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "faxSuffix": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "faxDomain": { + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "activateEmailToFax": { + "description": "This option must be selected in order to activate faxing from an SMTP compliant fax server", + "type": "boolean" + } + } + }, + "sftpConfigurationsListType": { + "type": "array", + "description": "Type that holds sftp configurations", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/sftpConfigurationType" + } + }, + "sftpConfigurationType": { + "type": "object", + "description": "Information which uniquely identifies SFTP Configuration", + "properties": { + "configurationId": { + "description": "Unique id associated with this configuration", + "type": "integer" + }, + "destination": { + "description": "SFTP destination", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "Description of the destination, such as Shift Reports.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "inactive": { + "description": "Indicates whether the configuration is inactive or not.", + "type": "boolean" + }, + "hotelId": { + "description": "Hotel code", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "queueReservationDeliveryMethodType": { + "type": "object", + "description": "Queue reservation delivery method configuration, settings for Text Message Delivery of Queue Reservation status", + "properties": { + "textMessage": { + "$ref": "#/definitions/textMessageDeliveryConfigurationType" + } + } + }, + "textMessageDeliveryConfigurationType": { + "type": "object", + "description": "Text message delivery configuration", + "properties": { + "userId": { + "description": "Partner or User ID, Text field for Partner ID or User ID for the delivery provider, Name of the Text Messaging Provider.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "serverName": { + "description": "Text field for Service type or email server address for the SMTP.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "account": { + "description": "Text field for Service ID or email account for the SMTP as advised by Text Messaging Provider.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "password": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "timeOut": { + "description": "Number field for Delivery time out in seconds for the message. Any message exceeding this limit will be timed out. Add word Seconds using small grey font next to the number box.", + "type": "integer" + }, + "url": { + "description": "Text field for URL address or the Text Messaging Provider.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "uRLParameter": { + "description": "Url parameter(format) is supported by Text Messaging Provider, it can be either an XML or TEXT format.", + "$ref": "#/definitions/urlFormatType" + }, + "format": { + "description": "Text field for entering any special formatting for the delivery, or multi select LOV type, for example the one used for Address Format for selection of SID fields, to allow users choosing from a list of tags that may be used to customize this field.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "message": { + "description": "Text field for entering the Text Message for delivery.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "type": { + "description": "Type of Delivery Method HTTP/SMTP: HTTP for URL, SMTP for Email", + "$ref": "#/definitions/textDeliveryMethodType" + }, + "hotelId": { + "description": "Hotel code", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "urlFormatType": { + "type": "string", + "description": "Url content format", + "enum": [ + "Xml", + "Text" + ] + }, + "textDeliveryMethodType": { + "type": "string", + "description": "Text delivery method type", + "enum": [ + "Url", + "Email" + ] + }, + "confirmationDeliveryMethodType": { + "type": "object", + "description": "Confirmation letter delivery method configuration, settings for Text Message, Email and Fax Delivery of Confirmation Letters", + "properties": { + "email": { + "$ref": "#/definitions/emailDeliveryConfigurationType" + }, + "fax": { + "$ref": "#/definitions/faxDeliveryConfigurationType" + }, + "textMessage": { + "$ref": "#/definitions/textMessageDeliveryConfigurationType" + } + } + }, + "guestMessageDeliveryMethodType": { + "type": "object", + "description": "Guest text message configuration, settings for Text Message Delivery of Guest Messages", + "properties": { + "textMessage": { + "$ref": "#/definitions/textMessageDeliveryConfigurationType" + } + } + }, + "billingFolioDeliveryMethodType": { + "type": "object", + "description": "Billing folio delivery method configuration, settings for Email and Fax Delivery of Guest Folios", + "properties": { + "email": { + "$ref": "#/definitions/emailDeliveryConfigurationType" + }, + "fax": { + "$ref": "#/definitions/faxDeliveryConfigurationType" + } + } + }, + "queueRushDeliveryMethodType": { + "type": "object", + "description": "Queue rush delivery method configuration, settings for Text Message Delivery of Queue Reservation status", + "properties": { + "textMessage": { + "$ref": "#/definitions/textMessageDeliveryConfigurationType" + } + } + }, + "changeDeliveryMethods": { + "type": "object", + "description": "Request to change the delivery method for a property/HUB/Chain and its configurations.", + "properties": { + "deliveryMethods": { + "description": "Collection of delivery method types to change.", + "$ref": "#/definitions/configuredExternalDeliveryMethodsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "changedDeliveryMethods": { + "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "properties": { + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "createDeliveryMethods": { + "type": "object", + "description": "Request to create the delivery method for a property/HUB/Chain and its configurations.", + "properties": { + "deliveryMethods": { + "description": "Collection of delivery method types to create.", + "$ref": "#/definitions/configuredExternalDeliveryMethodsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "templateDeviceLocationsDetails": { + "type": "object", + "description": "Response object for fetching template Device locations.", + "properties": { + "templateDeviceLocations": { + "description": "Collection of template Device locations.", + "$ref": "#/definitions/templateDeviceLocationsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "templateDeviceLocationsType": { + "type": "array", + "description": "List of Device locations at template level.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/templateDeviceLocationType" + } + }, + "templateDeviceLocationType": { + "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" + } + } + }, + "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", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + } + }, + "description": "Language code for the translation." + } + }, + "templateDeviceLocationsCriteria": { + "type": "object", + "description": "Request object for creating template Device locations.", + "properties": { + "templateDeviceLocations": { + "description": "Template Device locations to be created.", + "$ref": "#/definitions/templateDeviceLocationsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "templateDeviceLocationsToBeChanged": { + "type": "object", + "description": "Request object for changing template Device locations.", + "properties": { + "templateDeviceLocations": { + "description": "Template Device locations to be changed.", + "$ref": "#/definitions/templateDeviceLocationsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "createPublishers": { + "type": "object", + "description": "Request to create publishers.", + "properties": { + "subscriber": { + "description": "Subcriber external system information.", + "$ref": "#/definitions/externalSystemType" + }, + "publishers": { + "description": "Collection of publisher external systems information.", + "$ref": "#/definitions/publishersType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "externalSystemType": { + "type": "object", + "description": "External System Information", + "properties": { + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "externalSystemCode": { + "$ref": "#/definitions/externalSystemCodeType" + } + } + }, + "externalSystemCodeType": { + "type": "object", + "description": "External System Code", + "properties": { + "code": { + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "publishersType": { + "type": "array", + "description": "Information of all the publishers for a given subscriber.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/externalSystemType" + } + }, + "fetchedPublishers": { + "type": "object", + "description": "Response to request to fetch the external systems", + "properties": { + "publishers": { + "description": "Collection of publisher external systems information.", + "$ref": "#/definitions/publishersType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "fetchedHotelInterfaces": { + "type": "object", + "description": "Response object for retrieving Hotel Interfaces.", + "properties": { + "hotelInterfaces": { + "description": "Collection of Hotel Interfaces.", + "$ref": "#/definitions/hotelInterfacesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "hotelInterfacesType": { + "type": "array", + "description": "Collection of Hotel Interfaces.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelInterfaceType" + } + }, + "hotelInterfaceType": { + "type": "object", + "properties": { + "interfaceId": { + "description": "Unique DB internal number of a Hotel Interface record.", + "$ref": "#/definitions/uniqueID_Type" + }, + "hotelId": { + "description": "Hotel Code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "interfaceName": { + "description": "Name of the Hotel Interface", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "interfaceType": { + "description": "Three letter code for each interface that identifies the interface.", + "$ref": "#/definitions/hotelInterfaceTypeType" + }, + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "machineName": { + "description": "Unique machine name of the running IFC.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "status": { + "description": "The current status of the IFC.", + "$ref": "#/definitions/hotelInterfaceStatusType" + }, + "activeFlag": { + "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", + "type": "boolean" + }, + "outboundCode": { + "description": "Stores the Outbound Code to identify the target system.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "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 + } + } + }, + "hotelInterfaceTypeType": { + "type": "string", + "enum": [ + "Bms", + "Cas", + "Ccw", + "Dls", + "Eft", + "Exp", + "Mak", + "Mbs", + "Msc", + "Pbx", + "Pos", + "Svs", + "Tik", + "Vid", + "Vms", + "Www", + "Xml" + ], + "description": "XML Posting Interface" + }, + "hotelInterfaceStatusType": { + "type": "string", + "description": "Status of the Hotel Interface either STOPPED or RUNNING.", + "enum": [ + "Stopped", + "Running", + "Waiting", + "StopInitiated", + "StartInitiated", + "RebootInitiated", + "Other" + ] + }, + "changeInterfaceRight": { + "type": "object", + "description": "Request object for updating a Hotel Interface Right. It will create the Hotel Interface Right if it does not exist on the database.", + "properties": { + "details": { + "$ref": "#/definitions/interfaceRightType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "interfaceRightType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Hotel Code to which the Interface Right belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "interfaceId": { + "description": "Unique DB internal number of a Hotel Interface record.", + "$ref": "#/definitions/uniqueID_Type" + }, + "right": { + "description": "Internal code for each allowed right of a Hotel Interface record.", + "type": "integer" + }, + "code": { + "description": "User defined code for an Interface Right.", + "type": "string", + "minLength": 0, + "maxLength": 5 + }, + "description": { + "description": "User defined description for an Interface Right.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "interfaceRightDescription": { + "description": "System Description of an allowed Interface Right.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "changedInterfaceRight": { + "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "properties": { + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "fetchedInterfaceRights": { + "type": "array", + "description": "Collection of Hotel Interface Rights.", + "items": { + "$ref": "#/definitions/interfaceRightType" + } + }, + "fetchedExternalDatabaseAvailableProperties": { + "type": "object", + "description": "Response object for retrieving the Available properties for External Databases.", + "properties": { + "availailableProperties": { + "$ref": "#/definitions/externalDatabaseAssociatedHotelsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "externalDatabaseAssociatedHotelsType": { + "type": "array", + "description": "Collection of Hotel for external database.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/externalDatabaseAssociatedHotelType" + } + }, + "externalDatabaseAssociatedHotelType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Pertain associated hotel code for external database.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelName": { + "description": "Pertain associated hotel code for external database.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "fetchedUDFMappings": { + "type": "object", + "description": "Message received on an UDFs Lookup.", + "properties": { + "uDFMappings": { + "description": "Criteria for fetching UDFs.", + "type": "array", + "items": { + "$ref": "#/definitions/uDFMappingType" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "uDFMappingType": { + "type": "object", + "description": "Generic self-contained request object that is used when updating and fetching UDFs.", + "properties": { + "uDFName": { + "description": "Name of the user-defined function (UDF) field.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "uDFLabel": { + "description": "Label the user-defined function (UDF) field shared with external system which will be send in the request message for mapping of actual UDF Name.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "active": { + "description": "A flag to indicate whether the UDF mapping is active in the Interface system or not.", + "type": "boolean" + }, + "updateAllowed": { + "description": "A flag to indicate whether the update is allowed in the Interface system or not.", + "type": "boolean" + }, + "type": { + "description": "A reference to the type of object defined by the Type for Reservation and Profile Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "changeUDFMapping": { + "type": "object", + "description": "Self-contained Request object that is used when Updating UDFMapping.", + "properties": { "uDFMapping": { "$ref": "#/definitions/uDFMappingType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "changedUDFMapping": { + "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "properties": { + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "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" + } + } + }, + "logicalOperatorType": { + "type": "string", + "enum": [ + "And", + "Or" + ] + }, + "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": 40 + }, + "tableName": { + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "virtual": { + "type": "boolean" + }, + "dataType": { + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "lovSelected": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "expressionParameterType": { + "type": "object", + "properties": { + "parameter": { + "type": "array", + "maxItems": 3, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 40 + } + }, + "functionIdOne": { + "type": "number" + }, + "functionIdTwo": { + "type": "number" + } + } + }, + "expressionOperatorType": { + "type": "object", + "properties": { + "operatorName": { + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "operatorDescription": { + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "parameterSize": { + "type": "number" + } + } + }, + "hotelInterfaceSchemasType": { + "type": "array", + "description": "Collection of Hotel Interface Schemas.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelInterfaceSchemaType" + } + }, + "hotelInterfaceSchemaType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Hotel Code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "actionName": { + "description": "Action Name", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "schemaName": { + "description": "Schema Name", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "schema": { + "description": "Schema", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "insertDate": { + "description": "Date time stamp of a Hotel Interface Schema.", + "type": "string", + "format": "date-time" + }, + "ifcType": { + "description": "ifcType", + "type": "string", + "minLength": 0, + "maxLength": 4000 + } + } + }, + "hotelInterfaceErrorsType": { + "type": "array", + "description": "Collection of Hotel Interface Errors.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelInterfaceErrorType" + } + }, + "hotelInterfaceErrorType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Hotel Code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "actionName": { + "description": "Action Name", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "message": { + "description": "Message", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "error": { + "description": "Error", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "resvNameId": { + "description": "Schema", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "insertDate": { + "description": "Date time stamp of a Hotel Interface Schema.", + "type": "string", + "format": "date-time" + }, + "ifcType": { + "description": "ifcType", + "type": "string", + "minLength": 0, + "maxLength": 4000 + } + } + }, + "hotelInterfaceFailedMessagesType": { + "type": "array", + "description": "Collection of Hotel Interface Failed Messages.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelInterfaceFailedMessageType" + } + }, + "hotelInterfaceFailedMessageType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Hotel Code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "actionName": { + "description": "Action Name", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "message": { + "description": "Message", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "insertDate": { + "description": "Date time stamp of a Hotel Interface Schema.", + "type": "string", + "format": "date-time" + }, + "ifcType": { + "description": "ifcType", + "type": "string", + "minLength": 0, + "maxLength": 4000 + } + } + }, + "hotelInterfaceControllerRegsType": { + "type": "array", + "description": "Collection of Hotel Interface Controller Registry.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelInterfaceControllerRegType" + } + }, + "hotelInterfaceControllerRegType": { + "type": "object", + "properties": { + "id": { + "description": "Internal ID to reference the records.", + "type": "number" + }, + "machine": { + "description": "Machine Name", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "cntrlRegSetting": { + "description": "Controller Registry Setting", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "data": { + "description": "Data", + "type": "string", + "minLength": 0, + "maxLength": 400 + }, + "description": { + "description": "Description", + "type": "string", + "minLength": 0, + "maxLength": 4000 + } + } + }, + "fetchedHotelInterfaceSchemas": { + "type": "object", + "description": "Response object for retrieving Hotel Interface Schemas.", + "properties": { + "schemas": { + "description": "Collection of Hotel Interface Schemas.", + "$ref": "#/definitions/hotelInterfaceSchemasType" + }, + "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" + } + } + }, + "fetchedHotelInterfaceErrors": { + "type": "object", + "description": "Response object for retrieving Hotel Interface Errors.", + "properties": { + "hotelInterfaceErrors": { + "description": "Collection of Hotel Interface Errors.", + "$ref": "#/definitions/hotelInterfaceErrorsType" + }, + "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" + } + } + }, + "fetchedHotelInterfaceFailedMessages": { + "type": "object", + "description": "Response object for retrieving Hotel Interface Failed Messages.", + "properties": { + "messages": { + "description": "Collection of Hotel Interface Failed Messages.", + "$ref": "#/definitions/hotelInterfaceFailedMessagesType" + }, + "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" + } + } + }, + "fetchedHotelInterfaceControllerRegistry": { + "type": "object", + "description": "Response object for retrieving Hotel Interface Controller Registry.", + "properties": { + "reg": { + "description": "Collection of Hotel Interface Controller Registry.", + "$ref": "#/definitions/hotelInterfaceControllerRegsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "arDeliveryMethodType": { + "type": "object", + "description": "Delivery Method configuration for Email and Fax Delivery for Accounts Receivables.", + "properties": { + "email": { + "$ref": "#/definitions/emailDeliveryConfigurationType" + }, + "fax": { + "$ref": "#/definitions/faxDeliveryConfigurationType" + } + } + }, + "otherFolioDeliveryMethodType": { + "type": "object", + "description": "Delivery Method configuration for Email and Fax Delivery for Other Folios", + "properties": { + "email": { + "$ref": "#/definitions/emailDeliveryConfigurationType" + }, + "fax": { + "$ref": "#/definitions/faxDeliveryConfigurationType" + } + } + }, + "configuredExternalDevices": { + "type": "object", + "description": "Collection of hotels and the external devices that were configured for the hotel.", + "properties": { + "deviceType": { + "$ref": "#/definitions/deviceType" + }, + "supportedExternalDevices": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelExternalDevicesType" + } + } + } + }, + "deviceType": { + "type": "string", + "enum": [ + "Scanner", + "CreditCard", + "Fiscal", + "Device" + ] + }, + "hotelExternalDevicesType": { + "type": "object", + "description": "Type for the external device supported by the hotel.", + "properties": { + "hotelId": { + "description": "Property for which the device is configured.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "supportedDevices": { + "$ref": "#/definitions/supportedExternalDevicesType" + } + } + }, + "supportedExternalDevicesType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/supportedExternalDeviceType" + } + }, + "supportedExternalDeviceType": { + "type": "object", + "properties": { + "deviceType": { + "description": "Internal device type used to identify in which group the external device belongs to.", + "$ref": "#/definitions/deviceType" + }, + "deviceCode": { + "description": "Internal device code used to identify the external device.", + "$ref": "#/definitions/deviceCode" + }, + "deviceArea": { + "description": "The area where the device is installed", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "displayName": { + "description": "External device display name.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "mobileYN": { + "description": "Indicator if device type is mobile or desktop.", + "type": "boolean" + }, + "desktopYN": { + "description": "Indicator if device type is mobile or desktop.", + "type": "boolean" + }, + "registerAddress": { + "description": "The address which the Cash Register ID ( Device ID ) is associated with.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "deviceValue": { + "description": "External device Value.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "fiscalPartnerCode": { + "description": "Fiscal Partner associated with the terminal.", + "$ref": "#/definitions/fiscalPartnerCodeType" + }, + "primary": { + "description": "Flag to designate the primary Fiscal Terminal.", + "type": "boolean" + }, + "active": { + "description": "Flag that indicates whether the device is active.", + "type": "boolean" + }, + "id": { + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "label": { + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "translatableLabel": { + "description": "Translatable Label for the external devices.", + "$ref": "#/definitions/translationTextType2000" + }, + "iDEditable": { + "type": "boolean" + } + }, + "description": "External device details." + }, + "fiscalPartnerCodeType": { + "type": "string", + "description": "Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", + "maxLength": 100, + "minLength": 0 + }, + "deviceCode": { + "type": "string", + "enum": [ + "TtiScannerMobile", + "TtiScannerDesktop", + "SamsotechScanner", + "GenScannerDesktop", + "GenScannerMobile", + "ChipAndPin", + "FiscalTerminal", + "Device" + ] + }, + "externalDeviceConfigurationType": { + "type": "object", + "description": "Type for the configurations available to the device.", + "properties": { + "hotelId": { + "description": "Property for which the device is configured.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "device": { + "description": "External device.", + "$ref": "#/definitions/supportedExternalDeviceType" + }, + "deviceConfigurations": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/deviceConfigurationType" + } + }, + "codeMappings": { + "description": "Type that contains the mappings of the codes used in the external device to the code used in OPERA.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/deviceMappingType" + } } } }, - "changedDeliveryMethods": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "deviceMappingType": { "type": "object", + "description": "Type that contains the codes used in/provided by the external device and their counterpart in OPERA.", "properties": { - "links": { - "$ref": "#/definitions/links" + "codeType": { + "description": "Internal code type of the mapping entry.", + "type": "string", + "minLength": 0, + "maxLength": 800 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "externalCode": { + "description": "Code used/provided by the external device or application.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "displayName": { + "description": "Display name of the code mapping.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "operaCode": { + "description": "Corresponding code value in OPERA.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "changedInterfaceRight": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "deviceConfigurationType": { "type": "object", + "description": "Type that contains the parameters and configurations used by the device.", "properties": { - "links": { - "$ref": "#/definitions/links" + "name": { + "description": "Internal name of the configuration.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "displayName": { + "description": "Configuration display name.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "value": { + "description": "Value of the configuration.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "required": { + "description": "Flag that indicates whether the configuration is required or not.", + "type": "boolean" + }, + "encrypted": { + "description": "Flag that indicates whether the configuration value should be encrypted or not.", + "type": "boolean" } } }, - "changedUDFMapping": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "hotelInterfaceDetailType": { "type": "object", "properties": { - "links": { - "$ref": "#/definitions/links" + "primaryInfo": { + "description": "Primary information of a Hotel Interface.", + "$ref": "#/definitions/interfacePrimaryInfoType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "additionalInfo": { + "description": "Additional information of a Hotel Interface.", + "$ref": "#/definitions/interfaceAdditionalInfoType" + }, + "generalInfo": { + "description": "General information of a Hotel Interface.", + "$ref": "#/definitions/generalInfoType" + }, + "communicationInfo": { + "description": "Communication related information of a Hotel Interface.", + "$ref": "#/definitions/interfaceCommunicationInfoType" + }, + "translationInfo": { + "description": "Communication related information of a Hotel Interface.", + "$ref": "#/definitions/translationType" + }, + "classOfServiceInfo": { + "description": "Information related to Class of Service of a Hotel Interface.", + "$ref": "#/definitions/classOfServiceType" + }, + "importRoomsInfo": { + "description": "Information related to Import Rooms of a Hotel Interface.", + "$ref": "#/definitions/importRoomsType" + }, + "workstationSetupInfo": { + "description": "Workstation setup of a hotel interface.", + "$ref": "#/definitions/workstationSetupType" + }, + "postingsInfo": { + "description": "Postings of a hotel interface.", + "$ref": "#/definitions/postingInfoType" + }, + "customDataInfo": { + "description": "Information related to Custom Data of a Hotel Interface.", + "$ref": "#/definitions/interfaceCustomDataInfoType" + }, + "exportDataInfo": { + "description": "Information related to Export Data of a Hotel Interface.", + "$ref": "#/definitions/interfaceExportDataInfoType" + }, + "transactionsInfo": { + "description": "Postings of a hotel interface.", + "$ref": "#/definitions/transactionCodeInfoType" } } }, - "conditionGroupType": { + "interfaceCustomDataInfoType": { "type": "object", + "description": "This type holds the custom data of a hotel interface.", "properties": { - "condition": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/conditionType" - } + "exportAsXml": { + "description": "Specifies whether the details have to be exported as XML. If true, then the details are exported as XML else details are exported as text.", + "type": "boolean" }, - "conditionGroup": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/conditionGroupType" - } + "includeDoorcardField": { + "description": "Specifies whether the Doorcard field details have to be included in the XML Export. If true, Doorcard field details will be included in the XML Export else details will not be included. This field is available only when the Export as XML field is selected.", + "type": "boolean" }, - "logicalOperator": { - "$ref": "#/definitions/logicalOperatorType" + "interfaceCustomDataDetails": { + "description": "Collection of custom data details of a hotel interface.", + "$ref": "#/definitions/interfaceCustomDataDetailsType" } } }, - "conditionType": { + "interfaceCustomDataDetailsType": { + "type": "array", + "description": "Collection of custom data details of a hotel interface.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceCustomDataDetailType" + } + }, + "interfaceCustomDataDetailType": { "type": "object", + "description": "This gives information of custom detail of a hotel interface.", "properties": { - "leftExpression": { - "$ref": "#/definitions/expressionFieldType" - }, - "logicalOperator": { - "$ref": "#/definitions/logicalOperatorType" + "customDataField": { + "description": "Specifies the type of data stored.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "operator": { - "$ref": "#/definitions/expressionOperatorType" + "customDataValue": { + "description": "Specifies the actual data corresponding to each value in the field.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "interfaceCommunicationInfoType": { + "type": "object", + "properties": { + "tCPConfig": { + "$ref": "#/definitions/tCPConfigType" + } + } + }, + "tCPConfigType": { + "type": "object", + "properties": { + "iPAddress": { + "description": "IP address of the interface server", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "rightExpression": { - "$ref": "#/definitions/expressionParameterType" + "portNumber": { + "description": "Logical Port assignment", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, - "configuredExternalDeliveryMethodsType": { - "description": "External system configuration delivery methods for a property(chain or hub).", + "workstationSetupType": { + "type": "array", + "description": "List of workstations of a hotel interface.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceWorkstationType" + } + }, + "interfaceWorkstationType": { "type": "object", "properties": { - "ar": { - "$ref": "#/definitions/arDeliveryMethodType" + "hotelId": { + "description": "Hotel Code of a workstation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "billingFolio": { - "$ref": "#/definitions/billingFolioDeliveryMethodType" + "logo": { + "description": "Logo of a workstation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "confirmation": { - "$ref": "#/definitions/confirmationDeliveryMethodType" + "internalCode": { + "description": "Internal code of a workstation.", + "type": "integer" }, - "general": { - "$ref": "#/definitions/generalDeliveryMethodType" + "workstation": { + "description": "Workstation of a hotel interface.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "guestMessage": { - "$ref": "#/definitions/guestMessageDeliveryMethodType" + "deviceIp": { + "description": "IP of a workstation.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "otherFolios": { - "$ref": "#/definitions/otherFolioDeliveryMethodType" + "location": { + "description": "Location of a workstation.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "queueReservation": { - "$ref": "#/definitions/queueReservationDeliveryMethodType" + "type": { + "description": "Type of a workstation.", + "type": "string", + "minLength": 0, + "maxLength": 2 }, - "queueRush": { - "$ref": "#/definitions/queueRushDeliveryMethodType" + "deviceLocation": { + "description": "Device Group / Area.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "confirmationDeliveryMethodType": { - "description": "Confirmation letter delivery method configuration, settings for Text Message, Email and Fax Delivery of Confirmation Letters", + "importRoomsType": { "type": "object", "properties": { - "email": { - "$ref": "#/definitions/emailDeliveryConfigurationType" + "requiresLineNumberSetup": { + "description": "Indicator for Requires line number setup, from Import Rooms related information of a Hotel Interface.", + "type": "boolean" }, - "fax": { - "$ref": "#/definitions/faxDeliveryConfigurationType" + "virtualNumberSetup": { + "description": "Indicator for Virtual number setup, from Import Rooms related information of a Hotel Interface.", + "type": "boolean" }, - "textMessage": { - "$ref": "#/definitions/textMessageDeliveryConfigurationType" + "ioLines": { + "description": "Indicator for support of Input/Output Lines for Hotel Room Categories.", + "type": "boolean" + }, + "inXlatId": { + "description": "Translation table for incoming messages.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "ouXlatId": { + "description": "Translation table for outgoing messages.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "selectedRoomTypes": { + "description": "Concatenated label of Hotel Room Categories for which SendToInterface flag should be set as true.", + "type": "string", + "minLength": 0, + "maxLength": 4000 } } }, - "createDeliveryMethods": { - "description": "Request to create the delivery method for a property/HUB/Chain and its configurations.", + "interfacePrimaryInfoType": { "type": "object", "properties": { - "deliveryMethods": { - "description": "Collection of delivery method types to create.", - "$ref": "#/definitions/configuredExternalDeliveryMethodsType" + "interfaceId": { + "description": "Unique DB internal number of a Hotel Interface record.", + "$ref": "#/definitions/uniqueID_Type" }, - "links": { - "$ref": "#/definitions/links" + "hotelId": { + "description": "Hotel Code", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "interfaceName": { + "description": "Name of the Hotel Interface", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "interfaceType": { + "description": "Three letter code for each interface that identifies the interface.", + "$ref": "#/definitions/hotelInterfaceTypeType" + }, + "productCode": { + "description": "Three letter code that uniquely identifies the external interface.", + "type": "string", + "minLength": 0, + "maxLength": 4 + }, + "licenseCode": { + "description": "Interface License code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "machineId": { + "description": "The ID stored in IFC_MACHINES table.", + "type": "integer" + }, + "machineName": { + "description": "Unique machine name of the running IFC.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "interfaceProductCode": { + "description": "FKT Logo required for the external interface.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "outboundCode": { + "description": "Stores the Outbound Code to identify the target system.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "createPublishers": { - "description": "Request to create publishers.", + "translationType": { "type": "object", "properties": { - "links": { - "$ref": "#/definitions/links" + "guestNoLength": { + "description": "Guest number length of a translation setup.", + "type": "string", + "minLength": 0, + "maxLength": 2 }, - "publishers": { - "description": "Collection of publisher external systems information.", - "$ref": "#/definitions/publishersType" + "guestMessageIdLength": { + "description": "Guest message id length of a translation setup.", + "type": "string", + "minLength": 0, + "maxLength": 2 }, - "subscriber": { - "description": "Subcriber external system information.", - "$ref": "#/definitions/externalSystemType" + "groupNoLength": { + "description": "Group number length of a translation setup.", + "type": "string", + "minLength": 0, + "maxLength": 2 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "defaultCharge": { + "description": "Default charge of a translation setup.", + "type": "integer" + }, + "configuation": { + "description": "Translation configuration of a hotel interface.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceControlCfgType" + } + }, + "articles": { + "description": "Translation article setup of a hotel interface.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceControlArticleType" + } + }, + "specifications": { + "description": "Translation specifications setup of a hotel interface.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceControlSpecType" + } + }, + "languages": { + "description": "Translation languages setup of a hotel interface.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceControlLangType" + } } } }, - "emailDeliveryConfigurationType": { - "description": "Email content configuration template", + "interfaceControlCfgType": { "type": "object", "properties": { - "activateDelivery": { - "description": "This option must be selected in order to activate emailing from an SMTP compliant email server", - "type": "boolean" + "hotelId": { + "description": "Hotel Code of the hotel interface.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "attachICalender": { - "type": "boolean" + "logo": { + "description": "Logo of the hotel interface.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "internalCode": { + "description": "Internal code of a translation configuration setup.", + "type": "integer" + }, + "originCode": { + "description": "Origin code of a translation configuration setup.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "merchantId": { + "description": "Merchant Id of a translation configuration setup.", + "type": "string", + "minLength": 0, + "maxLength": 100 + } + } + }, + "interfaceControlSpecType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Hotel Code of the hotel interface.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "body": { + "logo": { + "description": "Logo of the hotel interface.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "format": { - "description": "EMAIL Format: HTML, RTF, PDF. Fax Format: TIF", - "$ref": "#/definitions/emailDeliveryFormatType" + "internalCode": { + "description": "Internal code of a translation specification setup.", + "type": "integer" }, - "fromAddress": { + "selector": { + "description": "Selector of a translation specification setup.", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 100 }, - "hTMLFormatDelivery": { - "description": "Available for Confirmation Letters only and when Activate Email Delivery is selected", - "type": "boolean" + "specification": { + "description": "Specification of a translation specification setup.", + "type": "string", + "minLength": 0, + "maxLength": 100 }, - "hotelId": { - "description": "Hotel code", + "priority": { + "description": "Priority of a translation specification setup.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 100 }, - "serverName": { + "position": { + "description": "Position of a translation specification setup.", + "type": "string", + "minLength": 0, + "maxLength": 100 + } + } + }, + "interfaceControlLangType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Hotel Code of the hotel interface.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "subject": { + "logo": { + "description": "Logo of the hotel interface.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "type": { - "description": "Deliver Type, possible values: AR, BILLING, CONFIRMATION, LEADS, OWS, OVOS.", - "$ref": "#/definitions/emailDeliveryMethodType" + "internalCode": { + "description": "Internal code of a translation language setup.", + "type": "integer" }, - "userId": { + "selector": { + "description": "Selector of a translation language setup.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 100 }, - "userPassword": { + "languageCode": { + "description": "Language code of a translation language setup.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 100 } } }, - "emailDeliveryFormatType": { - "description": "Email delivery format", - "type": "string", - "enum": [ - "Htmlcss", - "Pdf", - "Rtf", - "Tif" - ] - }, - "emailDeliveryMethodType": { - "description": "Email delivery method type", - "type": "string", - "enum": [ - "Billing", - "Confirmation", - "General", - "Other", - "AR" - ] - }, - "errorInstance": { - "description": "Complex type that contains error instance details for a REST call.", + "interfaceControlArticleType": { "type": "object", - "title": "Error Instance Details", - "required": [ - "type", - "title" - ], "properties": { - "detail": { - "description": "Human-readable description specific to this occurrence of the problem.", - "type": "string" - }, - "instance": { - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.", - "type": "string" - }, - "o:errorCode": { - "description": "Application error code, which is different from HTTP error code.", - "type": "string" + "hotelId": { + "description": "Hotel Code of the hotel interface.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "o:errorPath": { - "description": "Path to the problem at the resource or property level.", - "type": "string" + "logo": { + "description": "Logo of the hotel interface.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "status": { - "description": "HTTP status code for this occurrence of the problem, set by the origin server.", + "internalCode": { + "description": "Internal code of a translation article setup.", "type": "integer" }, - "title": { - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.", - "type": "string" + "selector": { + "description": "Selector of a translation article setup.", + "type": "string", + "minLength": 0, + "maxLength": 100 }, - "type": { - "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).", - "type": "string" + "articleNo": { + "description": "Article Number of a translation article setup.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "description": { + "description": "Description of a translation article setup.", + "type": "string", + "minLength": 0, + "maxLength": 100 } } }, - "exceptionDetailType": { - "description": "Complex type that contains error details for a REST call.", + "transactionCodeInfoType": { "type": "object", - "title": "Error Detail", - "required": [ - "type", - "title" - ], "properties": { - "detail": { - "description": "Human-readable description specific to this occurrence of the problem.", - "type": "string" + "allChargesCode": { + "description": "All charges code of transaction code setup", + "type": "string", + "minLength": 0, + "maxLength": 10 }, - "instance": { - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.", - "type": "string" + "miniBarCode": { + "description": "Minibar charges code of transaction code setup", + "type": "string", + "minLength": 0, + "maxLength": 10 }, - "links": { - "$ref": "#/definitions/links" + "cashCreditCardPosting": { + "description": "Cash or credit card posting of transaction code setup", + "type": "string", + "minLength": 0, + "maxLength": 1 }, - "o:errorCode": { - "description": "Application error code, which is different from HTTP error code.", - "type": "string" + "subtotalPosting": { + "description": "Subtotal posting of transaction code setup", + "type": "string", + "minLength": 0, + "maxLength": 1 }, - "o:errorDetails": { - "description": "Details of the error message, consisting of a hierarchical tree structure.", + "differencePosting": { + "description": "Difference posting of transaction code setup", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "calcTrxCodePosting": { + "description": "Calculated transaction code posting of transaction code setup", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "numberOfDialedDigits": { + "description": "Number of dialed digits transaction code setup", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "postingAccounts": { + "description": "Postings information of transaction codes setup.", "type": "array", + "maxItems": 4000, "items": { - "$ref": "#/definitions/errorInstance" + "$ref": "#/definitions/postingAccountType" } }, - "o:errorPath": { - "description": "Path to the problem at the resource or property level.", - "type": "string" + "itemizers": { + "description": "Split information of transaction code setup.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/itemizerType" + } }, - "status": { - "description": "HTTP status code for this occurrence of the problem, set by the origin server.", + "transactionCodes": { + "description": "Split information of transaction code setup.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/transactionCodeDetailType" + } + } + } + }, + "itemizerType": { + "type": "object", + "properties": { + "splitCode": { + "description": "Split code of the itemizer setup.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "splitPost": { + "description": "Split posting of the itemizer setup.", "type": "integer" }, - "title": { - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.", - "type": "string" + "splitText": { + "description": "Split text of the itemizer setup.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "type": { - "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).", - "type": "string" + "splitFactor": { + "description": "Split factor of the itemizer setup.", + "type": "integer" } } }, - "expressionFieldType": { + "postingAccountType": { "type": "object", "properties": { - "dataType": { + "id": { + "description": "Internal ID to reference the records.", + "type": "number" + }, + "paymentMethod": { + "description": "Payment method of posting accounts in transaction codes setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 10 }, - "fieldDescription": { + "account": { + "description": "Account of posting accounts in transaction codes setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 50 }, - "fieldName": { + "accountDescription": { + "description": "Account description of posting accounts in transaction codes setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 100 }, - "lovSelected": { + "salesOutlet": { + "description": "Sales outlet of posting accounts in transaction codes setup.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 100 }, - "tableName": { + "transactionCode": { + "description": "Transaction code of posting accounts in transaction codes setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "virtual": { + "description": { + "description": "Description of posting accounts in transaction codes setup.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "autoBalance": { + "description": "Auto balance flag of postings setup.", "type": "boolean" } } }, - "expressionOperatorType": { + "transactionCodeDetailType": { "type": "object", "properties": { - "operatorDescription": { + "servingPeriod": { + "description": "Serving period of transaction code setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 50 }, - "operatorName": { + "rowNum": { + "description": "Row number of transaction code setup.", + "type": "integer" + }, + "revenueCenter": { + "description": "Revenue center of transaction code setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 50 }, - "parameterSize": { - "type": "number" - } - } - }, - "expressionParameterType": { - "type": "object", - "properties": { - "functionIdOne": { - "type": "number" + "terminal": { + "description": "Terminal of transaction code setup.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "functionIdTwo": { - "type": "number" + "paymentNum": { + "description": "Payment number of transaction code setup.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "parameter": { - "type": "array", - "maxItems": 3, - "items": { - "type": "string", - "maxLength": 40, - "minLength": 0 - } - } - } - }, - "externalDatabaseAssociatedHotelType": { - "type": "object", - "properties": { - "hotelId": { - "description": "Pertain associated hotel code for external database.", + "userId": { + "description": "User id of transaction code setup.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 50 }, - "hotelName": { - "description": "Pertain associated hotel code for external database.", + "postRoute": { + "description": "Post route of transaction code setup.", "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "externalDatabaseAssociatedHotelsType": { - "description": "Collection of Hotel for external database.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/externalDatabaseAssociatedHotelType" - } - }, - "externalSystemCodeType": { - "description": "External System Code", - "type": "object", - "properties": { + "minLength": 0, + "maxLength": 50 + }, + "dialedDigits": { + "description": "Dialed digits of transaction code setup.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "lineType": { + "description": "Line type of transaction code setup.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, "code": { + "description": "Code of transaction code setup.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "tipCode": { + "description": "Tip code of transaction code setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 50 + }, + "description": { + "description": "Description of transaction code setup.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "itemizersShortInfo": { + "description": "Itemizer short info of transaction code setup.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/itemizerShortInfoType" + } } } }, - "externalSystemType": { - "description": "External System Information", + "itemizerShortInfoType": { "type": "object", "properties": { - "externalSystemCode": { - "$ref": "#/definitions/externalSystemCodeType" + "code": { + "description": "Code of the itemizer on a transaction code setup.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "hotelId": { + "itemizerName": { + "description": "Itemizer name on a transaction code setup.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 50 + }, + "itemNumber": { + "description": "Itemizer number which is the split post on a transaction code setup.", + "type": "integer" } } }, - "faxDeliveryConfigurationType": { - "description": "Email content configuration template", + "generalInfoType": { "type": "object", "properties": { - "activateEmailToFax": { - "description": "This option must be selected in order to activate faxing from an SMTP compliant fax server", + "createSVCheckIn": { + "description": "Create stored value during checkin of a Hotel Interface", + "type": "boolean" + }, + "enableFailover": { + "description": "Enable failover of a Hotel Interface", + "type": "boolean" + }, + "ccVaultFunction": { + "description": "CC vault of a Hotel Interface", + "type": "boolean" + }, + "enableResend": { + "description": "Enable resend of a Hotel Interface", + "type": "boolean" + }, + "sendARAuthType": { + "description": "Send AR auth type of a Hotel Interface", + "type": "boolean" + }, + "enableDBVerification": { + "description": "Enable DB verification of a Hotel Interface", + "type": "boolean" + }, + "allowCCCancelTransaction": { + "description": "Allow CC cancel transactions of a Hotel Interface", + "type": "boolean" + }, + "showStoredValuePin": { + "description": "Show stored value pin of a Hotel Interface", + "type": "boolean" + }, + "showSVTransaction": { + "description": "Show SV transaction of a Hotel Interface", + "$ref": "#/definitions/sVTransactionType" + }, + "storedValueSystem": { + "description": "Stored value system of a Hotel Interface", + "type": "boolean" + }, + "sendEnhancedFields": { + "description": "Send enhanced fields of a Hotel Interface", + "type": "boolean" + }, + "cardPresentFlag": { + "description": "Card present of a Hotel Interface", + "type": "boolean" + }, + "handleNightAudit": { + "description": "Handle night audit command of a Hotel Interface", + "type": "boolean" + }, + "regularTransaction": { + "description": "Regular transaction command of a Hotel Interface", + "type": "boolean" + }, + "courtesyCardHandling": { + "description": "Courtesy card handling command of a Hotel Interface", "type": "boolean" }, - "body": { + "sendEndOfDay": { + "description": "Send end of day of a Hotel Interface", + "type": "boolean" + }, + "portNumber1": { + "description": "Logical port number 1 of a the Hotel Interface", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "faxDomain": { + "portNumber2": { + "description": "Logical port number 2 of a the Hotel Interface", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "faxPrefix": { + "portNumber3": { + "description": "Logical port number 3 of a the Hotel Interface", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "faxSuffix": { + "portNumber4": { + "description": "Logical port number 4 of a the Hotel Interface", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "format": { - "description": "EMAIL Format: HTML, RTF, PDF. Fax Format: TIF", - "$ref": "#/definitions/emailDeliveryFormatType" + "iPAddress": { + "description": "IP Address of a the Hotel Interface", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "fromAddress": { + "sVRedeemTrx": { + "description": "Stored value reedeem transaction of a the Hotel Interface", "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "hotelId": { - "description": "Hotel code", + "device": { + "description": "Device of a the Hotel Interface", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "serverName": { + "departmentCode1": { + "description": "Department code 1 of a the Hotel Interface", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "subject": { + "departmentCode2": { + "description": "Department code 2 of a the Hotel Interface", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "type": { - "description": "Deliver Type, possible values: AR, BILLING, CONFIRMATION, LEADS, OWS, OVOS.", - "$ref": "#/definitions/emailDeliveryMethodType" + "rollupTransactions": { + "description": "Rollup transactions flag of the Hotel Interface", + "type": "boolean" }, - "userId": { + "allowVideoCheckout": { + "description": "Indicator if video checkout is allowed or not.", + "type": "boolean" + }, + "checkCreditLimit": { + "description": "One of the video checkout options whether to check the credit limit.", + "type": "boolean" + }, + "checkBalance": { + "description": "One of the video checkout options whether to check the balance.", + "type": "boolean" + }, + "checkRouting": { + "description": "One of the video checkout options whether to check the routing.", + "type": "boolean" + }, + "wakeupYn": { + "description": "Indicator if the Hotel Interface handles wakeup calls.", + "type": "boolean" + }, + "wakeupHandledBy": { + "description": "Determines who handles the wakeup calls, either by Opera (0) or a Vendor (1).", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "userPassword": { + "wakeRetry": { + "description": "Wakeup retry limit of the Hotel Interface. Value range is 0 to 999.", + "type": "integer" + }, + "wakeDelay": { + "description": "Wakeup delay value of the Hotel Interface.", + "type": "integer" + }, + "prevWake": { + "description": "Used by the Interface module (IFC7.exe).", + "type": "integer" + }, + "folioDisplayOption": { + "description": "Folio display option of the Hotel Interface applicable to VID and MSC. \"0\" means folio display option off. \"A\" means a guest folio display option. \"U\" means user defined folio display option.", "type": "string", - "maxLength": 80, - "minLength": 0 - } - } - }, - "fetchedDeliveryMethods": { - "description": "Response to request to fetch the delivery method for a property/HUB/Chain and its configurations.", - "type": "object", - "properties": { - "deliveryMethods": { - "description": "Collection of all delivery method types.", - "$ref": "#/definitions/configuredExternalDeliveryMethodsType" + "minLength": 0, + "maxLength": 1 }, - "links": { - "$ref": "#/definitions/links" + "userDefinedFolio1": { + "description": "Indicator if the User defined folio 1 is utilized.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "fetchedExternalDatabaseAvailableProperties": { - "description": "Response object for retrieving the Available properties for External Databases.", - "type": "object", - "properties": { - "availailableProperties": { - "$ref": "#/definitions/externalDatabaseAssociatedHotelsType" + "userDefinedFolio2": { + "description": "Indicator if the User defined folio 2 is utilized.", + "type": "boolean" }, - "links": { - "$ref": "#/definitions/links" + "userDefinedFolio3": { + "description": "Indicator if the User defined folio 3 is utilized.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "userDefinedFolio4": { + "description": "Indicator if the User defined folio 4 is utilized.", + "type": "boolean" + }, + "displayPhoneName": { + "description": "Indicator if the phone name will be displayed.", + "type": "boolean" + }, + "keyPinActive": { + "description": "Indicator if the Key Pin is active or not.", + "type": "boolean" + }, + "allPrintDetailOn": { + "description": "Indicator for Default All Print Details On.", + "type": "boolean" } } }, - "fetchedHotelInterfaceControllerRegistry": { - "description": "Response object for retrieving Hotel Interface Controller Registry.", + "sVTransactionType": { + "type": "string", + "description": "Status of the Hotel Interface either STOPPED or RUNNING.", + "enum": [ + "OperaTransaction", + "VendorTransaction", + "OperaAndVendorTransaction" + ] + }, + "interfaceExportDataInfoType": { "type": "object", + "description": "This type holds the export data of a hotel interface.", "properties": { - "links": { - "$ref": "#/definitions/links" - }, - "reg": { - "description": "Collection of Hotel Interface Controller Registry.", - "$ref": "#/definitions/hotelInterfaceControllerRegsType" + "interfaceExportDataDetails": { + "description": "Collection which shows the manually selected columns for the export data of a hotel interface.", + "$ref": "#/definitions/interfaceExportDataDetailsType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "interfaceExportDataMandatoryDetails": { + "description": "Collection which shows the mandatory columns for the export data of a hotel interface.", + "$ref": "#/definitions/interfaceExportDataDetailsType" } } }, - "fetchedHotelInterfaceErrors": { - "description": "Response object for retrieving Hotel Interface Errors.", + "interfaceExportDataDetailsType": { + "type": "array", + "description": "Collection of export data details of a hotel interface.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceExportDataDetailType" + } + }, + "interfaceExportDataDetailType": { "type": "object", + "description": "This gives information of export detail of a hotel interface.", "properties": { - "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" - }, - "hotelInterfaceErrors": { - "description": "Collection of Hotel Interface Errors.", - "$ref": "#/definitions/hotelInterfaceErrorsType" - }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "sourceTableName": { + "description": "Specifies the table where the event data is stored.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "links": { - "$ref": "#/definitions/links" + "columnName": { + "description": "Specifies the column name found in the table.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "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" + "dataType": { + "description": "Specifies the type of data in the column.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", + "dataLength": { + "description": "Specifies the length of data in the column.", "type": "integer" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "xMLTagName": { + "description": "Specifies the tag name found in the export.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "columnSelected": { + "description": "Specifies whether the column is chosen to be included in the export.", + "type": "boolean" } } }, - "fetchedHotelInterfaceFailedMessages": { - "description": "Response object for retrieving Hotel Interface Failed Messages.", + "interfaceAdditionalInfoType": { "type": "object", "properties": { - "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" - }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "menuType": { + "description": "Internal representation for Interface Type", + "$ref": "#/definitions/ifcMenuTypeType" }, - "links": { - "$ref": "#/definitions/links" + "menuName": { + "description": "Name of the Interface sub-menu", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "messages": { - "description": "Collection of Hotel Interface Failed Messages.", - "$ref": "#/definitions/hotelInterfaceFailedMessagesType" + "controllerPort": { + "description": "Opera IFC controller (server) port for the connecting clients.", + "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.", + "vncPort": { + "description": "VNC server port for connecting to a VNC server.", "type": "integer" }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", + "cashierId": { + "description": "Cashier Number.", "type": "integer" }, - "totalResults": { - "description": "Total number of rows queried", + "pathId1": { + "description": "Used if interface has to support more than one front office system.", "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "fetchedHotelInterfaceSchemas": { - "description": "Response object for retrieving Hotel Interface Schemas.", - "type": "object", - "properties": { - "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.", + "timeout": { + "description": "Used by the Interface module. ( IFC7.exe )", + "type": "string", + "minLength": 0, + "maxLength": 3 + }, + "displayFlag": { + "description": "True if the interface will be displayed.", "type": "boolean" }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "autoStartFlag": { + "description": "Decides if the interface will be started automatically when the controller is restarted.", + "type": "boolean" }, - "links": { - "$ref": "#/definitions/links" + "activeFlag": { + "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", + "type": "boolean" }, - "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" + "interfaceStatus": { + "description": "Status if the Hotel Interface is STOPPED or RUNNING. This is different from the Active Flag, which is either 1 or 0.", + "$ref": "#/definitions/hotelInterfaceStatusType" }, - "schemas": { - "description": "Collection of Hotel Interface Schemas.", - "$ref": "#/definitions/hotelInterfaceSchemasType" + "version": { + "description": "Version no. of each external interface that is installed", + "type": "string", + "minLength": 0, + "maxLength": 10 }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" + "msgExpiresAfter": { + "description": "(Internal Use) Message Expires After", + "type": "string", + "minLength": 0, + "maxLength": 8 }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "useDataThroughFlag": { + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "fetchedHotelInterfaces": { - "description": "Response object for retrieving Hotel Interfaces.", - "type": "object", - "properties": { - "hotelInterfaces": { - "description": "Collection of Hotel Interfaces.", - "$ref": "#/definitions/hotelInterfacesType" + "nAStart": { + "description": "Indicator if the Hotel Interface handles night audit commands.", + "type": "boolean" }, - "links": { - "$ref": "#/definitions/links" + "multipleRoomKey": { + "description": "Indicator if the Hotel Interface allows multiple room selection for keys.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "fetchedInterfaceRights": { - "description": "Collection of Hotel Interface Rights.", - "type": "array", - "items": { - "$ref": "#/definitions/interfaceRightType" - } - }, - "fetchedPublishers": { - "description": "Response to request to fetch the external systems", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "onlineKeySystem": { + "description": "Indicator if the Hotel Interface is an online key system.", + "type": "boolean" }, - "publishers": { - "description": "Collection of publisher external systems information.", - "$ref": "#/definitions/publishersType" + "deleteIfcKeysOnKeyDelete": { + "description": "Indicator if the Interface Keys will be deleted on KeyDelete.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "fetchedUDFMappings": { - "description": "Message received on an UDFs Lookup.", - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/links" + "sendTrack1Data": { + "description": "Indicator for Hotel Interface Send Track 1 Data.", + "type": "boolean" }, - "uDFMappings": { - "description": "Criteria for fetching UDFs.", - "type": "array", - "items": { - "$ref": "#/definitions/uDFMappingType" - } + "sendTrack2Data": { + "description": "Indicator for Hotel Interface Send Track 2 Data.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "generalDeliveryMethodType": { - "description": "General delivery method SFTPConfigurationType configuration, settings for Email and Fax Delivery of General Letters", - "type": "object", - "properties": { - "email": { - "$ref": "#/definitions/emailDeliveryConfigurationType" + "sendRoomStatus": { + "description": "Indicator if the Room Status will be sent.", + "type": "boolean" + }, + "telephoneCharge": { + "description": "Indicates on what the post unit charge is based on.", + "$ref": "#/definitions/telephoneChargeType" }, - "fax": { - "$ref": "#/definitions/faxDeliveryConfigurationType" + "additionalRoomsLimit": { + "description": "Maximum number of additional rooms allowed.", + "type": "integer", + "minimum": 1, + "maximum": 999 }, - "sftpConfigurations": { - "$ref": "#/definitions/sftpConfigurationsListType" + "sendValidStartDateTime": { + "description": "Indicator if the DLS Interface allows to send valid start date and time.", + "type": "boolean" } } }, - "guestMessageDeliveryMethodType": { - "description": "Guest text message configuration, settings for Text Message Delivery of Guest Messages", + "telephoneChargeType": { + "type": "string", + "enum": [ + "0", + "1", + "2" + ], + "description": "Auto Choose" + }, + "ifcMenuTypeType": { + "type": "string", + "enum": [ + "Cas", + "Kss", + "Mbs", + "Pbx", + "Pos", + "Vss", + "Dcs" + ], + "description": "Data Card System" + }, + "classOfServiceType": { "type": "object", "properties": { - "textMessage": { - "$ref": "#/definitions/textMessageDeliveryConfigurationType" + "cosMsgLmpRg": { + "description": "", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "cosChkRg": { + "description": "", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "cosMsgCmdRg": { + "description": "", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "roomEquipCi": { + "description": "", + "type": "boolean" + }, + "roomEquipCo": { + "description": "", + "type": "boolean" + }, + "guestDataChangeCo": { + "description": "", + "type": "boolean" + }, + "standardNameFormat": { + "description": "Standard name format in the class of service.", + "type": "string", + "minLength": 0, + "maxLength": 5 + }, + "definedNameFormat": { + "description": "Defined name format in the class of service.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/definedNameFormatType" + } + }, + "resvInQueue": { + "description": "Indicates whethe a message will be triggered when a room/reservation is placed on QUEUE", + "type": "boolean" } } }, - "hotelInterfaceControllerRegType": { + "definedNameFormatType": { "type": "object", "properties": { - "cntrlRegSetting": { - "description": "Controller Registry Setting", + "hotelId": { + "description": "Hotel Code where the defined name format is associated.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "data": { - "description": "Data", + "definedFormatId": { + "description": "ID of the defined name format.", "type": "string", - "maxLength": 400, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "description": { - "description": "Description", + "expressionTable": { + "description": "Table from which the info will be retrieved.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 200 }, - "id": { - "description": "Internal ID to reference the records.", - "type": "number" + "expression": { + "description": "Expression of the defined name format It basically contains all formats that are being set.", + "type": "string", + "minLength": 0, + "maxLength": 4000 }, - "machine": { - "description": "Machine Name", + "logo": { + "description": "Logo of the hotel interface.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 20 } } }, - "hotelInterfaceControllerRegsType": { - "description": "Collection of Hotel Interface Controller Registry.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelInterfaceControllerRegType" - } - }, - "hotelInterfaceErrorType": { + "postingInfoType": { "type": "object", "properties": { - "actionName": { - "description": "Action Name", + "referenceField": { + "description": "Reference field of postings setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "error": { - "description": "Error", + "chargeScaling": { + "description": "Charge scaling of postings setup.", "type": "string", - "maxLength": 2000, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "hotelId": { - "description": "Hotel Code", + "zeroChargePostings": { + "description": "Zero charge posting of postings setup.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "ifcType": { - "description": "ifcType", + "postings": { + "description": "Postings of postings setup.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 1 }, - "insertDate": { - "description": "Date time stamp of a Hotel Interface Schema.", + "postType": { + "description": "Post type of postings setup.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 1 }, - "logo": { - "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", - "type": "string", - "maxLength": 20, - "minLength": 0 + "conversion": { + "description": "Conversion of postings setup.", + "type": "integer" }, - "message": { - "description": "Message", + "reference": { + "description": "Reference of postings setup.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 50 }, - "resvNameId": { - "description": "Schema", + "supplement": { + "description": "Supplement of postings setup.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 50 + }, + "overrideCreditLimit": { + "description": "Override credit limit of postings setup.", + "type": "boolean" + }, + "noPostFlag": { + "description": "No post flag of postings setup.", + "type": "boolean" + }, + "generatesTax": { + "description": "IFC generate tax of postings setup.", + "type": "boolean" + }, + "dialedNumberMasking": { + "description": "Type of number masking used for the dialed numbers in the particular interface.", + "$ref": "#/definitions/maskDialNumberType" + }, + "articleNoPrefix": { + "description": "Article Prefix of postings setup.", + "type": "boolean" } } }, - "hotelInterfaceErrorsType": { - "description": "Collection of Hotel Interface Errors.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelInterfaceErrorType" - } + "maskDialNumberType": { + "type": "string", + "description": "Mask the dialled digits as per the room configuration.", + "enum": [ + "NoMasking", + "MaskLast2Digits", + "MaskLast4Digits", + "Mask4DigitsLeaveLast2Intact", + "MaskAllExceptFirst2", + "MaskAll", + "MaskingPerRoom" + ] }, - "hotelInterfaceFailedMessageType": { + "interfaceRoomType": { "type": "object", "properties": { - "actionName": { - "description": "Action Name", + "hotelId": { + "description": "Hotel Code of the Interface Room.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "hotelId": { - "description": "Hotel Code", + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "ifcType": { - "description": "ifcType", + "roomType": { + "description": "Front Office Room Type.", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "insertDate": { - "description": "Date time stamp of a Hotel Interface Schema.", + "roomId": { + "description": "Front Office Room Number.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 20 }, - "logo": { - "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "lineNumber": { + "description": "External System's extension number.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "message": { - "description": "Message", + "oldLineNumber": { + "description": "External System's extension number. It is used for editing a record. It is logically part of the record ID, and can actually be updated.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "fromRoom": { + "description": "From Room Number", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + "toRoom": { + "description": "To Room Number", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + "fromLine": { + "description": "From Line Number", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + "toLine": { + "description": "To Line Number", "type": "string", - "maxLength": 4000, - "minLength": 0 + "minLength": 1, + "maxLength": 20 + }, + "type": { + "description": "Line Type of an Interface Room.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "dataLine": { + "description": "I/O Lines type, which is either IN or OUT.", + "$ref": "#/definitions/dataLineType" + }, + "dataLineId": { + "description": "Translation Table Id as defined in the IFC_CTRL table. It is also referred as Xlat Id.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "wakeUpCall": { + "description": "Value to set/check if the wake up call funtionality is enabled/disabled for the particular line number.", + "type": "boolean" + }, + "doNotDisturb": { + "description": "Value to set/check if the Do Not Disturb funtionality is enabled/disabled/NA for the particular line number.", + "$ref": "#/definitions/doNotDisturbType" + }, + "classOfService": { + "description": "Value to set/check if the Class of Service funtionality is enabled/disabled/NA for the particular line number.", + "$ref": "#/definitions/classOfServiceConfigType" + }, + "directInwardDial": { + "description": "Value to set/check if the Direct Inward Dial funtionality is enabled/disabled/NA for the particular line number.", + "$ref": "#/definitions/directInwardDialType" + }, + "messageWaiting": { + "description": "Value to set/check if the Message Waiting funtionality is enabled/disabled/NA for the particular line number.", + "$ref": "#/definitions/messageWaitingType" + }, + "maskDialNumber": { + "description": "Value to set/check the type number masking used for the particular line number.", + "$ref": "#/definitions/maskDialNumberType" } } }, - "hotelInterfaceFailedMessagesType": { - "description": "Collection of Hotel Interface Failed Messages.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelInterfaceFailedMessageType" - } + "dataLineType": { + "type": "string", + "enum": [ + "In", + "Out" + ], + "description": "Line Out" }, - "hotelInterfaceSchemaType": { + "doNotDisturbType": { + "type": "string", + "description": "Do Not Disturb is set to available and freely switchable.", + "enum": [ + "NotAvailable", + "AlwaysOn", + "AlwaysOff", + "FreelySwitchable" + ] + }, + "messageWaitingType": { + "type": "string", + "description": "Message Waiting is set to available and freely switchable.", + "enum": [ + "NotAvailable", + "AlwaysOn", + "AlwaysOff", + "FreelySwitchable" + ] + }, + "classOfServiceConfigType": { + "type": "string", + "description": "Class Of Service is set to available and freely switchable.", + "enum": [ + "NotAvailable", + "AlwaysOn", + "AlwaysOff", + "FreelySwitchable" + ] + }, + "directInwardDialType": { + "type": "string", + "description": "Direct Inward Dial is set to available and freely switchable.", + "enum": [ + "NotAvailable", + "AlwaysOn", + "AlwaysOff", + "FreelySwitchable" + ] + }, + "importInterfaceRoomsType": { "type": "object", "properties": { - "actionName": { - "description": "Action Name", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, "hotelId": { - "description": "Hotel Code", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "ifcType": { - "description": "ifcType", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "insertDate": { - "description": "Date time stamp of a Hotel Interface Schema.", + "description": "Hotel Code to which the Interface Room belongs to.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 20 }, "logo": { "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "schema": { - "description": "Schema", - "type": "string", - "maxLength": 4000, - "minLength": 0 + "dataLine": { + "description": "I/O Lines type, which is either IN or OUT.", + "$ref": "#/definitions/dataLineType" }, - "schemaName": { - "description": "Schema Name", + "numberOfLines": { + "description": "Number of lines to use for the import of a Hotel Interface Room.", + "type": "integer" + }, + "removeLeadingZeros": { + "description": "Number of lines to use for the import of a Hotel Interface Room.", + "type": "boolean" + }, + "line1Prefix": { + "description": "Prefix for the Hotel Interface Room number for Line 1.", + "type": "integer" + }, + "line1AddTo": { + "description": "Numeric value to be summed with the Hotel Interface Room number for Line 1.", + "type": "integer" + }, + "line2Prefix": { + "description": "Prefix for the Hotel Interface Room number for Line 2.", + "type": "integer" + }, + "line2AddTo": { + "description": "Numeric value to be summed with the Hotel Interface Room number for Line 2.", + "type": "integer" + }, + "line3Prefix": { + "description": "Prefix for the Hotel Interface Room number for Line 3.", + "type": "integer" + }, + "line3AddTo": { + "description": "Numeric value to be summed with the Hotel Interface Room number for Line 3.", + "type": "integer" + }, + "line4Prefix": { + "description": "Prefix for the Hotel Interface Room number for Line 4.", + "type": "integer" + }, + "line4AddTo": { + "description": "Numeric value to be summed with the Hotel Interface Room number for Line 4.", + "type": "integer" + }, + "selectedRoomTypes": { + "description": "Concatenated label of Hotel Room Categories, which will be imported to the Hotel Interface.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 4000 + }, + "maskLines": { + "description": "Mask configurations for different line types.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomMaskSetupType" + } } } }, - "hotelInterfaceSchemasType": { - "description": "Collection of Hotel Interface Schemas.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelInterfaceSchemaType" + "roomMaskSetupType": { + "type": "object", + "properties": { + "wakeUpCall": { + "description": "Value to set/check if the wake up call funtionality is enabled/disabled for the particular line number.", + "type": "boolean" + }, + "doNotDisturb": { + "description": "Value to set/check if the Do Not Disturb funtionality is enabled/disabled/NA for the particular line number.", + "$ref": "#/definitions/doNotDisturbType" + }, + "classOfService": { + "description": "Value to set/check if the Class of Service funtionality is enabled/disabled/NA for the particular line number.", + "$ref": "#/definitions/classOfServiceConfigType" + }, + "directInwardDial": { + "description": "Value to set/check if the Direct Inward Dial funtionality is enabled/disabled/NA for the particular line number.", + "$ref": "#/definitions/directInwardDialType" + }, + "messageWaiting": { + "description": "Value to set/check if the Message Waiting funtionality is enabled/disabled/NA for the particular line number.", + "$ref": "#/definitions/messageWaitingType" + }, + "maskDialNumber": { + "description": "Value to set/check the type number masking used for the particular line number.", + "$ref": "#/definitions/maskDialNumberType" + } } }, - "hotelInterfaceStatusType": { - "description": "Status of the Hotel Interface either STOPPED or RUNNING.", + "dMLCommandType": { "type": "string", "enum": [ - "Stopped", - "Running", - "Waiting", - "StopInitiated", - "StartInitiated", - "RebootInitiated", - "Other" - ] + "Insert", + "Update", + "Delete" + ], + "description": "A data manipulation language command for deleting an existing record." + }, + "interfaceAccountType": { + "type": "object", + "properties": { + "hotelId": { + "description": "Hotel Code of the Interface Account.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "postingAccount": { + "description": "Posting information of transaction codes setup.", + "$ref": "#/definitions/postingAccountType" + } + } + }, + "interfaceMachineType": { + "type": "object", + "properties": { + "id": { + "description": "Unique Id for every interface machine.", + "$ref": "#/definitions/uniqueID_Type" + }, + "machine": { + "description": "Unique Machine name of the running Interface.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "program": { + "description": "Path and name of the Interface program running on every Machine.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "controllerPort": { + "description": "Opera Interface controller (server) port for the connecting clients.", + "type": "integer" + }, + "vncPort": { + "description": "VNC server port for connecting to the VNC server.", + "type": "integer" + } + } }, - "hotelInterfaceType": { + "interfaceRoomStatusType": { "type": "object", "properties": { - "activeFlag": { - "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", - "type": "boolean" - }, "hotelId": { "description": "Hotel Code", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "interfaceId": { - "description": "Unique DB internal number of a Hotel Interface record.", - "$ref": "#/definitions/uniqueID_Type" + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "interfaceName": { - "description": "Name of the Hotel Interface", + "entryCode": { + "description": "Entry code of a Hotel Interface Room Status.", "type": "string", - "maxLength": 40, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "interfaceType": { - "description": "Three letter code for each interface that identifies the interface.", - "$ref": "#/definitions/hotelInterfaceTypeType" + "status": { + "description": "Room Status which is either Vacant (V) or Occupied (O).", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "logo": { - "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "housekeepingStatus": { + "description": "Housekeeping status of a room.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "machineName": { - "description": "Unique machine name of the running IFC.", + "customRoomTranslation": { + "description": "Custom Room Translation of a Hotel Interface. It is a concatenation of a Status (V-Vacant or O-Occupied) and Housekeeping Status (IS-Inspected, CL-Clean, etc.) The delimiter is a period. Sample values are V.IS, V.CL, O.IS, O.CL.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 2000 }, - "status": { - "description": "The current status of the IFC.", - "$ref": "#/definitions/hotelInterfaceStatusType" + "description": { + "description": "Description of the Hotel Interface Room Status.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "interfaceRoomStatusId": { + "description": "Row number to identify all the records belonging to a single group of Hotel Interface Room Status.", + "type": "integer" } } }, - "hotelInterfaceTypeType": { - "description": "XML Posting Interface", - "type": "string", - "enum": [ - "Bms", - "Cas", - "Ccw", - "Dls", - "Eft", - "Exp", - "Mak", - "Mbs", - "Msc", - "Pbx", - "Pos", - "Svs", - "Tik", - "Vid", - "Vms", - "Www", - "Xml" - ] - }, - "hotelInterfacesType": { - "description": "Collection of Hotel Interfaces.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelInterfaceType" - } - }, - "instanceLink": { - "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", + "interfaceUnitChargesType": { "type": "object", - "required": [ - "href", - "rel", - "method", - "operationId" - ], + "description": "Collection of Hotel Interface Unit Charges.", "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" - }, - "method": { - "description": "HTTP method for requesting the target of the link.", + "hotelId": { + "description": "Hotel Code", "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE", - "PATCH", - "OPTIONS", - "HEAD" - ] - }, - "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" - }, - "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" - }, - "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" + "minLength": 0, + "maxLength": 20 }, - "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 + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "title": { - "description": "Exact copy of the \"summary\" field on the linked operation.", - "type": "string" + "unitCharges": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceUnitChargeType" + } } } }, - "interfaceRightType": { + "interfaceUnitChargeType": { "type": "object", "properties": { - "code": { - "description": "User defined code for an Interface Right.", + "trunkId": { + "description": "Trunk ID of the CAS or PBX.", "type": "string", - "maxLength": 5, - "minLength": 0 + "minLength": 0, + "maxLength": 10 }, - "description": { - "description": "User defined description for an Interface Right.", + "lineType": { + "description": "Line Types setup in IFC_ROOM table.", "type": "string", - "maxLength": 80, - "minLength": 0 + "minLength": 0, + "maxLength": 10 }, - "hotelId": { - "description": "Hotel Code to which the Interface Right belongs to.", + "vipCode": { + "description": "Guest VIP Code.", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 40 }, - "interfaceId": { - "description": "Unique DB internal number of a Hotel Interface record.", - "$ref": "#/definitions/uniqueID_Type" + "startUnit": { + "description": "Starting number of units for the unit range.", + "type": "integer" }, - "interfaceRightDescription": { - "description": "System Description of an allowed Interface Right.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "endUnit": { + "description": "Ending number of units for the unit range.", + "type": "integer" }, - "right": { - "description": "Internal code for each allowed right of a Hotel Interface record.", + "pricePerUnit": { + "description": "Amount charged per unit.", "type": "integer" } } }, - "links": { - "type": "array", - "items": { - "$ref": "#/definitions/instanceLink" - } - }, - "logicalOperatorType": { - "type": "string", - "enum": [ - "And", - "Or" - ] - }, - "operaVersionNumberType": { - "description": "Current Opera Version Number", - "type": "string", - "maxLength": 40, - "minLength": 0 - }, - "otherFolioDeliveryMethodType": { - "description": "Delivery Method configuration for Email and Fax Delivery for Other Folios", + "fetchedConfiguredExternalDevices": { "type": "object", "properties": { - "email": { - "$ref": "#/definitions/emailDeliveryConfigurationType" + "configuredExternalDevices": { + "description": "Collection of all active external devices.", + "$ref": "#/definitions/configuredExternalDevices" }, - "fax": { - "$ref": "#/definitions/faxDeliveryConfigurationType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "publishersType": { - "description": "Information of all the publishers for a given subscriber.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/externalSystemType" + "fetchedExternalDeviceConfigurations": { + "type": "object", + "properties": { + "externalDeviceConfigurations": { + "description": "Collection of configurations for the external device.", + "$ref": "#/definitions/externalDeviceConfigurationType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "queueReservationDeliveryMethodType": { - "description": "Queue reservation delivery method configuration, settings for Text Message Delivery of Queue Reservation status", + "changeExternalDeviceConfigurations": { "type": "object", + "description": "Request to change the external device activated for the hotel and its configurations.", "properties": { - "textMessage": { - "$ref": "#/definitions/textMessageDeliveryConfigurationType" + "externalDeviceConfigurations": { + "description": "Configuration details of the external device that will be enabled for the hotel.", + "$ref": "#/definitions/externalDeviceConfigurationType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "queueRushDeliveryMethodType": { - "description": "Queue rush delivery method configuration, settings for Text Message Delivery of Queue Reservation status", + "changedExternalDeviceConfigurations": { "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", "properties": { - "textMessage": { - "$ref": "#/definitions/textMessageDeliveryConfigurationType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "sftpConfigurationType": { - "description": "Information which uniquely identifies SFTP Configuration", + "hotelInterface": { "type": "object", + "description": "Request object for creating a new Hotel Interface.", "properties": { - "configurationId": { - "description": "Unique id associated with this configuration", - "type": "integer" + "details": { + "$ref": "#/definitions/hotelInterfaceDetailType" }, - "description": { - "description": "Description of the destination, such as Shift Reports.", - "type": "string", - "maxLength": 200, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "destination": { - "description": "SFTP destination", - "type": "string", - "maxLength": 20, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "fetchedHotelInterfaceDetails": { + "type": "object", + "description": "Response object for retrieving the details of a Hotel Interface.", + "properties": { + "details": { + "$ref": "#/definitions/hotelInterfaceDetailType" }, - "hotelId": { - "description": "Hotel code", - "type": "string", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "inactive": { - "description": "Indicates whether the configuration is inactive or not.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "sftpConfigurationsListType": { - "description": "Type that holds sftp configurations", + "fetchedInterfaceRooms": { "type": "array", - "maxItems": 4000, + "description": "Collection of Hotel Interface Rooms.", "items": { - "$ref": "#/definitions/sftpConfigurationType" + "$ref": "#/definitions/interfaceRoomType" + } + }, + "createInterfaceRoom": { + "type": "object", + "description": "Request object for creating an Interface Room of a Hotel Interface record.", + "properties": { + "room": { + "$ref": "#/definitions/interfaceRoomType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "changeInterfaceRoom": { + "type": "object", + "description": "Request object for updating an Interface Room of a Hotel Interface record.", + "properties": { + "room": { + "$ref": "#/definitions/interfaceRoomType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "status": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "changedInterfaceRoom": { "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", "properties": { "links": { "$ref": "#/definitions/links" @@ -4730,329 +9979,191 @@ } } }, - "templateDeviceLocationType": { - "description": "Contains Common Master configuration detail.", + "importInterfaceRooms": { "type": "object", + "description": "Request object for importing the Interface Rooms for a Hotel Interface record.", "properties": { - "code": { - "description": "Common Master unique code.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "details": { + "$ref": "#/definitions/importInterfaceRoomsType" }, - "description": { - "description": "Description of the Master code.", - "$ref": "#/definitions/translationTextType2000" + "dMLCommand": { + "$ref": "#/definitions/dMLCommandType" }, - "displayOrder": { - "description": "Common Master record sequence number.", - "type": "number" + "targetedImport": { + "$ref": "#/definitions/interfaceRoomType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "templateDeviceLocationsCriteria": { - "description": "Request object for creating template Device locations.", + "createInterfaceAccount": { "type": "object", + "description": "Request object for creating an Interface Account of a Hotel Interface record.", "properties": { + "account": { + "$ref": "#/definitions/interfaceAccountType" + }, "links": { "$ref": "#/definitions/links" }, - "templateDeviceLocations": { - "description": "Template Device locations to be created.", - "$ref": "#/definitions/templateDeviceLocationsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateDeviceLocationsDetails": { - "description": "Response object for fetching template Device locations.", + "changeInterfaceAccount": { "type": "object", + "description": "Request object for updating an Interface Account of a Hotel Interface record.", "properties": { + "account": { + "$ref": "#/definitions/interfaceAccountType" + }, "links": { "$ref": "#/definitions/links" }, - "templateDeviceLocations": { - "description": "Collection of template Device locations.", - "$ref": "#/definitions/templateDeviceLocationsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateDeviceLocationsToBeChanged": { - "description": "Request object for changing template Device locations.", + "changedInterfaceAccount": { "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", "properties": { "links": { "$ref": "#/definitions/links" }, - "templateDeviceLocations": { - "description": "Template Device locations to be changed.", - "$ref": "#/definitions/templateDeviceLocationsType" - }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "templateDeviceLocationsType": { - "description": "List of Device locations at template level.", + "fetchedInterfaceMachines": { "type": "array", - "maxItems": 4000, + "description": "Collection of Hotel Interface Machines.", "items": { - "$ref": "#/definitions/templateDeviceLocationType" + "$ref": "#/definitions/interfaceMachineType" } }, - "textDeliveryMethodType": { - "description": "Text delivery method type", - "type": "string", - "enum": [ - "Url", - "Email" - ] - }, - "textMessageDeliveryConfigurationType": { - "description": "Text message delivery configuration", + "changeInterfaceMachine": { "type": "object", + "description": "Request object for updating a Hotel Interface Machine. If it does not exist, then creates the Hotel Interface Machine.", "properties": { - "account": { - "description": "Text field for Service ID or email account for the SMTP as advised by Text Messaging Provider.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "format": { - "description": "Text field for entering any special formatting for the delivery, or multi select LOV type, for example the one used for Address Format for selection of SID fields, to allow users choosing from a list of tags that may be used to customize this field.", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "hotelId": { - "description": "Hotel code", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "message": { - "description": "Text field for entering the Text Message for delivery.", - "type": "string", - "maxLength": 4000, - "minLength": 0 - }, - "password": { - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "serverName": { - "description": "Text field for Service type or email server address for the SMTP.", - "type": "string", - "maxLength": 80, - "minLength": 0 - }, - "timeOut": { - "description": "Number field for Delivery time out in seconds for the message. Any message exceeding this limit will be timed out. Add word Seconds using small grey font next to the number box.", - "type": "integer" - }, - "type": { - "description": "Type of Delivery Method HTTP/SMTP: HTTP for URL, SMTP for Email", - "$ref": "#/definitions/textDeliveryMethodType" - }, - "uRLParameter": { - "description": "Url parameter(format) is supported by Text Messaging Provider, it can be either an XML or TEXT format.", - "$ref": "#/definitions/urlFormatType" + "details": { + "$ref": "#/definitions/interfaceMachineType" }, - "url": { - "description": "Text field for URL address or the Text Messaging Provider.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "userId": { - "description": "Partner or User ID, Text field for Partner ID or User ID for the delivery provider, Name of the Text Messaging Provider.", - "type": "string", - "maxLength": 80, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "translationTextType2000": { - "description": "Contains Multiple translated texts and language codes.", + "changedInterfaceMachine": { "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", "properties": { - "defaultText": { - "description": "Default text with Character length from 0 to 2000.", - "type": "string", - "maxLength": 2000, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "translatedTexts": { - "description": "List of translated text and language codes.", - "$ref": "#/definitions/translationsTextType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "translationsTextType": { - "description": "Language code for the translation.", + "fetchedInterfaceRoomStatuses": { "type": "array", - "maxItems": 4000, + "description": "Collection of Hotel Interface Room Statuses.", "items": { - "description": "Language code for the translation.", - "type": "object", - "properties": { - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "value": { - "description": "Used for Character Strings, length 0 to 2000.", - "type": "string", - "maxLength": 2000, - "minLength": 0 - } - } + "$ref": "#/definitions/interfaceRoomStatusType" } }, - "uDFMappingType": { - "description": "Generic self-contained request object that is used when updating and fetching UDFs.", + "changeInterfaceRoomStatus": { "type": "object", + "description": "Request object for updating a Hotel Interface Room Status. If it does not exist, then creates the Hotel Interface Room Status.", "properties": { - "active": { - "description": "A flag to indicate whether the UDF mapping is active in the Interface system or not.", - "type": "boolean" - }, - "type": { - "description": "A reference to the type of object defined by the Type for Reservation and Profile Type.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "uDFLabel": { - "description": "Label the user-defined function (UDF) field shared with external system which will be send in the request message for mapping of actual UDF Name.", - "type": "string", - "maxLength": 200, - "minLength": 0 + "details": { + "$ref": "#/definitions/interfaceRoomStatusType" }, - "uDFName": { - "description": "Name of the user-defined function (UDF) field.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "updateAllowed": { - "description": "A flag to indicate whether the update is allowed in the Interface system or not.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "uniqueID_Type": { - "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).", + "changedInterfaceRoomStatus": { "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", "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", - "maxLength": 80, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "maxLength": 40, - "minLength": 0 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "urlFormatType": { - "description": "Url content format", - "type": "string", - "enum": [ - "Xml", - "Text" - ] - }, - "warningType": { - "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", + "fetchedInterfaceUnitCharges": { "type": "object", + "description": "Response object for retrieving the Interface Unit Charges.", "properties": { - "code": { - "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "docURL": { - "description": "If present, this URL refers to an online description of the error that occurred.", - "type": "string", - "maxLength": 2000 - }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "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 - }, - "rph": { - "description": "Reference Place Holder used as an index for this warning.", - "type": "string", - "maxLength": 8, - "minLength": 1 - }, - "shortText": { - "description": "An abbreviated version of the error in textual format.", - "type": "string", - "maxLength": 2000 + "details": { + "$ref": "#/definitions/interfaceUnitChargesType" }, - "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 + "links": { + "$ref": "#/definitions/links" }, - "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 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "changeInterfaceUnitCharges": { + "type": "object", + "description": "Request object for updating Hotel Interface Unit Charges.", + "properties": { + "details": { + "$ref": "#/definitions/interfaceUnitChargesType" }, - "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", - "maxLength": 20, - "minLength": 0 + "links": { + "$ref": "#/definitions/links" }, - "value": { - "description": "Property Value", - "type": "string" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "warningsType": { - "description": "Used in conjunction with the Success element to define a business error.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/warningType" + "changedInterfaceUnitCharges": { + "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "properties": { + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } } }, "tags": [ { - "description": "The BEProcessor Service offers capability of creating, managing, and retrieving of BE Processor configuration.", - "name": "BEProcessor" + "name": "BEProcessor", + "description": "The BEProcessor Service offers capability of creating, managing, and retrieving of BE Processor configuration." }, { "name": "ExternalSystemsConfig" }, { - "description": "These APIs will allow you to do external configuration under Administration.", - "name": "ChainConfig" + "name": "ChainConfig", + "description": "These APIs will allow you to do external configuration under Administration." } ], "externalDocs": { diff --git a/rest-api-specs/property/repcfg.json b/rest-api-specs/property/repcfg.json new file mode 100644 index 0000000..a59fbbf --- /dev/null +++ b/rest-api-specs/property/repcfg.json @@ -0,0 +1,1905 @@ +{ + "swagger": "2.0", + "info": { + "title": "OPERA Cloud Report Master Data Management API", + "description": "APIs catering to the managing export master data configuration in a hotel.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, 2023 Oracle and/or its affiliates.
", + "version": "23.4", + "termsOfService": "https://www.oracle.com/legal/terms.html", + "contact": { + "email": "hospitality-integrations_ww@oracle.com" + }, + "license": { + "name": "UPL", + "url": "https://opensource.org/licenses/upl" + } + }, + "schemes": [ + "https" + ], + "basePath": "/rep/config/v1", + "produces": [ + "application/json" + ], + "paths": { + "/reportTextConfiguration/copy": { + "put": { + "summary": "Operation to copy report text configuration.", + "description": "OperationId:copyReportTextConfiguration
", + "operationId": "copyReportTextConfiguration", + "parameters": [ + { + "name": "reportTextConfigurationsCopy", + "in": "body", + "required": true, + "description": "Request object to copy the Report Text Configuration from Source Property to Destination Properties.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/reportTextConfigurationsCopy" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Existing Operations Responses will eventually be modified to be extended from this type.", + "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": [ + "Report" + ] + } + }, + "/reportParameters": { + "get": { + "summary": "Return report parameters.", + "description": "Use this API to return report parameters based on search criteria such as id, idContext, type.OperationId:getReportParameters
", + "operationId": "getReportParameters", + "parameters": [ + { + "name": "id", + "minLength": 0, + "maxLength": 80, + "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", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" + }, + { + "name": "type", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "The Fetch Report Parameters result object contains a collection of report parameters which allow/require user input prior to running the report.", + "schema": { + "$ref": "#/definitions/reportParameters" + } + }, + "204": { + "description": "ReportParameters 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": [ + "Report" + ] + } + }, + "/genericReports": { + "post": { + "summary": "Create generic reports.", + "description": "Use this API to create generic reports.OperationId:postGenericReports
", + "operationId": "postGenericReports", + "parameters": [ + { + "name": "genericReports", + "in": "body", + "required": true, + "description": "This request provides End of Day reports to be created.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/genericReports" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "Report" + ] + }, + "delete": { + "summary": "Delete generic reports.", + "description": "Use this API to delete generic reports based on hotelId, Id, contextId.OperationId:deleteGenericReports
", + "operationId": "deleteGenericReports", + "parameters": [ + { + "name": "hotelId", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "type": "string", + "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." + }, + { + "name": "id", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "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. Refer to OpenTravel Code List Unique ID Type (UIT).", + "items": { + "type": "string" + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "Report" + ] + }, + "put": { + "summary": "Update generic reports.", + "description": "Use this API to update generic reports.OperationId:changeGenericReports
", + "operationId": "changeGenericReports", + "parameters": [ + { + "name": "genericReports", + "in": "body", + "required": true, + "description": "This request provides generic reports to be updated.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/genericReports" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "This response provides the result of updating reports.", + "schema": { + "$ref": "#/definitions/genericReports" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "Report" + ] + } + }, + "/reports": { + "get": { + "summary": "Return reports.", + "description": "Use this API to return reports based on search criteria such as excludeGroup, includeInternalReports, includeUnpublished, includeWatermarkDetails, limit, multiPropertyOnly, protectedReportParam, scheduled, name, group, hotel, id, idContext, type.OperationId:getReports
", + "operationId": "getReports", + "parameters": [ + { + "name": "excludeGroup", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "description": "Indicates whether a report group should be excluded", + "type": "string" + }, + { + "name": "includeInternalReports", + "in": "query", + "required": false, + "description": "Indicates whether sample internal reports are to be included", + "type": "boolean" + }, + { + "name": "includeUnpublished", + "in": "query", + "required": false, + "description": "Indicates whether protected reports should be included", + "type": "boolean" + }, + { + "name": "includeWatermarkDetails", + "in": "query", + "required": false, + "description": "Indicates whether the watermark details is to be populated. This is needed only for the configuration and not for the actual execution.", + "type": "boolean" + }, + { + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" + }, + { + "name": "multiPropertyOnly", + "in": "query", + "required": false, + "description": "Indicates whether the result set should only include multi-property reports.", + "type": "boolean" + }, + { + "name": "protectedReportParam", + "in": "query", + "required": false, + "description": "Indicates whether protected reports should be included", + "type": "boolean" + }, + { + "name": "scheduled", + "in": "query", + "required": false, + "description": "Indicates that only reports that can be scheduled are included", + "type": "boolean" + }, + { + "name": "name", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "description": "Partial report name or description to search.", + "type": "string" + }, + { + "name": "group", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "description": "Report group to limit search.", + "type": "string" + }, + { + "name": "hotel", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "description": "Hotel code to search reports for.", + "type": "string" + }, + { + "name": "id", + "minLength": 0, + "maxLength": 80, + "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", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" + }, + { + "name": "type", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "This type contains a collection of report modules which match the requested criteria. The object also may include a standard SUCCESS element or a WARNINGS or ERRORS collection.", + "schema": { + "$ref": "#/definitions/reports" + } + }, + "204": { + "description": "Reports 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": [ + "Report" + ] + } + } + }, + "parameters": { + "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-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": 80, + "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": { + "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" + ] + }, + "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" + } + }, + "required": [ + "href", + "rel", + "method", + "operationId" + ] + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/instanceLink" + } + }, + "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 + } + } + }, + "status": { + "type": "object", + "description": "Existing Operations Responses will eventually be modified to be extended from this type.", + "properties": { + "warnings": { + "$ref": "#/definitions/warningsType" + }, + "links": { + "$ref": "#/definitions/links" + } + } + }, + "copyReportsType": { + "type": "object", + "description": "Copy report configuration code from one property to the other.", + "properties": { + "codes": { + "description": "List of Code that is to be copied.", + "$ref": "#/definitions/codeListType" + }, + "targetHotelCodes": { + "description": "Property to which configuration code type to be copied to.", + "$ref": "#/definitions/codeListType" + }, + "sourceHotelCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "codeListType": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "reportTextConfigurationsCopy": { + "type": "object", + "description": "Request object to copy the Report Text Configurations from Source Property to Destination Properties.", + "properties": { + "copyReports": { + "description": "List of Report type to copy", + "$ref": "#/definitions/copyReportsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "reports": { + "type": "object", + "description": "This type contains a collection of report modules which match the requested criteria. The object also may include a standard SUCCESS element or a WARNINGS or ERRORS collection.", + "properties": { + "reports": { + "description": "The collection of reports that matches the requested criteria.", + "$ref": "#/definitions/reportsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "reportParameters": { + "type": "object", + "description": "The Fetch Report Parameters result object contains a collection of report parameters which allow/require user input prior to running the report.", + "properties": { + "reportParameters": { + "description": "This element holds the collection of report parameters for user input.", + "$ref": "#/definitions/reportParametersType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "genericReports": { + "type": "object", + "description": "This request provides End of Day reports to be created.", + "properties": { + "reports": { + "description": "It contains collection of reports setup to be saved.", + "$ref": "#/definitions/configGenericReportsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "reportsType": { + "type": "object", + "description": "Contains a collection of reports matching the requested criteria.", + "properties": { + "reports": { + "description": "List of reports matching search criteria.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reportType" + } + }, + "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" + } + } + }, + "reportType": { + "type": "object", + "description": "Contains details about the report application module from the DB.", + "properties": { + "moduleId": { + "description": "Report module ID (table key).", + "$ref": "#/definitions/uniqueID_Type" + }, + "reportName": { + "description": "Report name.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "moduleType": { + "description": "Module type either RTF,GRP,SFT,URL or REP.", + "$ref": "#/definitions/reportModuleTypeType" + }, + "reportDescription": { + "description": "Report description.", + "$ref": "#/definitions/translationTextType1000" + }, + "reportGroupId": { + "description": "Report group module ID.", + "$ref": "#/definitions/uniqueID_Type" + }, + "reportGroup": { + "description": "Report group.", + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "attachedReports": { + "description": "List of Reports attached with the Shift Report group.", + "$ref": "#/definitions/uniqueIDListType" + }, + "reportGroupDescription": { + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "translatableReportGroupDescription": { + "description": "Translatable Name of the Report Group Description.", + "$ref": "#/definitions/translationTextType1000" + }, + "hotel": { + "description": "The hotel code that the report is associated with.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "formToRun": { + "description": "Form which is run to collect parameter information to generate the report.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "languageCode": { + "description": "Report language code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hasParameters": { + "description": "Flag which indicates whether the report requires parameters.", + "type": "boolean" + }, + "sample": { + "description": "Flag which indicates whether the report is a sample provided in the application.", + "type": "boolean" + }, + "customized": { + "description": "Flag which indicates whether the report is customized by the user.", + "type": "boolean" + }, + "customizedRtfAttachId": { + "description": "Customized RTF file's Attach ID in the database.", + "$ref": "#/definitions/uniqueID_Type" + }, + "canRunSeperate": { + "description": "Flag which indicates if the report can be run separately.", + "type": "boolean" + }, + "multiPropertyReport": { + "description": "Flag which indicates if the report can be run for multiple properties.", + "type": "boolean" + }, + "procedureRequired": { + "description": "Flag which indicates whether the report requires a procedure.", + "type": "boolean" + }, + "userDefinedReport": { + "description": "Flag which indicates whether the report is user defined.", + "type": "boolean" + }, + "protectedReport": { + "description": "Flag which indicates whether the report is protected.", + "type": "boolean" + }, + "systemReport": { + "description": "Flag to indicate whether this is a system report.", + "type": "boolean" + }, + "destination": { + "description": "Report default destination.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "defaultPrinterName": { + "description": "Default printer name.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "copies": { + "description": "Number of copies configured for report.", + "type": "integer" + }, + "shiftReport": { + "description": "Flag to indicate whether this is a shift report.", + "type": "boolean" + }, + "dataSourceType": { + "description": "Set to ODT for BI Publisher reports.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "dataSource": { + "description": "Data source for BI Publisher reports.", + "type": "string", + "minLength": 0, + "maxLength": 255 + }, + "usedInApp": { + "description": "A comma separated list of Opera V5 application indicators for which the report is enabled.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "opera9Certified": { + "description": "A flag indicating that the report has been certified for use with Opera 9.", + "type": "boolean" + }, + "watermarkDetails": { + "description": "The watermark details of the report being retrieved.", + "$ref": "#/definitions/watermarkType" + }, + "externalReportUrl": { + "description": "Information regarding Report Url from external source.", + "$ref": "#/definitions/externalUrlInfoType" + }, + "rowsPerPage": { + "description": "Rows for Key Packet report group.", + "type": "integer" + }, + "columnsPerPage": { + "description": "Columns for Key Packet report group.", + "type": "integer" + }, + "excelOutput": { + "description": "Flag to indicate whether the report can be exported to Excel.", + "type": "boolean" + } + } + }, + "reportModuleTypeType": { + "type": "string", + "description": "Procedure Report", + "enum": [ + "Rtf", + "Cus", + "Rep", + "Sft", + "Grp", + "Url", + "Lbl", + "Pcd" + ] + }, + "watermarkType": { + "type": "object", + "description": "Details of the watermark to be used at the time of report generation.", + "properties": { + "mode": { + "description": "Watermark for PDF files", + "$ref": "#/definitions/watermarkModeType" + }, + "text": { + "description": "Watermark Text.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "font": { + "description": "Watermark font name.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "fontSize": { + "description": "Watermark font name.", + "type": "number" + }, + "xPosition": { + "description": "X position of watermark on page starting in lower left corner.", + "type": "integer" + }, + "yPosition": { + "description": "Y position of watermark on page starting in lower left corner.", + "type": "integer" + }, + "angle": { + "description": "Watermark angle in degrees.", + "type": "integer" + }, + "red": { + "description": "Watermark color (red), value ranges from 0.0 to 1.0 ( Java API values ).", + "type": "number" + }, + "green": { + "description": "Watermark color (green), value ranges from 0.0 to 1.0 ( Java API values ).", + "type": "number" + }, + "blue": { + "description": "Watermark color (blue), value ranges from 0.0 to 1.0 ( Java API values ).", + "type": "number" + } + } + }, + "watermarkModeType": { + "type": "string", + "description": "Identifies the data type of the report parameter.", + "enum": [ + "Simple", + "Enhanced", + "NoWatermark", + "GroupSettings" + ] + }, + "translationTextType1000": { + "type": "object", + "description": "Contains Multiple translated texts and language codes.", + "properties": { + "defaultText": { + "description": "Default text with Character length from 0 to 1000.", + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "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", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + } + }, + "description": "Language code for the translation." + } + }, + "uniqueIDListType": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "externalUrlInfoType": { + "type": "object", + "description": "Contains all the information of External Urls.", + "properties": { + "externalReportUrl": { + "description": "Report Url from external source.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "isUrlDynamic": { + "description": "Indicates if the Url is dynamic", + "type": "boolean" + } + } + }, + "reportParametersType": { + "type": "array", + "description": "List of parameters required to run report.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reportParameterType" + } + }, + "reportParameterType": { + "type": "object", + "description": "Defines an individual report parameter.", + "properties": { + "name": { + "description": "Individual report parameter details.", + "type": "string", + "minLength": 0, + "maxLength": 400 + }, + "label": { + "description": "Display label for report parameter.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "dataType": { + "description": "Report parameter data type used to determine kind of UI control to display.", + "$ref": "#/definitions/paramDataType" + }, + "value": { + "description": "Initial report parameter value.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "calculatedDateValue": { + "description": "Date value from offset.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "dateFormatMask": { + "description": "Format mask for date report parameters.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "orderBy": { + "description": "Report parameter display order.", + "type": "integer" + }, + "dateOffset": { + "description": "Number of days to offset from current business date for date report parameter.", + "type": "integer" + }, + "formatMask": { + "$ref": "#/definitions/paramFormatMaskType" + }, + "buildStringForDateOffset": { + "type": "string", + "minLength": 0, + "maxLength": 32000 + }, + "lovParam": { + "$ref": "#/definitions/lovParamDetailsType" + } + } + }, + "paramDataType": { + "type": "string", + "description": "Identifies the data type of the report parameter.", + "enum": [ + "DateAsChar", + "Date", + "Number", + "CheckBox", + "DateTime", + "Char", + "Money", + "Integer" + ] + }, + "lovParamDetailsType": { + "type": "object", + "description": "Identifies a destination record for the report.", + "properties": { + "lovSql": { + "description": "Query statement for LOV based report parameters.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "lOVs": { + "description": "Report parameter LOV details.", + "$ref": "#/definitions/paramLOVsType" + }, + "lovValidate": { + "description": "Flag to indicate that input should be validated against LOV.", + "type": "boolean" + }, + "lovMultiSelect": { + "description": "This attribute is used to indicate if an LOV defined is multi-select. This is particularly useful for simple reports.", + "type": "boolean" + } + } + }, + "paramLOVsType": { + "type": "array", + "description": "List of values for report parameter.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/paramLOVType" + } + }, + "paramLOVType": { + "type": "object", + "description": "Represents an individual LOV item for a report parameter.", + "properties": { + "code": { + "description": "Report parameter LOV code.", + "type": "string" + }, + "description": { + "description": "Report parameter LOV label.", + "type": "string" + }, + "string": { + "description": "Report parameter LOV string (third attribute returned for some queries).", + "type": "string" + } + } + }, + "paramFormatMaskType": { + "type": "string", + "description": "Specifies the format mask for the parameter.", + "enum": [ + "None", + "Upper", + "Lower" + ] + }, + "configGenericReportsType": { + "type": "object", + "description": "It contains collection of reports.", + "properties": { + "report": { + "description": "A generic report.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configGenericReportType" + } + }, + "hotelId": { + "description": "Hotel code in which reports to be set up belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "chainCode": { + "description": "Chain code in which reports to be set up belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "configGenericReportType": { + "type": "object", + "description": "A mandatory or non-mandatory procedure or report.", + "properties": { + "name": { + "description": "Display Name of procedure or report.", + "$ref": "#/definitions/translationTextType1000" + }, + "reportName": { + "description": "Name of the .REP or .RTF file. .REP or .RTF extension is not needed.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "userDefinedReport": { + "description": "Flag which indicates whether the report is user defined.", + "type": "boolean" + }, + "moduleType": { + "description": "Module type either RTF,GRP,SFT,URL or REP.", + "$ref": "#/definitions/reportModuleTypeType" + }, + "usedInApp": { + "description": "Report can be run in these applications - Global level, property level or in the Sales & Event Management.", + "type": "array", + "maxItems": 3, + "items": { + "$ref": "#/definitions/reportRunnableApps" + } + }, + "dataSourceType": { + "description": "Set to ODT for BI Publisher reports.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "dataSource": { + "description": "Data source for BI Publisher reports.", + "type": "string", + "minLength": 0, + "maxLength": 255 + }, + "mandatory": { + "description": "Flag indicating whether procedure or report is mandatory or not.", + "type": "boolean" + }, + "formToRun": { + "description": "Form which is run to collect parameter information to generate the report.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "reportLanguage": { + "description": "The language in which the report is configured. This language code will be used when running a report for guests like registration cards, folio etc when GUEST LANGUAGE functionality is turned on.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "active": { + "description": "Flag indicating whether procedure or report is active to run.", + "type": "boolean" + }, + "protected": { + "description": "Flag indicating whether report is protected or not.", + "type": "boolean" + }, + "sequence": { + "description": "Display sequence of procedure or report.", + "type": "integer" + }, + "reportGroup": { + "description": "Report group to which the report is being added.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "multiPropertyReport": { + "description": "Flag which indicates if the report can be run for multiple properties.", + "type": "boolean" + }, + "excelOutput": { + "description": "Flag to indicate whether the report can be exported to Excel.", + "type": "boolean" + }, + "attachedReports": { + "description": "List of Reports attached with the Shift Report group.", + "$ref": "#/definitions/uniqueIDListType" + }, + "watermarkDetails": { + "description": "The watermark details of the report being added.", + "$ref": "#/definitions/watermarkType" + }, + "parameters": { + "description": "A report parameter.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configReportParameterType" + } + }, + "rowsPerPage": { + "description": "Rows to be entered for Key Packet report group.", + "type": "integer" + }, + "columnsPerPage": { + "description": "Columns to be entered for Key Packet report group.", + "type": "integer" + }, + "moduleId": { + "description": "Module id of the report.", + "$ref": "#/definitions/uniqueID_Type" + }, + "externalReportUrl": { + "description": "Information regarding Report Url from external source.", + "$ref": "#/definitions/externalUrlInfoType" + }, + "printReport": { + "description": "Details of sending report to destination.", + "$ref": "#/definitions/printReportType" + } + } + }, + "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 + } + } + }, + "reportRunnableApps": { + "type": "string", + "description": "Simple type for report module type.", + "enum": [ + "Global", + "Property", + "SalesAndCatering" + ] + }, + "configReportParameterType": { + "type": "object", + "description": "A report parameter.", + "properties": { + "name": { + "description": "Report parameter name.", + "type": "string", + "minLength": 0, + "maxLength": 400 + }, + "label": { + "description": "Display label for report parameter.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "dataType": { + "description": "Report parameter data type.", + "$ref": "#/definitions/paramDataType" + }, + "value": { + "description": "Default report parameter value.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "dateOffset": { + "description": "Date Ofset could be in the format +x DAYS.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "lovSql": { + "description": "Query statement for LOV based report parameters.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "sequence": { + "description": "Display sequence of report parameter.", + "type": "integer" + } + } + }, + "printReportType": { + "type": "object", + "description": "Details to print or send report to printer, email or fax.", + "properties": { + "destination": { + "description": "Destination to which the report is directed to by default.", + "$ref": "#/definitions/printDestinationType" + }, + "copies": { + "description": "Number of copies to be printed or sent.", + "type": "integer" + }, + "sent": { + "description": "Indicates whether report has already been sent or not.", + "type": "boolean" + } + } + }, + "printDestinationType": { + "type": "string", + "description": "Allowed values for Print Destination.", + "enum": [ + "Printer", + "Email", + "Fax" + ] + } + }, + "tags": [ + { + "name": "Report", + "description": "The Report Service provides information about available report modules which may be generated, along with their parameters." + } + ], + "externalDocs": { + "description": "Find out more about Oracle Hospitality", + "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" + } +} \ No newline at end of file