This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.
", "version": "26.2.0.0", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" }, "license": { "name": "UPL", "url": "https://opensource.org/licenses/upl" } }, "schemes": [ "https" ], "basePath": "/crm/config/v1", "produces": [ "application/json" ], "paths": { "/accountOwners": { "get": { "summary": "Get Account Owners", "description": "Use this API to get Account Owners.OperationId:getAccountOwners
", "operationId": "getAccountOwners", "deprecated": true, "parameters": [ { "name": "chainCode", "in": "query", "required": true, "description": "Chain level code to which owners have access.This is a mandatory element.", "type": "string" }, { "name": "findExactOwnerCodeMatch", "in": "query", "required": false, "description": "Indicates if there is an exact match for the given owner code or not.", "type": "boolean" }, { "name": "maxFetchRecords", "in": "query", "required": false, "description": "Maximum number of records to be fetched.", "type": "integer" }, { "name": "hotelId", "in": "query", "required": false, "description": "Hotel code to which owners have access.", "type": "string" }, { "name": "ownerCode", "in": "query", "required": false, "description": "Wildcard search on owner codes.", "type": "string" }, { "name": "name", "in": "query", "required": false, "description": "Family name, last name or Company Name.", "type": "string" }, { "name": "givenName", "in": "query", "required": false, "description": "Given name, first name or names.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetch account owners.", "schema": { "$ref": "#/definitions/accountOwnersDetails" } }, "204": { "description": "AccountOwners 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" ] } }, "/accountOwners/searches": { "post": { "summary": "Get Account Owners", "description": "Use this API to get Account Owners.OperationId:searchAccountOwners
", "operationId": "searchAccountOwners", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "deprecated": false, "parameters": [ { "name": "searchAccountOwnersRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/searchAccountOwnersRequest" } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetch account owners.", "schema": { "$ref": "#/definitions/accountOwnersDetails" } }, "204": { "description": "AccountOwners 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" } }, "tags": [ "ChainConfig" ] } }, "/accountPriorities": { "get": { "summary": "Get Account Priorities", "description": "Use this API to get Account Priorities.OperationId:getAccountPriorities
", "operationId": "getAccountPriorities", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Account Priorities.", "schema": { "$ref": "#/definitions/accountPrioritiesDetails" } }, "204": { "description": "AccountPriorities 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 Account Priorities", "description": "Use this API to create Account Priorities.OperationId:postAccountPriorities
", "operationId": "postAccountPriorities", "parameters": [ { "name": "accountPrioritiesCriteria", "in": "body", "required": true, "description": "Request object for creating Account Priorities.", "schema": { "allOf": [ { "$ref": "#/definitions/accountPrioritiesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/accountPriorities/{accountPriorityId}": { "put": { "summary": "Change Account Priorities", "description": "Use this API to update Account Priorities.OperationId:putAccountPriorities
", "operationId": "putAccountPriorities", "parameters": [ { "name": "accountPriorityId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Account Priorities." }, { "name": "accountPrioritiesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Account Priorities.", "schema": { "allOf": [ { "$ref": "#/definitions/accountPrioritiesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Remove Account Priorities", "description": "Use this API to remove Account Priorities.OperationId:deleteAccountPriorities
", "operationId": "deleteAccountPriorities", "parameters": [ { "name": "accountPriorityId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Account Priorities." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/accountTypes": { "get": { "summary": "Get Account Types", "description": "Use this API to get Account Types.OperationId:getAccountTypes
", "operationId": "getAccountTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Account Types.", "schema": { "$ref": "#/definitions/accountTypesDetails" } }, "204": { "description": "AccountTypes 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 Account Types", "description": "Use this API to create Account Types.OperationId:postAccountTypes
", "operationId": "postAccountTypes", "parameters": [ { "name": "accountTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Account Types.", "schema": { "allOf": [ { "$ref": "#/definitions/accountTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/accountTypes/{accountTypesId}": { "put": { "summary": "Change Account Types", "description": "Use this API to update Account Types.OperationId:putAccountTypes
", "operationId": "putAccountTypes", "parameters": [ { "name": "accountTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Account Types." }, { "name": "accountTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Account Types.", "schema": { "allOf": [ { "$ref": "#/definitions/accountTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Remove Account Types", "description": "Use this API to remove Account Types.OperationId:deleteAccountTypes
", "operationId": "deleteAccountTypes", "parameters": [ { "name": "accountTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Account Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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", "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" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Address Formats.", "schema": { "$ref": "#/definitions/addressFormats" } }, "204": { "description": "AddressFormats 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change address formats", "description": "You can use this API to change address formats.OperationId:putAddressFormats
", "operationId": "putAddressFormats", "parameters": [ { "name": "addressFormats", "in": "body", "required": true, "description": "Request object for change address formats.", "schema": { "allOf": [ { "$ref": "#/definitions/addressFormats" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete address formats", "description": "You can use this API to delete address formats.OperationId:deleteAddressFormats
", "operationId": "deleteAddressFormats", "parameters": [ { "name": "formatCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": true }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create address formats", "description": "You can use this API to create address formats.OperationId:postAddressFormats
", "operationId": "postAddressFormats", "parameters": [ { "name": "addressFormats", "in": "body", "required": true, "description": "Request object for creating address formats.", "schema": { "allOf": [ { "$ref": "#/definitions/addressFormats" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/addressTypes": { "get": { "summary": "Get Address types", "description": "Use this API to get Address types.OperationId:getAddressTypes
", "operationId": "getAddressTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Address Types.", "schema": { "$ref": "#/definitions/addressTypesDetails" } }, "204": { "description": "AddressTypes 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 a new Address type", "description": "Use this API to create a new Address type.OperationId:postAddressTypes
", "operationId": "postAddressTypes", "parameters": [ { "name": "addressTypesCriteria", "in": "body", "required": true, "description": "Request object for creating a new Address Type.", "schema": { "allOf": [ { "$ref": "#/definitions/addressTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/addressTypes/{addressTypeId}": { "put": { "summary": "Change an existing Address type", "description": "Use this API to update an existing Address type.OperationId:putAddressTypes
", "operationId": "putAddressTypes", "parameters": [ { "name": "addressTypeId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of address type" }, { "name": "addressTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing an existing Address Type.", "schema": { "allOf": [ { "$ref": "#/definitions/addressTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete an existing Address type", "description": "Use this API to delete an existing Address type.OperationId:deleteAddressTypes
", "operationId": "deleteAddressTypes", "parameters": [ { "name": "addressTypeId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of address type" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "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" ] } }, "/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": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "titleCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description of the Guest Title.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Alternate Language Guest Titles.", "schema": { "$ref": "#/definitions/alternateLanguageGuestTitlesDetails" } }, "204": { "description": "AlternateLanguageGuestTitles 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 Alternate Language Guest Titles", "description": "Use this API to create Alternate Language Guest Titles.OperationId:postAlternateLanguageGuestTitles
", "operationId": "postAlternateLanguageGuestTitles", "parameters": [ { "name": "alternateLanguageGuestTitlesCriteria", "in": "body", "required": true, "description": "Request object for creating Alternate Language Guest Titles.", "schema": { "allOf": [ { "$ref": "#/definitions/alternateLanguageGuestTitlesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/alternateLanguages/{guestTitlesCode}": { "put": { "summary": "Change Alternate Language Guest Titles", "description": "Use this API to modify Alternate Language Guest Titles.OperationId:changeAlternateLanguageGuestTitles
", "operationId": "changeAlternateLanguageGuestTitles", "parameters": [ { "name": "guestTitlesCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guest Titles." }, { "name": "alternateLanguageGuestTitlesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Alternate Language Guest Titles.", "schema": { "allOf": [ { "$ref": "#/definitions/alternateLanguageGuestTitlesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Alternate Language Guest Titles", "description": "Use this API to delete Alternate Language Guest Titles.OperationId:removeAlternateLanguageGuestTitles
", "operationId": "removeAlternateLanguageGuestTitles", "parameters": [ { "name": "guestTitlesCode", "in": "path", "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" }, "required": false }, { "name": "titleTypes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Title Type for advanced title configuration.", "items": { "type": "integer" }, "required": false }, { "name": "titleDescription", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Description of the Guest Title.", "items": { "type": "string" }, "required": false }, { "name": "greeting", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Business Title for advanced title configuration.", "items": { "type": "string" }, "required": false }, { "name": "displayOrder", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Guest Title record sequence number.", "items": { "type": "number" }, "required": false }, { "name": "newTitleType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Description of the Guest Title.", "items": { "type": "integer" }, "required": false }, { "name": "newLanguageCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Description of the Guest Title.", "items": { "type": "string" }, "required": false }, { "name": "code", "in": "query", "required": false, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guest Titles." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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": [ { "name": "hotelId", "in": "query", "required": true, "type": "string" }, { "name": "isOnlyForReservation", "in": "query", "default": "true", "required": false, "type": "boolean", "description": "Flag for available reservation preferences, by default its true" }, { "name": "preferenceType", "in": "query", "required": false, "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "A collection of preferences", "schema": { "$ref": "#/definitions/availablePreferencesDetails" } }, "204": { "description": "AvailablePreferences 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" ] } }, "/businessSegments": { "get": { "summary": "Get Business Segments", "description": "Use this API to get Business Segments.OperationId:getBusinessSegments
", "operationId": "getBusinessSegments", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Business Segments.", "schema": { "$ref": "#/definitions/businessSegmentsDetails" } }, "204": { "description": "BusinessSegments 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 Business Segments", "description": "Use this API to create Business Segments.OperationId:postBusinessSegments
", "operationId": "postBusinessSegments", "parameters": [ { "name": "businessSegmentsCriteria", "in": "body", "required": true, "description": "Request object for creating Business Segments.", "schema": { "allOf": [ { "$ref": "#/definitions/businessSegmentsCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/businessSegments/{businessSegmentCode}": { "put": { "summary": "Change Business Segments", "description": "Use this API to update Business Segments.OperationId:changeBusinessSegments
", "operationId": "changeBusinessSegments", "parameters": [ { "name": "businessSegmentCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Business Segments." }, { "name": "businessSegmentsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Business Segments.", "schema": { "allOf": [ { "$ref": "#/definitions/businessSegmentsToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Business Segments", "description": "Use this API to delete Business Segments.OperationId:removeBusinessSegments
", "operationId": "removeBusinessSegments", "parameters": [ { "name": "businessSegmentCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Business Segments." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/cityPostalCodes": { "get": { "summary": "Get CityPostalCodes", "description": "Use this API to get City Postal Codes.OperationId:getCityPostalCodes
The maximum allowable limit for this API is 1000.
", "operationId": "getCityPostalCodes", "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": "postalCodeFrom", "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" }, { "name": "postalCodeTo", "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" }, { "name": "cityWildCard", "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", "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": "stateCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "stateWildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "territoryCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "territoryWildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "districtCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "districtWildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching city and postal codes.", "schema": { "$ref": "#/definitions/cityPostalCodesDetails" } }, "204": { "description": "CityPostalCodes 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 CityPostalCodes", "description": "Use this API to create City Postal Codes.OperationId:postCityPostalCodes
", "operationId": "postCityPostalCodes", "parameters": [ { "name": "cityPostalCodesCriteria", "in": "body", "required": true, "description": "Request object for creating new city and postal codes.", "schema": { "allOf": [ { "$ref": "#/definitions/cityPostalCodesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/cityPostalCodes/{postalCode}": { "put": { "summary": "Change City Postal Codes", "description": "Use this API to update City Postal Codes.OperationId:changeCityPostalCodes
", "operationId": "changeCityPostalCodes", "parameters": [ { "name": "postalCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Postals." }, { "name": "cityPostalCodesToBeChanged", "in": "body", "required": true, "description": "Request object for updating city and postal codes.", "schema": { "allOf": [ { "$ref": "#/definitions/cityPostalCodesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete City Postal Codes", "description": "Use this API to delete City Postal Codes.OperationId:removeCityPostalCodes
", "operationId": "removeCityPostalCodes", "parameters": [ { "name": "postalCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Postals." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/upsert/cityPostalCodes" : { "put" : { "summary" : "Create/Change City Postal Codes", "description" : "Use this API to create/update City Postal Codes.OperationId:changeUpsertCityPostalCodes
", "operationId" : "changeUpsertCityPostalCodes", "parameters" : [ { "name" : "cityPostalCodesToBeChanged", "in" : "body", "required" : true, "description" : "Request object for updating city and postal codes.", "schema" : { "allOf" : [ { "$ref" : "#/definitions/cityPostalCodesToBeChanged" } ] } }, { "$ref" : "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref" : "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref" : "#/parameters/x-hotelid" }, { "$ref" : "#/parameters/x-externalsystem" }, { "$ref" : "#/parameters/Accept-Language" } ], "responses" : { "200" : { "headers" : { "Content-Language" : { "type" : "string", "description" : "Audience language", "pattern" : "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example" : "en-GB" }, "Location" : { "type" : "string", "description" : "Location of newly created resource" } }, "description" : "Response Body.", "schema" : { "$ref" : "#/definitions/status" } } }, "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "tags" : [ "ChainConfig" ] } }, "/claimAdjustmentLimits": { "get": { "summary": "Get Claim Adjustment Limits", "description": "You can use this API to get Claim Adjustment Limits.This API is deprecated.
OperationId:getClaimAdjustmentLimits
", "operationId": "getClaimAdjustmentLimits", "parameters": [ { "name": "limitCodes", "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": "The name of the property code for the Claim Adjustment Limit to be searched.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Claim Adjustment Limits.", "schema": { "$ref": "#/definitions/claimAdjustmentLimitsInfo" } }, "204": { "description": "ClaimAdjustmentLimits 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change Claim Adjustment Limits", "description": "You can use this API to change Claim Adjustment Limits.This API is deprecated.
OperationId:putClaimAdjustmentLimits
", "operationId": "putClaimAdjustmentLimits", "parameters": [ { "name": "claimAdjustmentLimits", "in": "body", "required": true, "description": "Request object for modifying Claim Adjustment Limits.", "schema": { "allOf": [ { "$ref": "#/definitions/claimAdjustmentLimits" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create Claim Adjustment Limits", "description": "You can use this API to create Claim Adjustment Limits.This API is deprecated.
OperationId:postClaimAdjustmentLimits
", "operationId": "postClaimAdjustmentLimits", "parameters": [ { "name": "claimAdjustmentLimits", "in": "body", "required": true, "description": "Request object for creating Claim Adjustment Limits.", "schema": { "allOf": [ { "$ref": "#/definitions/claimAdjustmentLimits" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/upsert/claimAdjustmentLimits" : { "put" : { "summary" : "Create/Change Claim Adjustment Limits", "description" : "You can use this API to create/change Claim Adjustment Limits.This API is deprecated.
OperationId:putUpsertClaimAdjustmentLimits
", "operationId" : "putUpsertClaimAdjustmentLimits", "parameters" : [ { "name" : "claimAdjustmentLimits", "in" : "body", "required" : true, "description" : "Request object for modifying Claim Adjustment Limits.", "schema" : { "allOf" : [ { "$ref" : "#/definitions/claimAdjustmentLimits" } ] } }, { "$ref" : "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref" : "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref" : "#/parameters/x-hotelid" }, { "$ref" : "#/parameters/x-externalsystem" }, { "$ref" : "#/parameters/Accept-Language" } ], "responses" : { "200" : { "headers" : { "Content-Language" : { "type" : "string", "description" : "Audience language", "pattern" : "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example" : "en-GB" }, "Location" : { "type" : "string", "description" : "Location of newly created resource" } }, "description" : "Response Body.", "schema" : { "$ref" : "#/definitions/status" } } }, "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "tags" : [ "ProfileConfiguration" ] } }, "/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": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "roles", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Phone Number Communication Role.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Email", "Fax", "EmailForRequest", "Webpage", "Phone" ] }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description of the Communication Types to be searched.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Communication Types.", "schema": { "$ref": "#/definitions/communicationTypesDetails" } }, "204": { "description": "CommunicationTypes not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "HotelConfig" ] }, "post": { "summary": "Create a communication type", "description": "Use this API to create a communication type.OperationId:postCommunicationType
", "operationId": "postCommunicationType", "parameters": [ { "name": "communicationTypeCriteria", "in": "body", "required": true, "description": "Request object for creating a new Communication Type.", "schema": { "allOf": [ { "$ref": "#/definitions/communicationTypeCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "HotelConfig" ] } }, "/communicationTypes/{communicationTypeCode}": { "delete": { "summary": "Delete a communication type", "description": "Use this API to delete a communication type.OperationId:removeCommunicationType
", "operationId": "removeCommunicationType", "parameters": [ { "name": "communicationTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of communication Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "HotelConfig" ] }, "put": { "summary": "Change a communication type", "description": "Use this API to update a communication type.OperationId:changeCommunicationType
", "operationId": "changeCommunicationType", "parameters": [ { "name": "communicationTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of communication Types." }, { "name": "communicationTypeToBeChanged", "in": "body", "required": true, "description": "Request object for changing an existing Communication Type.", "schema": { "allOf": [ { "$ref": "#/definitions/communicationTypeToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "HotelConfig" ] } }, "/companyTypes": { "get": { "summary": "Get Company Types", "description": "Use this API to get Company Types.OperationId:getCompanyTypes
", "operationId": "getCompanyTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Company Types.", "schema": { "$ref": "#/definitions/companyTypesDetails" } }, "204": { "description": "CompanyTypes 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 Company Types", "description": "Use this API to create Company Types.OperationId:postCompanyTypes
", "operationId": "postCompanyTypes", "parameters": [ { "name": "companyTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Company Types.", "schema": { "allOf": [ { "$ref": "#/definitions/companyTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/companyTypes/{companyTypesCode}": { "put": { "summary": "Change Company Types", "description": "Use this API to update Company Types.OperationId:putCompanyTypes
", "operationId": "putCompanyTypes", "parameters": [ { "name": "companyTypesCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Company Types." }, { "name": "companyTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Company Types.", "schema": { "allOf": [ { "$ref": "#/definitions/companyTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Company Types", "description": "Use this API to delete Company Types.OperationId:deleteCompanyTypes
", "operationId": "deleteCompanyTypes", "parameters": [ { "name": "companyTypesCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Company Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/competitionCodes": { "get": { "summary": "Get Competition Codes", "description": "Use this API to get Competition Codes.OperationId:getCompetitionCodes
", "operationId": "getCompetitionCodes", "parameters": [ { "name": "fetchInactive", "in": "query", "default": "false", "required": true, "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Competition Codes.", "schema": { "$ref": "#/definitions/competitionCodesDetails" } }, "204": { "description": "CompetitionCodes 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 Competition Codes", "description": "Use this API to create Competition Codes.OperationId:postCompetitionCodes
", "operationId": "postCompetitionCodes", "parameters": [ { "name": "competitionCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Competition Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/competitionCodesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/competitionCodes/{competitionCodesId}": { "put": { "summary": "Change Competition Codes", "description": "Use this API to update Competition Codes.OperationId:putCompetitionCodes
", "operationId": "putCompetitionCodes", "parameters": [ { "name": "competitionCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Competition Codes." }, { "name": "competitionCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Competition Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/competitionCodesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Remove Competition Codes", "description": "Use this API to remove Competition Codes.OperationId:deleteCompetitionCodes
", "operationId": "deleteCompetitionCodes", "parameters": [ { "name": "competitionCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Competition Codes." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/correspondences": { "get": { "summary": "Get correspondence", "description": "Use this API to get correspondences.OperationId:getCorrespondences
", "operationId": "getCorrespondences", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching correspondences.", "schema": { "$ref": "#/definitions/correspondencesDetails" } }, "204": { "description": "correspondences 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 a new correspondence", "description": "Use this API to create a new correspondence.OperationId:postCorrespondences
", "operationId": "postCorrespondences", "parameters": [ { "name": "correspondencesCriteria", "in": "body", "required": true, "description": "Request object for creating a new correspondence Type.", "schema": { "allOf": [ { "$ref": "#/definitions/correspondencesCriteriaType" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/correspondences/{correspondenceId}": { "put": { "summary": "Change an existing correspondence", "description": "Use this API to update an existing correspondence type.OperationId:putCorrespondences
", "operationId": "putCorrespondences", "parameters": [ { "name": "correspondenceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 40, "description": "Unique ID of correspondence" }, { "name": "correspondenceToBeChanged", "in": "body", "required": true, "description": "Request object for changing an existing correspondence.", "schema": { "allOf": [ { "$ref": "#/definitions/correspondencesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete an existing correspondence", "description": "Use this API to delete an existing correspondence type.OperationId:deleteCorrespondences
", "operationId": "deleteCorrespondences", "parameters": [ { "name": "correspondenceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 40, "description": "Unique ID of correspondence" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/creditRatings": { "get": { "summary": "Get credit ratings", "description": "You can use this API to get credit ratings.OperationId:getCreditRatings
", "operationId": "getCreditRatings", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching credit ratings.", "schema": { "$ref": "#/definitions/creditRatings" } }, "204": { "description": "CreditRatings 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change credit ratings", "description": "You can use this API to change credit ratings.OperationId:putCreditRatings
", "operationId": "putCreditRatings", "parameters": [ { "name": "creditRatings", "in": "body", "required": true, "description": "Request object for changing credit ratings.", "schema": { "allOf": [ { "$ref": "#/definitions/creditRatings" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete credit ratings", "description": "You can use this API to delete credit ratings.OperationId:deleteCreditRatings
", "operationId": "deleteCreditRatings", "parameters": [ { "name": "creditRatings", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": true }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create credit ratings", "description": "You can use this API to create credit ratings.OperationId:postCreditRatings
", "operationId": "postCreditRatings", "parameters": [ { "name": "creditRatings", "in": "body", "required": true, "description": "Request object for creating credit ratings.", "schema": { "allOf": [ { "$ref": "#/definitions/creditRatings" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/distanceTypes": { "get": { "summary": "Get Distance Types", "description": "Use this API to get Distance Types.OperationId:getDistanceTypes
", "operationId": "getDistanceTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Distance Types.", "schema": { "$ref": "#/definitions/distanceTypesDetails" } }, "204": { "description": "DistanceTypes 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 Distance Types", "description": "Use this API to create Distance Types.OperationId:postDistanceTypes
", "operationId": "postDistanceTypes", "parameters": [ { "name": "distanceTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Distance Types.", "schema": { "allOf": [ { "$ref": "#/definitions/distanceTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/distanceTypes/{distanceTypesId}": { "put": { "summary": "Change Distance Types", "description": "Use this API to update Distance Types.OperationId:putDistanceTypes
", "operationId": "putDistanceTypes", "parameters": [ { "name": "distanceTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Distance Types." }, { "name": "distanceTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Distance Types.", "schema": { "allOf": [ { "$ref": "#/definitions/distanceTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Distance Types", "description": "Use this API to delete Distance Types.OperationId:deleteDistanceTypes
", "operationId": "deleteDistanceTypes", "parameters": [ { "name": "distanceTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Distance Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/districts": { "get": { "summary": "Get Districts", "description": "Use this API to get Districts.OperationId:getDistricts
", "operationId": "getDistricts", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Districts.", "schema": { "$ref": "#/definitions/districtsDetails" } }, "204": { "description": "Districts 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 Districts", "description": "Use this API to create Districts.OperationId:postDistricts
", "operationId": "postDistricts", "parameters": [ { "name": "districtsCriteria", "in": "body", "required": true, "description": "Request object for creating Districts.", "schema": { "allOf": [ { "$ref": "#/definitions/districtsCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/districts/{districtsId}": { "put": { "summary": "Change Districts", "description": "Use this API to update Districts.OperationId:putDistricts
", "operationId": "putDistricts", "parameters": [ { "name": "districtsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Remove Districts." }, { "name": "districtsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Districts.", "schema": { "allOf": [ { "$ref": "#/definitions/districtsToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Districts", "description": "Use this API to delete Districts.OperationId:deleteDistricts
", "operationId": "deleteDistricts", "parameters": [ { "name": "districtsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Remove Districts." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "preferenceGroupsCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "preferenceCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching exclusive preferences at the template level.", "schema": { "$ref": "#/definitions/templateExclusivePreferences" } }, "204": { "description": "TemplateExclusivePreferences 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change template Exclusive Preferences", "description": "You can use this API to change template Exclusive Preferences.OperationId:putTemplateExclusivePreferences
", "operationId": "putTemplateExclusivePreferences", "parameters": [ { "name": "templateExclusivePreferences", "in": "body", "required": true, "description": "Request object for changing Exclusive preferences at the template level.", "schema": { "allOf": [ { "$ref": "#/definitions/templateExclusivePreferences" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete template Exclusive Preferences", "description": "You can use this API to delete template Exclusive Preferences.OperationId:deleteTemplateExclusivePreferences
", "operationId": "deleteTemplateExclusivePreferences", "parameters": [ { "name": "exclusivePreferenceCode", "in": "query", "required": true, "description": "Specifies the Exclusive preference code.", "type": "string" }, { "name": "exclusivePreferenceGroup", "in": "query", "required": true, "description": "Specifies the preference group the Exclusive preference belongs to.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create template Exclusive Preferences", "description": "You can use this API to create template Exclusive Preferences.OperationId:postTemplateExclusivePreferences
", "operationId": "postTemplateExclusivePreferences", "parameters": [ { "name": "templateExclusivePreferences", "in": "body", "required": true, "description": "Request object for creating exclusive preferences at the template level.", "schema": { "allOf": [ { "$ref": "#/definitions/templateExclusivePreferences" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/exclusivePreferences/copy": { "put": { "summary": "Copy Exclusive Preferences", "description": "You can use this API to copy Exclusive Preferences.OperationId:copyExclusivePreferences
", "operationId": "copyExclusivePreferences", "parameters": [ { "name": "exclusivePreferencesCopy", "in": "body", "required": true, "description": "Request object for copying template Exclusive preferences to hotel(s).", "schema": { "allOf": [ { "$ref": "#/definitions/exclusivePreferencesCopy" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/fiscalAgentTypes": { "get": { "summary": "Get Travel Agent Types", "description": "Use this API to get Travel Agent Types.OperationId:getTravelAgentTypes
", "operationId": "getTravelAgentTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Travel Agent Types.", "schema": { "$ref": "#/definitions/travelAgentTypesDetails" } }, "204": { "description": "TravelAgentTypes 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 Travel Agent Types", "description": "Use this API to create Travel Agent Types.OperationId:postTravelAgentTypes
", "operationId": "postTravelAgentTypes", "parameters": [ { "name": "travelAgentTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Travel Agent Types.", "schema": { "allOf": [ { "$ref": "#/definitions/travelAgentTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/fiscalAgentTypes/{fiscalAgentTypeCode}": { "put": { "summary": "Change Travel Agent Types", "description": "Use this API to update Travel Agent Types.OperationId:changeTravelAgentTypes
", "operationId": "changeTravelAgentTypes", "parameters": [ { "name": "fiscalAgentTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Travel Agent Types." }, { "name": "travelAgentTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Travel Agent Types.", "schema": { "allOf": [ { "$ref": "#/definitions/travelAgentTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Travel Agent Types", "description": "Use this API to delete Travel Agent Types.OperationId:removeTravelAgentTypes
", "operationId": "removeTravelAgentTypes", "parameters": [ { "name": "fiscalAgentTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Travel Agent Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/genderTypes": { "get": { "summary": "Get Gender Types", "description": "Use this API to get Gender Types.OperationId:getGenderTypes
", "operationId": "getGenderTypes", "parameters": [ { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "code", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Gender Types.", "schema": { "$ref": "#/definitions/genderTypes" } }, "204": { "description": "GenderTypes 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 Gender Types", "description": "Use this API to create Gender Types.OperationId:postGenderTypes
", "operationId": "postGenderTypes", "parameters": [ { "name": "genderTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Gender Types.", "schema": { "allOf": [ { "$ref": "#/definitions/genderTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/genderTypes/{genderTypeId}": { "put": { "summary": "Change Gender Types", "description": "Use this API to update Gender Type.OperationId:putGenderTypes
", "operationId": "putGenderTypes", "parameters": [ { "name": "genderTypeId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Identification code of Gender Type." }, { "name": "genderTypesToChange", "in": "body", "required": true, "description": "Request object for changing Gender Types.", "schema": { "allOf": [ { "$ref": "#/definitions/genderTypesToChange" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/genderTypesToChange" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$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 Gender Types", "description": "Use this API to delete Gender Types.OperationId:deleteGenderTypes
", "operationId": "deleteGenderTypes", "parameters": [ { "name": "genderTypeId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Identification code of Gender Types." }, { "name": "code", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/guestStatuses": { "get": { "summary": "Get Guest Statuses", "description": "Use this API to get Guest Statuses.OperationId:getGuestStatuses
", "operationId": "getGuestStatuses", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Guest Statuses.", "schema": { "$ref": "#/definitions/guestStatusesDetails" } }, "204": { "description": "GuestStatuses 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 Guest Statuses", "description": "Use this API to create Guest Statuses.OperationId:postGuestStatuses
", "operationId": "postGuestStatuses", "parameters": [ { "name": "guestStatusesCriteria", "in": "body", "required": true, "description": "Request object for creating Guest Statuses.", "schema": { "allOf": [ { "$ref": "#/definitions/guestStatusesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/guestStatuses/{guestStatusCode}": { "put": { "summary": "Change Guest Statuses", "description": "Use this API to update Guest Statuses.OperationId:changeGuestStatuses
", "operationId": "changeGuestStatuses", "parameters": [ { "name": "guestStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guest Statuses." }, { "name": "guestStatusesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Guest Statuses.", "schema": { "allOf": [ { "$ref": "#/definitions/guestStatusesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Guest Statuses", "description": "Use this API to delete Guest Statuses.OperationId:removeGuestStatuses
", "operationId": "removeGuestStatuses", "parameters": [ { "name": "guestStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guest Statuses." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "titleCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description of the Guest Title.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Guest Titles.", "schema": { "$ref": "#/definitions/guestTitlesDetails" } }, "204": { "description": "GuestTitles 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 Guest Titles", "description": "Use this API to create Guest Titles.OperationId:postGuestTitles
", "operationId": "postGuestTitles", "parameters": [ { "name": "guestTitlesCriteria", "in": "body", "required": true, "description": "Request object for creating Guest Titles.", "schema": { "allOf": [ { "$ref": "#/definitions/guestTitlesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/guestTitles/{guestTitlesCode}": { "put": { "summary": "Change Guest Titles", "description": "Use this API to update Guest Titles.OperationId:putGuestTitles
", "operationId": "putGuestTitles", "parameters": [ { "name": "guestTitlesCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guest Titles." }, { "name": "guestTitlesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Guest Titles.", "schema": { "allOf": [ { "$ref": "#/definitions/guestTitlesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Guest Titles", "description": "Use this API to delete Guest Titles.OperationId:deleteGuestTitles
", "operationId": "deleteGuestTitles", "parameters": [ { "name": "guestTitlesCode", "in": "path", "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" }, "required": false }, { "name": "titleType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Title Type for advanced title configuration.", "items": { "type": "integer" }, "required": false }, { "name": "description", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Description of the Guest Title.", "items": { "type": "string" }, "required": false }, { "name": "greeting", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Business Title for advanced title configuration.", "items": { "type": "string" }, "required": false }, { "name": "displayOrder", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Guest Title record sequence number.", "items": { "type": "number" }, "required": false }, { "name": "newTitleType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Description of the Guest Title.", "items": { "type": "integer" }, "required": false }, { "name": "newLanguageCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Description of the Guest Title.", "items": { "type": "string" }, "required": false }, { "name": "code", "in": "query", "required": false, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guest Titles." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/guestTypes": { "get": { "summary": "Get Guest Types", "description": "Use this API to get Guest Types.OperationId:getGuestTypes
", "operationId": "getGuestTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Guest Types.", "schema": { "$ref": "#/definitions/guestTypesDetails" } }, "204": { "description": "GuestTypes 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 Guest Types", "description": "Use this API to create Guest Types.OperationId:postGuestTypes
", "operationId": "postGuestTypes", "parameters": [ { "name": "guestTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Guest Types.", "schema": { "allOf": [ { "$ref": "#/definitions/guestTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/guestTypes/{guestTypeCode}": { "put": { "summary": "Change Guest Types", "description": "Use this API to update Guest Types.OperationId:changeGuestTypes
", "operationId": "changeGuestTypes", "parameters": [ { "name": "guestTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guest Types." }, { "name": "guestTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Guest Types.", "schema": { "allOf": [ { "$ref": "#/definitions/guestTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Guest Types", "description": "Use this API to delete Guest Types.OperationId:removeGuestTypes
", "operationId": "removeGuestTypes", "parameters": [ { "name": "guestTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Guest Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/hotels/{hotelId}/eCertificateLocationTypes": { "get": { "summary": "Get Ecertificate Location Types", "description": "Use this API to get Ecertificate Location Types.OperationId:getEcertificateLocationTypes
", "operationId": "getEcertificateLocationTypes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Ecertificate Location Types.", "schema": { "$ref": "#/definitions/ecertificateLocationTypesDetails" } }, "204": { "description": "EcertificateLocationTypes 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 Ecertificate Location Types", "description": "Use this API to create Ecertificate Location Types.OperationId:postEcertificateLocationTypes
", "operationId": "postEcertificateLocationTypes", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "ecertificateLocationTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Ecertificate Location Types.", "schema": { "allOf": [ { "$ref": "#/definitions/ecertificateLocationTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/hotels/{hotelId}/eCertificateLocationTypes/{locationId}": { "put": { "summary": "Change Ecertificate Location Types", "description": "Use this API to update Ecertificate Location Types.OperationId:changeEcertificateLocationTypes
", "operationId": "changeEcertificateLocationTypes", "deprecated": true, "parameters": [ { "name": "locationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of location." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "ecertificateLocationTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Ecertificate Location Types.", "schema": { "allOf": [ { "$ref": "#/definitions/ecertificateLocationTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Ecertificate Location Types", "description": "Use this API to delete Ecertificate Location Types.OperationId:removeEcertificateLocationTypes
", "operationId": "removeEcertificateLocationTypes", "deprecated": true, "parameters": [ { "name": "locationId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of location." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "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": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "exclusivePreferenceCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "preferenceGroupsCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "preferenceCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Exclusive preferences at the property level.", "schema": { "$ref": "#/definitions/exclusivePreferences" } }, "204": { "description": "ExclusivePreferences 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change Exclusive Preferences", "description": "You can use this API to change Exclusive Preferences at hotel Level.OperationId:putExclusivePreferences
", "operationId": "putExclusivePreferences", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "exclusivePreferences", "in": "body", "required": true, "description": "Request object for changing Exclusive preferences at the property level.", "schema": { "allOf": [ { "$ref": "#/definitions/exclusivePreferences" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete Exclusive Preferences", "description": "You can use this API to delete Exclusive Preferences at hotel Level.OperationId:deleteExclusivePreferences
", "operationId": "deleteExclusivePreferences", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "exclusivePreferenceCode", "in": "query", "required": true, "description": "Specifies the Exclusive preference code.", "type": "string" }, { "name": "exclusivePreferenceGroup", "in": "query", "required": true, "description": "Specifies the preference group the Exclusive preference belongs to.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create Exclusive Preferences", "description": "You can use this API to create Exclusive Preferences at hotel Level.OperationId:postExclusivePreferences
", "operationId": "postExclusivePreferences", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "exclusivePreferences", "in": "body", "required": true, "description": "Request object for creating Exclusive preferences at the property level.", "schema": { "allOf": [ { "$ref": "#/definitions/exclusivePreferences" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/hotels/{hotelId}/preferences": { "get": { "summary": "Get preferences", "description": "Use this API to get all configured preferences.OperationId:getPreferences
", "operationId": "getPreferences", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "preferenceCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "preferenceGroupsCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "createdByUserIds", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "integer", "maxItems": 4000 }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching preferences at the property level.", "schema": { "$ref": "#/definitions/hotelPreferences" } }, "204": { "description": "Preferences 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change preferences", "description": "Use this API to update and change existing preferences.OperationId:putPreferences
", "operationId": "putPreferences", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "hotelPreferences", "in": "body", "required": true, "description": "Request object for changing preferences at the property level.", "schema": { "allOf": [ { "$ref": "#/definitions/hotelPreferences" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete preferences", "description": "Use this API to delete preferences.OperationId:deletePreferences
", "operationId": "deletePreferences", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "preferenceCode", "in": "query", "required": true, "description": "Specifies the preference code.", "type": "string" }, { "name": "preferenceGroup", "in": "query", "required": true, "description": "Specifies the preference group the preference belongs to.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create preferences", "description": "This will allow you to create new preferences.OperationId:postPreferences
", "operationId": "postPreferences", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "hotelPreferences", "in": "body", "required": true, "description": "Request object for creating preferences at the property level.", "schema": { "allOf": [ { "$ref": "#/definitions/hotelPreferences" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/identificationCountries": { "get": { "summary": "Get Identification Countries", "description": "Use this API to get Identification Countries.OperationId:getIdentificationCountries
", "operationId": "getIdentificationCountries", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Identification Countries.", "schema": { "$ref": "#/definitions/identificationCountriesDetails" } }, "204": { "description": "IdentificationCountries 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 Identification Countries", "description": "Use this API to create Identification Countries.OperationId:postIdentificationCountries
", "operationId": "postIdentificationCountries", "parameters": [ { "name": "identificationCountriesCriteria", "in": "body", "required": true, "description": "Request object for creating Identification Countries.", "schema": { "allOf": [ { "$ref": "#/definitions/identificationCountriesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/identificationCountries/{identificationCountriesId}": { "put": { "summary": "Change Identification Countries", "description": "Use this API to update Identification Countries.OperationId:putIdentificationCountries
", "operationId": "putIdentificationCountries", "parameters": [ { "name": "identificationCountriesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Identification Countries." }, { "name": "identificationCountriesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Identification Countries.", "schema": { "allOf": [ { "$ref": "#/definitions/identificationCountriesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Identification Countries", "description": "Use this API to delete Identification Countries.OperationId:deleteIdentificationCountries
", "operationId": "deleteIdentificationCountries", "parameters": [ { "name": "identificationCountriesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Identification Countries." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/identificationTypes": { "get": { "summary": "Get Identification Types", "description": "Use this API to get Identification Types.OperationId:getIdentificationTypes
", "operationId": "getIdentificationTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Identification Types.", "schema": { "$ref": "#/definitions/identificationTypesDetails" } }, "204": { "description": "IdentificationTypes 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 Identification Types", "description": "Use this API to create Identification Types.OperationId:postIdentificationTypes
", "operationId": "postIdentificationTypes", "parameters": [ { "name": "identificationTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Identification Types.", "schema": { "allOf": [ { "$ref": "#/definitions/identificationTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/identificationTypes/{identificationTypesId}": { "put": { "summary": "Change Identification Types", "description": "Use this API to update Identification Types.OperationId:putIdentificationTypes
", "operationId": "putIdentificationTypes", "parameters": [ { "name": "identificationTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Identification Types." }, { "name": "identificationTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Identification Types.", "schema": { "allOf": [ { "$ref": "#/definitions/identificationTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Identification Types", "description": "Use this API to delete Identification Types.OperationId:deleteIdentificationTypes
", "operationId": "deleteIdentificationTypes", "parameters": [ { "name": "identificationTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Identification Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/immigrationStatuses": { "get": { "summary": "Get Immigration Statuses", "description": "Use this API to get Immigration Statuses.OperationId:getImmigrationStatuses
", "operationId": "getImmigrationStatuses", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Immigration Statuses.", "schema": { "$ref": "#/definitions/immigrationStatusesDetails" } }, "204": { "description": "ImmigrationStatuses 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 Immigration Statuses", "description": "Use this API to create Immigration Statuses.OperationId:postImmigrationStatuses
", "operationId": "postImmigrationStatuses", "parameters": [ { "name": "immigrationStatusesCriteria", "in": "body", "required": true, "description": "Request object for creating Immigration Statuses.", "schema": { "allOf": [ { "$ref": "#/definitions/immigrationStatusesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/immigrationStatuses/{immigrationStatusCode}": { "put": { "summary": "Change Immigration Statuses", "description": "Use this API to update Immigration Statuses.OperationId:changeImmigrationStatuses
", "operationId": "changeImmigrationStatuses", "parameters": [ { "name": "immigrationStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Immigration Statuses." }, { "name": "immigrationStatusesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Immigration Statuses.", "schema": { "allOf": [ { "$ref": "#/definitions/immigrationStatusesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Immigration Statuses", "description": "Use this API to delete Immigration Statuses.OperationId:removeImmigrationStatuses
", "operationId": "removeImmigrationStatuses", "parameters": [ { "name": "immigrationStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Immigration Statuses." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/industryCodes": { "get": { "summary": "Get Industry Codes", "description": "Use this API to get Industry Codes.OperationId:getIndustryCodes
", "operationId": "getIndustryCodes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Industry Codes.", "schema": { "$ref": "#/definitions/industryCodesDetails" } }, "204": { "description": "IndustryCodes 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 Industry Codes", "description": "Use this API to create Industry Codes.OperationId:postIndustryCodes
", "operationId": "postIndustryCodes", "parameters": [ { "name": "industryCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Industry Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/industryCodesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/industryCodes/{industryCodesId}": { "put": { "summary": "Change Industry Codes", "description": "Use this API to update Industry Codes.OperationId:putIndustryCodes
", "operationId": "putIndustryCodes", "parameters": [ { "name": "industryCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Industry Codes." }, { "name": "industryCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Industry Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/industryCodesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Industry Codes", "description": "Use this API to delete Industry Codes.OperationId:deleteIndustryCodes
", "operationId": "deleteIndustryCodes", "parameters": [ { "name": "industryCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Industry Codes." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/influenceCodes": { "get": { "summary": "Get Influence Codes", "description": "Use this API to get Influence Codes.OperationId:getInfluenceCodes
", "operationId": "getInfluenceCodes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Influence Codes.", "schema": { "$ref": "#/definitions/influenceCodesDetails" } }, "204": { "description": "InfluenceCodes 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 Influence Codes", "description": "Use this API to create Influence Codes.OperationId:postInfluenceCodes
", "operationId": "postInfluenceCodes", "parameters": [ { "name": "influenceCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Influence Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/influenceCodesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/influenceCodes/{influenceCodesId}": { "put": { "summary": "Change Influence Codes", "description": "Use this API to update Influence Codes.OperationId:putInfluenceCodes
", "operationId": "putInfluenceCodes", "parameters": [ { "name": "influenceCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Influence Codes." }, { "name": "influenceCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Influence Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/influenceCodesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Influence Codes", "description": "Use this API to delete Influence Codes.OperationId:deleteInfluenceCodes
", "operationId": "deleteInfluenceCodes", "parameters": [ { "name": "influenceCodesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Influence Codes." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/keywordTypes": { "get": { "summary": "Get Keyword Types", "description": "Use this API to get Keyword Types.OperationId:getKeywordTypes
", "operationId": "getKeywordTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Keyword Types.", "schema": { "$ref": "#/definitions/keywordTypesDetails" } }, "204": { "description": "KeywordTypes 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 Keyword Types", "description": "Use this API to create Keyword Types.OperationId:postKeywordTypes
", "operationId": "postKeywordTypes", "parameters": [ { "name": "keywordTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Keyword Types.", "schema": { "allOf": [ { "$ref": "#/definitions/keywordTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/keywordTypes/{keywordTypesId}": { "put": { "summary": "Change Keyword Types", "description": "Use this API to update Keyword Types.OperationId:putKeywordTypes
", "operationId": "putKeywordTypes", "parameters": [ { "name": "keywordTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Keyword Types." }, { "name": "keywordTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Keyword Types.", "schema": { "allOf": [ { "$ref": "#/definitions/keywordTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Keyword Types", "description": "Use this API to delete Keyword Types.OperationId:deleteKeywordTypes
", "operationId": "deleteKeywordTypes", "parameters": [ { "name": "keywordTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Keyword Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/mailingActionCodes": { "get": { "summary": "Get Mailing Action Codes", "description": "Use this API to get Mailing Action Codes.OperationId:getMailingActionCodes
", "operationId": "getMailingActionCodes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Mailing Action Codes.", "schema": { "$ref": "#/definitions/mailingActionCodesDetails" } }, "204": { "description": "MailingActionCodes 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 Mailing Action Codes", "description": "Use this API to create Mailing Action Codes.OperationId:postMailingActionCodes
", "operationId": "postMailingActionCodes", "parameters": [ { "name": "mailingActionCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Mailing Action Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/mailingActionCodesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/mailingActionCodes/{mailingActionCode}": { "put": { "summary": "Change Mailing Action Codes", "description": "Use this API to update Mailing Action Codes.OperationId:changeMailingActionCodes
", "operationId": "changeMailingActionCodes", "parameters": [ { "name": "mailingActionCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Mailing Action." }, { "name": "mailingActionCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Mailing Action Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/mailingActionCodesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Mailing Action Codes", "description": "Use this API to delete Mailing Action Codes.OperationId:removeMailingActionCodes
", "operationId": "removeMailingActionCodes", "parameters": [ { "name": "mailingActionCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Mailing Action." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipAwards": { "get": { "summary": "Get Membership Awards", "description": "You can use this API to get Membership Awards.OperationId:getMembershipAwards
The maximum allowable limit for this API is 200.
", "operationId": "getMembershipAwards", "parameters": [ { "name": "membershipType", "in": "query", "required": false, "description": "Membership type for which awards are defined.", "type": "string" }, { "name": "awardCodes", "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 for the membership award.", "type": "string" }, { "name": "validForDate", "in": "query", "required": false, "description": "Date when membership award is valid.", "type": "string", "format": "date" }, { "name": "includeInactive", "in": "query", "required": false, "description": "Flag to decide whether or not to include inactive records in search result set.", "type": "boolean" }, { "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" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response to fetch Membership Awards.", "schema": { "$ref": "#/definitions/membershipAwardsInfo" } }, "204": { "description": "MembershipAwards 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership Awards", "description": "You can use this API to create Membership Awards.OperationId:postMembershipAwards
", "operationId": "postMembershipAwards", "parameters": [ { "name": "membershipAwards", "in": "body", "required": true, "description": "Request object for creating new membership awards.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipAwards" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipAwards/{membershipAwardsId}": { "put": { "summary": "Change Membership Awards", "description": "You can use this API to change Membership Awards.OperationId:putMembershipAwards
", "operationId": "putMembershipAwards", "parameters": [ { "name": "membershipAwardsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipAwards", "in": "body", "required": true, "description": "Request object for modifying membership awards.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipAwards" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership Awards", "description": "You can use this API to delete Membership Awards.OperationId:deleteMembershipAwards
", "operationId": "deleteMembershipAwards", "parameters": [ { "name": "membershipAwardsId", "in": "path", "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" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipAwards/{membershipAwardsId}" : { "put" : { "summary" : "Create/Change Membership Awards", "description" : "You can use this API to create/change Membership Awards.OperationId:putUpsertMembershipAwards
", "operationId" : "putUpsertMembershipAwards", "parameters" : [ { "name" : "membershipAwardsId", "in" : "path", "required" : true, "type" : "string", "minLength" : 1, "maxLength" : 2000, "description" : "Fetch membershipClasses values based on given membershipClassId" }, { "name" : "membershipAwards", "in" : "body", "required" : true, "description" : "Request object for modifying membership awards.", "schema" : { "allOf" : [ { "$ref" : "#/definitions/membershipAwards" } ] } }, { "$ref" : "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref" : "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref" : "#/parameters/x-hotelid" }, { "$ref" : "#/parameters/x-externalsystem" }, { "$ref" : "#/parameters/Accept-Language" } ], "responses" : { "200" : { "headers" : { "Content-Language" : { "type" : "string", "description" : "Audience language", "pattern" : "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example" : "en-GB" }, "Location" : { "type" : "string", "description" : "Location of newly created resource" } }, "description" : "Response Body.", "schema" : { "$ref" : "#/definitions/status" } } }, "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "tags" : [ "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
This API allows a time span of 90 days.
", "operationId": "getMembershipBenefitPrograms", "parameters": [ { "name": "membershipType", "in": "query", "required": false, "description": "Membership type", "type": "string" }, { "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", "format": "date" }, { "name": "start", "in": "query", "required": false, "description": "The starting value of the date range.", "type": "string", "format": "date" }, { "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" }, { "name": "includeInactive", "in": "query", "required": false, "description": "Flag to decide whether or not to include inactive records in search result set.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching membership benefit programs.", "schema": { "$ref": "#/definitions/membershipBenefitProgramsInfo" } }, "204": { "description": "MembershipBenefitPrograms 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": [ "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": [ { "name": "membershipBenefitPrograms", "in": "body", "required": true, "description": "Request object for creating new membership benefit programs.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipBenefitPrograms" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "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": [ { "name": "membershipBenefitProgramsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipBenefitPrograms", "in": "body", "required": true, "description": "Request object for modifying membership benefit programs.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipBenefitPrograms" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "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": [ { "name": "membershipBenefitProgramsId", "in": "path", "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", "items": { "type": "string" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipBenefitPrograms/{membershipBenefitProgramsId}" : { "put" : { "summary" : "Create/Change Membership Benefit Program", "description" : "This API allows you to create/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:putUpsertMembershipBenefitPrograms
", "operationId" : "putUpsertMembershipBenefitPrograms", "parameters" : [ { "name" : "membershipBenefitProgramsId", "in" : "path", "required" : true, "type" : "string", "minLength" : 1, "maxLength" : 2000, "description" : "Fetch membershipClasses values based on given membershipClassId" }, { "name" : "membershipBenefitPrograms", "in" : "body", "required" : true, "description" : "Request object for modifying membership benefit programs.", "schema" : { "allOf" : [ { "$ref" : "#/definitions/membershipBenefitPrograms" } ] } }, { "$ref" : "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref" : "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref" : "#/parameters/x-hotelid" }, { "$ref" : "#/parameters/x-externalsystem" }, { "$ref" : "#/parameters/Accept-Language" } ], "responses" : { "200" : { "headers" : { "Content-Language" : { "type" : "string", "description" : "Audience language", "pattern" : "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example" : "en-GB" }, "Location" : { "type" : "string", "description" : "Location of newly created resource" } }, "description" : "Response Body.", "schema" : { "$ref" : "#/definitions/status" } } }, "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "tags" : [ "MembershipConfig" ] } }, "/membershipClaimOrigins": { "get": { "summary": "Get Membership Claim Origins", "description": "Use this API to get Membership Claim Origins.OperationId:getMembershipClaimOrigins
", "operationId": "getMembershipClaimOrigins", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Claim Origins.", "schema": { "$ref": "#/definitions/membershipClaimOriginsDetails" } }, "204": { "description": "MembershipClaimOrigins 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 Membership Claim Origins", "description": "Use this API to create Membership Claim Origins.OperationId:postMembershipClaimOrigins
", "operationId": "postMembershipClaimOrigins", "parameters": [ { "name": "membershipClaimOriginsCriteria", "in": "body", "required": true, "description": "Request object for creating Membership Claim Origins.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipClaimOriginsCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipClaimOrigins/{membershipClaimOriginCode}": { "put": { "summary": "Change Membership Claim Origins", "description": "Use this API to update Membership Claim Origins.OperationId:changeMembershipClaimOrigins
", "operationId": "changeMembershipClaimOrigins", "parameters": [ { "name": "membershipClaimOriginCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Membership Claim Origins." }, { "name": "membershipClaimOriginsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Membership Claim Origins.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipClaimOriginsToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Membership Claim Origins", "description": "Use this API to delete Membership Claim Origins.OperationId:removeMembershipClaimOrigins
", "operationId": "removeMembershipClaimOrigins", "parameters": [ { "name": "membershipClaimOriginCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Membership Claim Origins." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipClaimTypes": { "get": { "summary": "Get Membership Claim Types", "description": "Use this API to get Membership Claim Types.OperationId:getMembershipClaimTypes
", "operationId": "getMembershipClaimTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Claim Types.", "schema": { "$ref": "#/definitions/membershipClaimTypesDetails" } }, "204": { "description": "MembershipClaimTypes 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 Membership Claim Types", "description": "Use this API to create Membership Claim Types.OperationId:postMembershipClaimTypes
", "operationId": "postMembershipClaimTypes", "parameters": [ { "name": "membershipClaimTypesCriteria", "in": "body", "required": true, "description": "Request object for creating Membership Claim Types.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipClaimTypesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipClaimTypes/{membershipClaimTypeCode}": { "put": { "summary": "Change Membership Claim Types", "description": "Use this API to update Membership Claim Types.OperationId:changeMembershipClaimTypes
", "operationId": "changeMembershipClaimTypes", "parameters": [ { "name": "membershipClaimTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Membership Claim Types." }, { "name": "membershipClaimTypesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Membership Claim Types.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipClaimTypesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Membership Claim Types", "description": "Use this API to delete Membership Claim Types.OperationId:removeMembershipClaimTypes
", "operationId": "removeMembershipClaimTypes", "parameters": [ { "name": "membershipClaimTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Membership Claim Types." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipClasses": { "get": { "summary": "Get Membership classes", "description": "Retrieve a list of membership classes that are configured.OperationId:getMembershipClasses
", "operationId": "getMembershipClasses", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Class.", "schema": { "$ref": "#/definitions/membershipClassesInfo" } }, "204": { "description": "MembershipClasses 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership classes", "description": "Create a new membership class.OperationId:postMembershipClasses
", "operationId": "postMembershipClasses", "parameters": [ { "name": "membershipClasses", "in": "body", "required": true, "description": "Request object for creating Membership Class", "schema": { "allOf": [ { "$ref": "#/definitions/membershipClasses" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipClasses/{membershipClassId}": { "put": { "summary": "Change Membership classes", "description": "Update an existing membership classOperationId:putMembershipClasses
", "operationId": "putMembershipClasses", "parameters": [ { "name": "membershipClassId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipClasses", "in": "body", "required": true, "description": "Request object for changing Membership Class.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipClasses" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response object for changing Membership Class.", "schema": { "$ref": "#/definitions/membershipClassesInfo" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership classes", "description": "Delete an existing membership class.OperationId:deleteMembershipClasses
", "operationId": "deleteMembershipClasses", "parameters": [ { "name": "membershipClassId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipEnrollmentCodes": { "get": { "summary": "Get Membership Enrollment Codes", "description": "Use this API to get Membership Enrollment Codes.OperationId:getMembershipEnrollmentCodes
", "operationId": "getMembershipEnrollmentCodes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Enrollment Codes.", "schema": { "$ref": "#/definitions/membershipEnrollmentCodesDetails" } }, "204": { "description": "MembershipEnrollmentCodes 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 Membership Enrollment Codes", "description": "Use this API to create Membership Enrollment Codes.OperationId:postMembershipEnrollmentCodes
", "operationId": "postMembershipEnrollmentCodes", "parameters": [ { "name": "membershipEnrollmentCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Membership Enrollment Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipEnrollmentCodesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipEnrollmentCodes/{enrollmentCode}": { "put": { "summary": "Change Membership Enrollment Codes", "description": "Use this API to update Membership Enrollment Codes.OperationId:changeMembershipEnrollmentCodes
", "operationId": "changeMembershipEnrollmentCodes", "parameters": [ { "name": "enrollmentCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Enrollment." }, { "name": "membershipEnrollmentCodesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Membership Enrollment Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipEnrollmentCodesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Membership Enrollment Codes", "description": "Use this API to delete Membership Enrollment Codes.OperationId:removeMembershipEnrollmentCodes
", "operationId": "removeMembershipEnrollmentCodes", "parameters": [ { "name": "enrollmentCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Enrollment." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipEnrollmentGroups": { "get": { "summary": "Get Membership enrollment groups", "description": "Retrieve a list of membership Enrollment Groups that are configured.OperationId:getMembershipEnrollmentGroups
The maximum allowable limit for this API is 200.
", "operationId": "getMembershipEnrollmentGroups", "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": "enrollmentCodes", "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 enrollment group to be fetched.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching membership enrollment groups.", "schema": { "$ref": "#/definitions/membershipEnrollmentGroupsInfo" } }, "204": { "description": "MembershipEnrollmentGroups 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership enrollment groups", "description": "Create a new membership enrollment group.OperationId:postMembershipEnrollmentGroups
", "operationId": "postMembershipEnrollmentGroups", "parameters": [ { "name": "membershipEnrollmentGroups", "in": "body", "required": true, "description": "Request object for creating new membership enrollment groups.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipEnrollmentGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipEnrollmentGroups/{membershipEnrollmentGroupsId}": { "put": { "summary": "Change Membership enrollment groups", "description": "Update an existing membership group.OperationId:putMembershipEnrollmentGroups
", "operationId": "putMembershipEnrollmentGroups", "parameters": [ { "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/membershipEnrollmentGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Remove Membership enrollment groups", "description": "delete an existing membership group.OperationId:deleteMembershipEnrollmentGroups
", "operationId": "deleteMembershipEnrollmentGroups", "parameters": [ { "name": "membershipEnrollmentGroupsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipFolioTexts": { "post": { "summary": "Set Membership folio texts", "description": "You can use this API to Set Membership folio texts.OperationId:postMembershipFolioTexts
", "operationId": "postMembershipFolioTexts", "parameters": [ { "name": "membershipFolioTexts", "in": "body", "required": true, "description": "Collection of FolioTexts to be inserted at MembershipLevel.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipFolioTexts" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipLevelRules": { "get": { "summary": "Get Membership Level Rules", "description": "You can use this API to get Membership Level Rules.OperationId:getMembershipLevelRules
", "operationId": "getMembershipLevelRules", "parameters": [ { "name": "membershipType", "in": "query", "required": false, "description": "Membership Type.", "type": "string" }, { "name": "membershipLevel", "in": "query", "required": false, "description": "Membership Level.", "type": "string" }, { "name": "ruleNo", "in": "query", "required": false, "description": "Membership Level Rule Number.", "type": "number" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Level Rules.", "schema": { "$ref": "#/definitions/membershipLevelRulesInfo" } }, "204": { "description": "MembershipLevelRules 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership Level Rules", "description": "You can use this API to create Membership Level Rules.OperationId:postMembershipLevelRules
", "operationId": "postMembershipLevelRules", "parameters": [ { "name": "membershipLevelRules", "in": "body", "required": true, "description": "Request object for creating new Membership Level Rules.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipLevelRules" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipLevelRules/{membershipLevelRulesID}": { "put": { "summary": "Change Membership Level Rules", "description": "You can use this API to change Membership Level Rules.OperationId:putMembershipLevelRules
", "operationId": "putMembershipLevelRules", "parameters": [ { "name": "membershipLevelRulesID", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipLevelRules", "in": "body", "required": true, "description": "Request object for modifying Membership Level Rules.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipLevelRules" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipLevels": { "get": { "summary": "Get Membership levels", "description": "You can use this API to get Membership levels.OperationId:getMembershipLevels
", "operationId": "getMembershipLevels", "parameters": [ { "name": "membershipTypeCode", "in": "query", "required": true, "description": "Type of membership that the levels belong to.", "type": "string" }, { "name": "includeInactive", "in": "query", "default": "false", "required": false, "description": "Inactive flag - whether or not to display inactive records.", "type": "boolean" }, { "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" }, { "name": "hotelIds", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching membership levels.", "schema": { "$ref": "#/definitions/membershipLevelsInfo" } }, "204": { "description": "MembershipLevels 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership levels", "description": "You can use this API to create Membership levels.OperationId:postMembershipLevels
", "operationId": "postMembershipLevels", "parameters": [ { "name": "membershipLevels", "in": "body", "required": true, "description": "Request object for creating new membership levels.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipLevels" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipLevels/{membershipLevelsId}": { "put": { "summary": "Change Membership levels", "description": "You can use this API to change Membership levels.OperationId:putMembershipLevels
", "operationId": "putMembershipLevels", "parameters": [ { "name": "membershipLevelsId", "in": "path", "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/membershipLevels" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership levels", "description": "You can use this API to delete Membership levels.OperationId:deleteMembershipLevels
", "operationId": "deleteMembershipLevels", "parameters": [ { "name": "membershipLevelsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "type", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Membership type", "items": { "type": "string" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipLevels/{membershipLevelsId}" : { "put" : { "summary" : "Create/Change Membership levels", "description" : "You can use this API to create/change Membership levels.OperationId:putUpsertMembershipLevels
", "operationId" : "putUpsertMembershipLevels", "parameters" : [ { "name" : "membershipLevelsId", "in" : "path", "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/membershipLevels" } ] } }, { "$ref" : "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref" : "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref" : "#/parameters/x-hotelid" }, { "$ref" : "#/parameters/x-externalsystem" }, { "$ref" : "#/parameters/Accept-Language" } ], "responses" : { "200" : { "headers" : { "Content-Language" : { "type" : "string", "description" : "Audience language", "pattern" : "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example" : "en-GB" }, "Location" : { "type" : "string", "description" : "Location of newly created resource" } }, "description" : "Response Body.", "schema" : { "$ref" : "#/definitions/status" } } }, "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "tags" : [ "MembershipConfig" ] } }, "/membershipMarketGroups": { "get": { "summary": "Get Membership market groups", "description": "You can use this API to get Membership market groups.OperationId:getMembershipMarketGroups
", "operationId": "getMembershipMarketGroups", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Market Groups configurations.", "schema": { "$ref": "#/definitions/membershipMarketGroupsInfo" } }, "204": { "description": "MembershipMarketGroups 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership market groups", "description": "You can use this API to create Membership market groups.OperationId:postMembershipMarketGroups
", "operationId": "postMembershipMarketGroups", "parameters": [ { "name": "membershipMarketGroups", "in": "body", "required": true, "description": "Request object for creating new Membership Market Group Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipMarketGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipMarketGroups/{membershipMarketGroupId}": { "put": { "summary": "Change Membership market groups", "description": "You can use this API to change Membership market groups.OperationId:putMembershipMarketGroups
", "operationId": "putMembershipMarketGroups", "parameters": [ { "name": "membershipMarketGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipMarketGroups", "in": "body", "required": true, "description": "Request object for changing existing Membership Market Groups Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipMarketGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership market groups", "description": "You can use this API to delete Membership market groups.OperationId:deleteMembershipMarketGroups
", "operationId": "deleteMembershipMarketGroups", "parameters": [ { "name": "membershipMarketGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipMarketGroups/{membershipMarketGroupId}" : { "put" : { "summary" : "Create/Change Membership market groups", "description" : "You can use this API to create/change Membership market groups.OperationId:putUpsertMembershipMarketGroups
", "operationId" : "putUpsertMembershipMarketGroups", "parameters" : [ { "name" : "membershipMarketGroupId", "in" : "path", "required" : true, "type" : "string", "minLength" : 1, "maxLength" : 2000, "description" : "Fetch membershipClasses values based on given membershipClassId" }, { "name" : "membershipMarketGroups", "in" : "body", "required" : true, "description" : "Request object for changing existing Membership Market Groups Configurations.", "schema" : { "allOf" : [ { "$ref" : "#/definitions/membershipMarketGroups" } ] } }, { "$ref" : "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref" : "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref" : "#/parameters/x-hotelid" }, { "$ref" : "#/parameters/x-externalsystem" }, { "$ref" : "#/parameters/Accept-Language" } ], "responses" : { "200" : { "headers" : { "Content-Language" : { "type" : "string", "description" : "Audience language", "pattern" : "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example" : "en-GB" }, "Location" : { "type" : "string", "description" : "Location of newly created resource" } }, "description" : "Response Body.", "schema" : { "$ref" : "#/definitions/status" } } }, "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "tags" : [ "MembershipConfig" ] } }, "/membershipOriginGroups": { "get": { "summary": "Get Membership origin groups", "description": "You can use this API to get Membership origin groups.OperationId:getMembershipOriginGroups
", "operationId": "getMembershipOriginGroups", "parameters": [ { "name": "codes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Origin Groups configurations.", "schema": { "$ref": "#/definitions/membershipOriginGroupsDetails" } }, "204": { "description": "MembershipOriginGroups 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": [ "MembershipConfig" ] }, "post": { "summary": "Create a Membership origin group", "description": "You can use this API to create Membership origin group.OperationId:postMembershipOriginGroup
", "operationId": "postMembershipOriginGroup", "parameters": [ { "name": "membershipOriginGroup", "in": "body", "required": true, "description": "Request object for creating new Membership origin Group Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipOriginGroupDetails" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resource", "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": [ "MembershipConfig" ] } }, "/membershipOriginGroups/{membershipOriginGroupId}": { "put": { "summary": "Change Membership origin group", "description": "You can use this API to change Membership origin group.OperationId:putMembershipOriginGroup
", "operationId": "putMembershipOriginGroup", "parameters": [ { "name": "membershipOriginGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Membership origin group code which will be changed." }, { "name": "membershipOriginGroup", "in": "body", "required": true, "description": "Request object for changing existing Membership Origin Group Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipOriginGroupDetails" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership origin group", "description": "You can use this API to delete Membership origin group.OperationId:deleteMembershipOriginGroup
", "operationId": "deleteMembershipOriginGroup", "parameters": [ { "name": "membershipOriginGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Delete delete Membership Origin Group based on given membershipOriginGroupId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipPropertyGroups": { "get": { "summary": "Get Membership property groups", "description": "You can use this API to get Membership property groups.OperationId:getMembershipPropertyGroups
", "operationId": "getMembershipPropertyGroups", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Property Groups configurations.", "schema": { "$ref": "#/definitions/membershipPropertyGroupsInfo" } }, "204": { "description": "MembershipPropertyGroups 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership property groups", "description": "You can use this API to create Membership property groups.OperationId:postMembershipPropertyGroups
", "operationId": "postMembershipPropertyGroups", "parameters": [ { "name": "membershipPropertyGroups", "in": "body", "required": true, "description": "Request object for creating new Membership Property Groups Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipPropertyGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipPropertyGroups/{membershipPropertyGroupsId}": { "put": { "summary": "Change Membership property groups", "description": "You can use this API to change Membership property groups.OperationId:putMembershipPropertyGroups
", "operationId": "putMembershipPropertyGroups", "parameters": [ { "name": "membershipPropertyGroupsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipPropertyGroups", "in": "body", "required": true, "description": "Request object for changing existing Membership Property Groups Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipPropertyGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership property groups", "description": "You can use this API to delete Membership property groups.OperationId:deleteMembershipPropertyGroups
", "operationId": "deleteMembershipPropertyGroups", "parameters": [ { "name": "membershipPropertyGroupsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipRateGroups": { "get": { "summary": "Get Membership rate groups", "description": "You can use this API to get Membership rate groups.OperationId:getMembershipRateGroups
", "operationId": "getMembershipRateGroups", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Rate Groups.", "schema": { "$ref": "#/definitions/membershipRateGroupsInfo" } }, "204": { "description": "MembershipRateGroups 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership rate groups", "description": "You can use this API to create Membership rate groups.OperationId:postMembershipRateGroups
", "operationId": "postMembershipRateGroups", "parameters": [ { "name": "membershipRateGroups", "in": "body", "required": true, "description": "Request object for creating new Membership Rate Groups.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRateGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "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": [ { "name": "membershipRateGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRateGroups", "in": "body", "required": true, "description": "Request object for modifying Membership Rate Groups.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRateGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership rate groups", "description": "You can use this API to delete Membership rate groups.OperationId:deleteMembershipRateGroups
", "operationId": "deleteMembershipRateGroups", "parameters": [ { "name": "membershipRateGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/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": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "membershipTypes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Membership type to be searched.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "ratePlanCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Rate code of the membership rule rate.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description of the Membership Rate.", "type": "string" }, { "name": "includeInactive", "in": "query", "required": false, "description": "Indicates whether search includes inactive membership rates.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching membership rates.", "schema": { "$ref": "#/definitions/membershipRatesInfo" } }, "204": { "description": "MembershipRates 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership rates", "description": "You can use this API to create Membership rates.OperationId:postMembershipRates
", "operationId": "postMembershipRates", "parameters": [ { "name": "membershipRates", "in": "body", "required": true, "description": "Request object for creating new membership rate code rules.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRates" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipRates/{membershipRatesId}": { "put": { "summary": "Change Membership rates", "description": "You can use this API to change Membership rates.OperationId:putMembershipRates
", "operationId": "putMembershipRates", "parameters": [ { "name": "membershipRatesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRates", "in": "body", "required": true, "description": "Request object for changing membership rate rules.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRates" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership rates", "description": "You can use this API to delete Membership rates.OperationId:deleteMembershipRates
", "operationId": "deleteMembershipRates", "parameters": [ { "name": "membershipRatesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "hotelId", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Hotel code of membership rate.", "items": { "type": "string" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipRevenueTypes": { "get": { "summary": "Get Membership revenue types", "description": "You can use this API to get Membership revenue types.This API is deprecated.
OperationId:getMembershipRevenueTypes
", "operationId": "getMembershipRevenueTypes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching membership revenue types.", "schema": { "$ref": "#/definitions/membershipRevenueTypesInfo" } }, "204": { "description": "MembershipRevenueTypes 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership revenue types", "description": "You can use this API to create Membership revenue types.This API is deprecated.
OperationId:postMembershipRevenueTypes
", "operationId": "postMembershipRevenueTypes", "parameters": [ { "name": "membershipRevenueTypes", "in": "body", "required": true, "description": "Request object for creating new membership revenue types.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRevenueTypes" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipRevenueTypes/{membershipRevenueTypesId}": { "put": { "summary": "Change Membership revenue types", "description": "You can use this API to change Membership revenue types.This API is deprecated.
OperationId:putMembershipRevenueTypes
", "operationId": "putMembershipRevenueTypes", "parameters": [ { "name": "membershipRevenueTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRevenueTypes", "in": "body", "required": true, "description": "Request object for changing new membership revenue types.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRevenueTypes" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership revenue types", "description": "You can use this API to delete Membership revenue types.This API is deprecated.
OperationId:deleteMembershipRevenueTypes
", "operationId": "deleteMembershipRevenueTypes", "parameters": [ { "name": "membershipRevenueTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipRoomGroups": { "get": { "summary": "Get Membership room groups ", "description": "You can use this API to get Membership room groups.This API is deprecated.
OperationId:getMembershipRoomGroups
", "operationId": "getMembershipRoomGroups", "parameters": [ { "name": "roomGroupCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description of the room groups.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching membership room groups.", "schema": { "$ref": "#/definitions/membershipRoomGroupsInfo" } }, "204": { "description": "MembershipRoomGroups 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership room groups", "description": "You can use this API to create Membership room groups.This API is deprecated.
OperationId:postMembershipRoomGroups
", "operationId": "postMembershipRoomGroups", "parameters": [ { "name": "membershipRoomGroups", "in": "body", "required": true, "description": "Request object for creating new membership room groups.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRoomGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipRoomGroups/{membershipRoomGroupsId}": { "put": { "summary": "Change Membership room groups", "description": "You can use this API to change Membership room groups.This API is deprecated.
OperationId:putMembershipRoomGroups
", "operationId": "putMembershipRoomGroups", "parameters": [ { "name": "membershipRoomGroupsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRoomGroups", "in": "body", "required": true, "description": "Request object for changing membership room groups.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRoomGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership room groups", "description": "You can use this API to delete Membership room groups.This API is deprecated.
OperationId:deleteMembershipRoomGroups
", "operationId": "deleteMembershipRoomGroups", "parameters": [ { "name": "membershipRoomGroupsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipSourceGroups": { "get": { "summary": "Get Membership source groups", "description": "You can use this API to get Membership source groups.OperationId:getMembershipSourceGroups
", "operationId": "getMembershipSourceGroups", "parameters": [ { "name": "codes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Source Groups configurations.", "schema": { "$ref": "#/definitions/membershipSourceGroupsDetails" } }, "204": { "description": "MembershipSourceGroups 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": [ "MembershipConfig" ] }, "post": { "summary": "Create a Membership source group", "description": "You can use this API to create Membership source group.OperationId:postMembershipSourceGroup
", "operationId": "postMembershipSourceGroup", "parameters": [ { "name": "membershipSourceGroup", "in": "body", "required": true, "description": "Request object for creating new Membership source Group Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipSourceGroupDetails" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resource", "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": [ "MembershipConfig" ] } }, "/membershipSourceGroups/{membershipSourceGroupId}": { "put": { "summary": "Change Membership source group", "description": "You can use this API to change Membership source group.OperationId:putMembershipSourceGroup
", "operationId": "putMembershipSourceGroup", "parameters": [ { "name": "membershipSourceGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Membership source group code which will be changed." }, { "name": "membershipSourceGroup", "in": "body", "required": true, "description": "Request object for changing existing Membership Source Group Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipSourceGroupDetails" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership Source group", "description": "You can use this API to delete Membership Source group.OperationId:deleteMembershipSourceGroup
", "operationId": "deleteMembershipSourceGroup", "parameters": [ { "name": "membershipSourceGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Delete delete Membership Source Group based on given membershipSourceGroupId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipStatusCodes": { "get": { "summary": "Get Membership Status Codes", "description": "Use this API to get Membership Status Codes.OperationId:getMembershipStatusCodes
", "operationId": "getMembershipStatusCodes", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Status Codes.", "schema": { "$ref": "#/definitions/membershipStatusCodesDetails" } }, "204": { "description": "MembershipStatusCodes 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 Membership Status Codes", "description": "Use this API to create Membership Status Codes.OperationId:postMembershipStatusCodes
", "operationId": "postMembershipStatusCodes", "parameters": [ { "name": "membershipStatusCodesCriteria", "in": "body", "required": true, "description": "Request object for creating Membership Status Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipStatusCodesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipStatusCodes/{membershipStatusCode}": { "put": { "summary": "Change Membership Status Codes", "description": "Use this API to update Membership Status Codes.OperationId:changeMembershipStatusCodes
", "operationId": "changeMembershipStatusCodes", "parameters": [ { "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/membershipStatusCodesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Membership Status Codes", "description": "Use this API to delete Membership Status Codes.OperationId:removeMembershipStatusCodes
", "operationId": "removeMembershipStatusCodes", "parameters": [ { "name": "membershipStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Membership Status." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/membershipTypeRules": { "get": { "summary": "Get Membership type rules", "description": "get Membership type rules based on criteriaOperationId:getMembershipTypeRules
", "operationId": "getMembershipTypeRules", "parameters": [ { "name": "membershipTypesCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "programType", "in": "query", "required": false, "type": "string", "description": "Membership Type/Program rule types.", "uniqueItems": true, "enum": [ "All", "Points", "Tier" ] }, { "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": "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" ] }, { "name": "includeInactive", "in": "query", "required": false, "description": "Indicates whether search includes inactive membership type rules.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching membership type rules.", "schema": { "$ref": "#/definitions/membershipTypeRulesInfo" } }, "204": { "description": "MembershipTypeRules 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": [ "MembershipConfig" ] }, "post": { "summary": "Create Membership type rules", "description": "You can use this API to create Membership type rules.OperationId:postMembershipTypeRules
", "operationId": "postMembershipTypeRules", "parameters": [ { "name": "membershipTypeRules", "in": "body", "required": true, "description": "Request object for creating new membership type rules.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipTypeRules" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response object for creating membership type rules.", "schema": { "$ref": "#/definitions/membershipTypeRulesDetails" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "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": [ { "name": "membershipTypeRulesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipType", "in": "query", "required": false, "description": "Membership type of the Rule.", "type": "string" }, { "name": "membershipPointsSequence", "in": "query", "required": false, "description": "Sequence number of the membership type rule.", "type": "integer" }, { "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 }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching membership type rule.", "schema": { "$ref": "#/definitions/membershipTypeRule" } }, "204": { "description": "MembershipTypeRule 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": [ "MembershipConfig" ] }, "put": { "summary": "Change Membership type rules", "description": "You can use this API to change Membership type rules.OperationId:putMembershipTypeRules
", "operationId": "putMembershipTypeRules", "parameters": [ { "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/membershipTypeRules" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership type rules", "description": "You can use this API to delete Membership type rules.OperationId:deleteMembershipTypeRules
", "operationId": "deleteMembershipTypeRules", "parameters": [ { "name": "membershipTypeRulesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipPointsSequence", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Sequence number of the membership type rule.", "items": { "type": "integer" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "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": [ "MembershipConfig" ] } }, "/upsert/membershipTypeRules/{membershipTypeRulesId}" : { "put" : { "summary" : "Create/Change Membership type rules", "description" : "You can use this API to create/change Membership type rules.OperationId:putMembershipTypeRules
", "operationId" : "putUpsertMembershipTypeRules", "parameters" : [ { "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/membershipTypeRules" } ] } }, { "$ref" : "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref" : "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref" : "#/parameters/x-hotelid" }, { "$ref" : "#/parameters/x-externalsystem" }, { "$ref" : "#/parameters/Accept-Language" } ], "responses" : { "200" : { "headers" : { "Content-Language" : { "type" : "string", "description" : "Audience language", "pattern" : "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example" : "en-GB" }, "Location" : { "type" : "string", "description" : "Location of newly created resource" } }, "description" : "Response Body.", "schema" : { "$ref" : "#/definitions/status" } } }, "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "tags" : [ "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": [ { "name": "includeInactive", "in": "query", "required": false, "description": "Search criteria for fetching inactive memberships. When set to true, inactive records will be included.", "type": "boolean" }, { "name": "membershipTypesCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "membershipTypesWildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "membershipClassesCodes", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "membershipClassesWildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Types.", "schema": { "$ref": "#/definitions/membershipTypes" } }, "204": { "description": "MembershipTypes 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": [ "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": [ { "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" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "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": [ { "name": "membershipTypeId", "in": "path", "required": true, "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 }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Membership Type.", "schema": { "$ref": "#/definitions/membershipTypesDetails" } }, "204": { "description": "MembershipType 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": [ "MembershipConfig" ] }, "put": { "summary": "Change Membership type", "description": "Use this API to update an existing Membership TypeOperationId:putMembershipType
", "operationId": "putMembershipType", "parameters": [ { "name": "membershipTypeId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipTypes values based on given membershipTypeId" }, { "name": "membershipTypeChangeInstructions", "in": "body", "required": true, "description": "Request object for changing membership type.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipTypeChangeInstructions" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/membershipTypes" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Membership type", "description": "Use this API to delete an existing Membership TypeOperationId:deleteMembershipTypes
", "operationId": "deleteMembershipTypes", "parameters": [ { "name": "membershipTypeId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipTypes values based on given membershipTypeId" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/membershipTypes/{membershipType}/membershipLevels/{membershipLevel}/membershipLevelRules/{membershipLevelRulesID}": { "delete": { "summary": "Delete Membership Level Rules", "description": "You can use this API to delete Membership Level Rules.OperationId:deleteMembershipLevelRules
", "operationId": "deleteMembershipLevelRules", "parameters": [ { "name": "membershipLevelRulesID", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Membership Level Rule Number for which Tier Management Level rules needs to be deleted." }, { "name": "membershipType", "in": "path", "required": true, "minLength": 1, "maxLength": 20, "description": "Membership Type for which Tier Management Level rules needs to be deleted.", "type": "string" }, { "name": "membershipLevel", "in": "path", "required": true, "description": "Membership Level for which Tier Management Level rules needs to be deleted.", "type": "string", "minLength": 0, "maxLength": 20 }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/nationalities": { "get": { "summary": "Get Nationalities", "description": "Use this API to get Nationalities.OperationId:getNationalities
", "operationId": "getNationalities", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Nationalities.", "schema": { "$ref": "#/definitions/nationalitiesDetails" } }, "204": { "description": "Nationalities 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 Nationalities", "description": "Use this API to create Nationalities.OperationId:postNationalities
", "operationId": "postNationalities", "parameters": [ { "name": "nationalitiesCriteria", "in": "body", "required": true, "description": "Request object for creating Nationalities.", "schema": { "allOf": [ { "$ref": "#/definitions/nationalitiesCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/nationalities/{nationalitiesId}": { "put": { "summary": "Change Nationalities", "description": "Use this API to update Nationalities.OperationId:putNationalities
", "operationId": "putNationalities", "parameters": [ { "name": "nationalitiesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Nationalities." }, { "name": "nationalitiesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Nationalities.", "schema": { "allOf": [ { "$ref": "#/definitions/nationalitiesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Nationalities", "description": "Use this API to delete Nationalities.OperationId:deleteNationalities
", "operationId": "deleteNationalities", "parameters": [ { "name": "nationalitiesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Nationalities." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/ownerTeams": { "get": { "summary": "Get Owner Teams", "description": "Use this API to get Owner Teams.OperationId:getOwnerTeams
", "operationId": "getOwnerTeams", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Owner Teams.", "schema": { "$ref": "#/definitions/ownerTeamsDetails" } }, "204": { "description": "OwnerTeams 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 Owner Teams", "description": "Use this API to create Owner Teams.OperationId:postOwnerTeams
", "operationId": "postOwnerTeams", "parameters": [ { "name": "ownerTeamsCriteria", "in": "body", "required": true, "description": "Request object for creating Owner Teams.", "schema": { "allOf": [ { "$ref": "#/definitions/ownerTeamsCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/ownerTeams/{ownerTeamCode}": { "put": { "summary": "Change Owner Teams", "description": "Use this API to update Owner Teams.OperationId:changeOwnerTeams
", "operationId": "changeOwnerTeams", "parameters": [ { "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/ownerTeamsToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Owner Teams", "description": "Use this API to delete Owner Teams.OperationId:removeOwnerTeams
", "operationId": "removeOwnerTeams", "parameters": [ { "name": "ownerTeamCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of Owner Teams." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/payDays": { "get": { "summary": "Get Pay Days", "description": "Use this API to get Pay Days.OperationId:getPayDays
", "operationId": "getPayDays", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Pay Days.", "schema": { "$ref": "#/definitions/payDaysDetails" } }, "204": { "description": "PayDays 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 Pay Days", "description": "Use this API to create Pay Days.OperationId:postPayDays
", "operationId": "postPayDays", "parameters": [ { "name": "payDaysCriteria", "in": "body", "required": true, "description": "Request object for creating Pay Days.", "schema": { "allOf": [ { "$ref": "#/definitions/payDaysCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/payDays/{payDaysId}": { "put": { "summary": "Change Pay Days", "description": "Use this API to update Pay Days.OperationId:putPayDays
", "operationId": "putPayDays", "parameters": [ { "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/payDaysToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Pay Days", "description": "Use this API to delete Pay Days.OperationId:deletePayDays
", "operationId": "deletePayDays", "parameters": [ { "name": "payDaysId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Pay Days." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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": [ { "name": "preferenceCode", "in": "query", "required": true, "description": "Specifies the preference code.", "type": "string" }, { "name": "preferenceGroup", "in": "query", "required": true, "description": "Specifies the preference group the preference belongs to.", "type": "string" }, { "name": "hotelId", "in": "query", "required": false, "description": "Specifies the hotel code for which the preference is specified.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/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": [ { "name": "preferenceGroupsCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Preference group description to be searched.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching preference groups.", "schema": { "$ref": "#/definitions/preferenceGroups" } }, "204": { "description": "PreferenceGroups 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": [ "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": [ { "name": "preferenceGroups", "in": "body", "required": true, "description": "Request object for changing existing preference groups.", "schema": { "allOf": [ { "$ref": "#/definitions/preferenceGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete preference groups", "description": "This will allow you to delete an existing Preference Group.OperationId:deletePreferenceGroups
", "operationId": "deletePreferenceGroups", "parameters": [ { "name": "preferenceGroup", "in": "query", "required": true, "description": "Code identifying the preference group.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create new preference groups ", "description": "Use this API to create a new Preference group.OperationId:postPreferenceGroups
", "operationId": "postPreferenceGroups", "parameters": [ { "name": "preferenceGroups", "in": "body", "required": true, "description": "Request object for creating new preference groups.", "schema": { "allOf": [ { "$ref": "#/definitions/preferenceGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/preferences": { "get": { "summary": "Get template Preferences", "description": "You can use this API to get template Preferences.OperationId:getTemplatePreferences
", "operationId": "getTemplatePreferences", "parameters": [ { "name": "preferenceCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "name": "preferenceGroupsCodes", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string", "maxItems": 4000 }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching preferences at the template level.", "schema": { "$ref": "#/definitions/templatePreferences" } }, "204": { "description": "TemplatePreferences 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change template preferences", "description": "You can use this API to change template preferences.OperationId:putTemplatePreferences
", "operationId": "putTemplatePreferences", "parameters": [ { "name": "templatePreferences", "in": "body", "required": true, "description": "Request object for changing preferences at the template level.", "schema": { "allOf": [ { "$ref": "#/definitions/templatePreferences" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete template preferences", "description": "You can use this API to delete template preferences.OperationId:deleteTemplatePreferences
", "operationId": "deleteTemplatePreferences", "parameters": [ { "name": "preferenceCode", "in": "query", "required": true, "description": "Specifies the preference code.", "type": "string" }, { "name": "preferenceGroup", "in": "query", "required": true, "description": "Specifies the preference group the preference belongs to.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create template preferences", "description": "You can use this API to create template preferences.OperationId:postTemplatePreferences
", "operationId": "postTemplatePreferences", "parameters": [ { "name": "templatePreferences", "in": "body", "required": true, "description": "Request object for creating preferences at the template level.", "schema": { "allOf": [ { "$ref": "#/definitions/templatePreferences" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/preferences/copy": { "put": { "summary": "Copy preferences", "description": "Use this API to copy preferences.OperationId:copyPreferences
", "operationId": "copyPreferences", "parameters": [ { "name": "preferencesCopy", "in": "body", "required": true, "description": "Request object for copying template preferences to hotel(s).", "schema": { "allOf": [ { "$ref": "#/definitions/preferencesCopy" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/processTierManagement": { "post": { "summary": "Process Tier Management", "description": "Use this API to process Tier Management.OperationId:processTierManagement
", "operationId": "processTierManagement", "parameters": [ { "name": "tierManagement", "in": "body", "required": true, "description": "Request object for processing membership tier level changes.", "schema": { "allOf": [ { "$ref": "#/definitions/tierManagement" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/profileInactiveReasons": { "get": { "summary": "Get Profile Inactive Reasons", "description": "Use this API to get Profile Inactive Reasons.OperationId:getProfileInactiveReasons
", "operationId": "getProfileInactiveReasons", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Profile Inactive Reasons.", "schema": { "$ref": "#/definitions/profileInactiveReasonsDetails" } }, "204": { "description": "ProfileInactiveReasons 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 Profile Inactive Reasons", "description": "Use this API to create Profile Inactive Reasons.OperationId:postProfileInactiveReasons
", "operationId": "postProfileInactiveReasons", "parameters": [ { "name": "profileInactiveReasonsCriteria", "in": "body", "required": true, "description": "Request object for creating Profile Inactive Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/profileInactiveReasonsCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/profileInactiveReasons/{profileInactiveReasonsId}": { "put": { "summary": "Change Profile Inactive Reasons", "description": "Use this API to update Profile Inactive Reasons.OperationId:putProfileInactiveReasons
", "operationId": "putProfileInactiveReasons", "parameters": [ { "name": "profileInactiveReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Profile Inactive Reasons." }, { "name": "profileInactiveReasonsToBeChanged", "in": "body", "required": true, "description": "Request object for changing Profile Inactive Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/profileInactiveReasonsToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete Profile Inactive Reasons", "description": "Use this API to delete Profile Inactive Reasons.OperationId:deleteProfileInactiveReasons
", "operationId": "deleteProfileInactiveReasons", "parameters": [ { "name": "profileInactiveReasonsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Profile Inactive Reasons." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/profileNameValidations": { "get": { "summary": "Get Profile Name Validations", "description": "You can use this API to get Profile Name Validations.OperationId:getProfileNameValidations
", "operationId": "getProfileNameValidations", "parameters": [ { "name": "typeCodes", "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": "name", "in": "query", "required": false, "description": "Profile Name to be Searched.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetching Profile names.", "schema": { "$ref": "#/definitions/profileNameValidations" } }, "204": { "description": "ProfileNameValidations 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change Profile Name Validations", "description": "You can use this API to change Profile Name Validations.OperationId:putProfileNameValidations
", "operationId": "putProfileNameValidations", "parameters": [ { "name": "profileNameValidationsToChange", "in": "body", "required": true, "description": "Request object to edit Profile names.", "schema": { "allOf": [ { "$ref": "#/definitions/profileNameValidationsToChange" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete Profile Name Validations", "description": "You can use this API to delete Profile Name Validations.OperationId:deleteProfileNameValidations
", "operationId": "deleteProfileNameValidations", "parameters": [ { "name": "profileType", "in": "query", "required": true, "type": "string", "description": "Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source.", "uniqueItems": true, "enum": [ "Company", "TravelAgent", "Source" ] }, { "name": "profileName", "in": "query", "required": true, "description": "Name of the Profile.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create Profile Name Validations", "description": "You can use this API to create Profile Name Validations.OperationId:postProfileNameValidations
", "operationId": "postProfileNameValidations", "parameters": [ { "name": "profileNameValidations", "in": "body", "required": true, "description": "Request object to create Profile names.", "schema": { "allOf": [ { "$ref": "#/definitions/profileNameValidations" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/upsert/profileNameValidations" : { "put" : { "summary" : "Create/Change Profile Name Validations", "description" : "You can use this API to create/change Profile Name Validations.OperationId:putUpsertProfileNameValidations
", "operationId" : "putUpsertProfileNameValidations", "parameters" : [ { "name" : "profileNameValidationsToChange", "in" : "body", "required" : true, "description" : "Request object to edit Profile names.", "schema" : { "allOf" : [ { "$ref" : "#/definitions/profileNameValidationsToChange" } ] } }, { "$ref" : "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref" : "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref" : "#/parameters/x-hotelid" }, { "$ref" : "#/parameters/x-externalsystem" }, { "$ref" : "#/parameters/Accept-Language" } ], "responses" : { "200" : { "headers" : { "Content-Language" : { "type" : "string", "description" : "Audience language", "pattern" : "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example" : "en-GB" }, "Location" : { "type" : "string", "description" : "Location of newly created resource" } }, "description" : "Response Body.", "schema" : { "$ref" : "#/definitions/status" } } }, "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "tags" : [ "ProfileConfiguration" ] } }, "/profileRestrictionReasons": { "get": { "summary": "Get Profile Restriction Reasons", "description": "Use this API to get Profile Restriction Reasons.OperationId:getProfileRestrictionReasons
", "operationId": "getProfileRestrictionReasons", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Profile Restriction Reasons.", "schema": { "$ref": "#/definitions/profileRestrictionReasonsDetails" } }, "204": { "description": "ProfileRestrictionReasons 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 Profile Restriction Reasons", "description": "Use this API to create Profile Restriction Reasons.OperationId:postProfileRestrictionReasons
", "operationId": "postProfileRestrictionReasons", "parameters": [ { "name": "profileRestrictionReasonsCriteria", "in": "body", "required": true, "description": "Request object for creating Profile Restriction Reasons.", "schema": { "allOf": [ { "$ref": "#/definitions/profileRestrictionReasonsCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/profileRestrictionReasons/{profileRestrictionReasonsId}": { "put": { "summary": "Change Profile Restriction Reasons", "description": "Use this API to update Profile Restriction Reasons.OperationId:putProfileRestrictionReasons
", "operationId": "putProfileRestrictionReasons", "parameters": [ { "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/profileRestrictionReasonsToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete 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", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Profile Restriction Reasons." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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": [ { "name": "fromType", "in": "query", "required": false, "description": "From type to process", "type": "string" }, { "name": "toType", "in": "query", "required": false, "description": "To type to process", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Respose object for fetch profile links", "schema": { "$ref": "#/definitions/profileLinks" } }, "204": { "description": "ProfileLinks 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": [ "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": [ { "name": "profileLinks", "in": "body", "required": true, "description": "Request Object for change profile links", "schema": { "allOf": [ { "$ref": "#/definitions/profileLinks" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "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": [ { "name": "fromType", "in": "query", "required": true, "description": "From type to process", "type": "string" }, { "name": "toType", "in": "query", "required": true, "description": "To type to process", "type": "string" }, { "name": "fromCode", "in": "query", "required": true, "description": "From code to process", "type": "string" }, { "name": "toCode", "in": "query", "required": true, "description": "To code to process", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "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": [ { "name": "profileLinks", "in": "body", "required": true, "description": "Request Object to create Profile Links", "schema": { "allOf": [ { "$ref": "#/definitions/profileLinks" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/profiles/profileRegion": { "get": { "summary": "Get profile regions", "description": "You can use this API to get the profile regions.OperationId:getProfileRegions
", "operationId": "getProfileRegions", "parameters": [ { "name": "region", "in": "query", "required": false, "description": "Region to filter based on the profile region setup.", "type": "string" }, { "name": "type", "in": "query", "required": false, "description": "Type to filter profile region.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for Profile Regions Configuration.", "schema": { "$ref": "#/definitions/profileRegionsInfo" } }, "204": { "description": "ProfileRegions 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": [ "MembershipConfig" ] }, "put": { "summary": "Update Profile Region", "description": "You can use this API to update profile region.OperationId:putProfileRegion
", "operationId": "putProfileRegion", "parameters": [ { "name": "profileRegion", "in": "body", "required": true, "description": "Request object for updating Profile Region.", "schema": { "allOf": [ { "$ref": "#/definitions/profileRegionType" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "post": { "summary": "Create Profile Region", "description": "You can use this API to create profile region.OperationId:postProfileRegion
", "operationId": "postProfileRegion", "parameters": [ { "name": "profileRegion", "in": "body", "required": true, "description": "Request object for creating Profile Region Configuration.", "schema": { "allOf": [ { "$ref": "#/definitions/profileRegionInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "delete": { "summary": "Delete Profile Region.", "description": "You can use this API to delete profile region.OperationId:deleteProfileRegion
.", "operationId": "deleteProfileRegion", "parameters": [ { "name": "region", "in": "query", "required": true, "description": "Delete profile region based on region.", "type": "string", "minLength": 1, "maxLength": 2000 }, { "name": "type", "in": "query", "required": true, "description": "Delete profile region based on name type.", "type": "string", "minLength": 1, "maxLength": 2000 }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/profiles/suspendedMatchRules": { "get": { "summary": "Get profile suspended match rules", "description": "You can use this API to get suspended profile match rules.OperationId:getSuspendedMatchRules
", "operationId": "getSuspendedMatchRules", "parameters": [ { "name": "region", "in": "query", "required": false, "description": "Region to filter rules based on the profile region setup", "type": "string" }, { "name": "nameType", "in": "query", "required": false, "description": "Name type to filter match rules", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for Suspended Profile Match Rules Configuration.", "schema": { "$ref": "#/definitions/suspendedMatchRulesInfo" } }, "204": { "description": "SuspendedMatchRules 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": [ "MembershipConfig" ] }, "put": { "summary": "Update suspended match rules", "description": "You can use this API to update suspended match rules.OperationId:putSuspendedMatchRules
", "operationId": "putSuspendedMatchRules", "parameters": [ { "name": "suspendedMatchRules", "in": "body", "required": true, "description": "Request object for updating Suspended Profile Match Rules Configuration.", "schema": { "allOf": [ { "$ref": "#/definitions/updateSuspendedMatchRuleType" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] }, "post": { "summary": "Create suspended match rules", "description": "You can use this API to create suspended profile match rules.OperationId:postSuspendedMatchRules
", "operationId": "postSuspendedMatchRules", "parameters": [ { "name": "suspendedMatchRules", "in": "body", "required": true, "description": "Request object for creating Suspended Profile Match Rules Configuration.", "schema": { "allOf": [ { "$ref": "#/definitions/suspendedMatchRulesInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/profiles/suspendedMatchRules/copy": { "post": { "summary": "Copy suspended match rule", "description": "You can use this API to copy suspended profile match rule.OperationId:copySuspendedMatchRule
", "operationId": "copySuspendedMatchRule", "parameters": [ { "name": "copySuspendedMatchRule", "in": "body", "required": true, "description": "Request object for copying Suspended Profile Match Rules Configuration.", "schema": { "allOf": [ { "$ref": "#/definitions/copySuspendedMatchRuleType" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/profiles/suspendedMatchRules/{region}/{nameType}/{validationItem}": { "delete": { "summary": "Delete suspended match rules", "description": "You can use this API to delete suspended profile match rule.OperationId:deleteSuspendedMatchRules
", "operationId": "deleteSuspendedMatchRules", "parameters": [ { "name": "region", "in": "path", "required": true, "description": "Delete match rule based on region.", "type": "string", "minLength": 1, "maxLength": 2000 }, { "name": "nameType", "in": "path", "required": true, "description": "Delete match rule based on name type.", "type": "string", "minLength": 1, "maxLength": 2000 }, { "name": "validationItem", "in": "path", "required": true, "description": "Delete match rule based on validation item.", "type": "string", "minLength": 1, "maxLength": 2000 }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/relationships": { "get": { "summary": "Get profile relationships", "description": "You can use this API to get profile relationships.OperationId:getProfileRelationships
", "operationId": "getProfileRelationships", "parameters": [ { "name": "fromType", "in": "query", "required": false, "description": "From type to process", "type": "string" }, { "name": "toType", "in": "query", "required": false, "description": "To type to process", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Respose object for fetch profile links", "schema": { "$ref": "#/definitions/profileLinks" } }, "204": { "description": "ProfileRelationships 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": [ "ProfileConfiguration" ] }, "put": { "summary": "Change profile relationships", "description": "You can use this API to change profile relationships.OperationId:putProfileRelationships
", "operationId": "putProfileRelationships", "parameters": [ { "name": "profileLinks", "in": "body", "required": true, "description": "Request Object for change profile links", "schema": { "allOf": [ { "$ref": "#/definitions/profileLinks" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "delete": { "summary": "Delete profile relationships", "description": "You can use this API to delete profile relationships.OperationId:deleteProfileRelationships
", "operationId": "deleteProfileRelationships", "parameters": [ { "name": "fromType", "in": "query", "required": true, "description": "From type to process", "type": "string" }, { "name": "toType", "in": "query", "required": true, "description": "To type to process", "type": "string" }, { "name": "fromCode", "in": "query", "required": true, "description": "From code to process", "type": "string" }, { "name": "toCode", "in": "query", "required": true, "description": "To code to process", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] }, "post": { "summary": "Create profile relationships", "description": "You can use this API to create profile relationships.OperationId:postProfileRelationships
", "operationId": "postProfileRelationships", "parameters": [ { "name": "profileLinks", "in": "body", "required": true, "description": "Request Object to create Profile Links", "schema": { "allOf": [ { "$ref": "#/definitions/profileLinks" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/services/chainConfig/status": { "get": { "summary": " ping", "description": "Ping Chain Configuration ServiceOperationId:pingChainConfigServices
", "operationId": "pingChainConfigServices", "parameters": [ { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for Ping operation.", "schema": { "$ref": "#/definitions/operaVersion" } }, "204": { "description": "pingChainConfigServices not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/services/hotelConfig/status": { "get": { "summary": " ping", "description": "Ping Hotel Configuration ServiceOperationId:pingHotelConfigServices
", "operationId": "pingHotelConfigServices", "parameters": [ { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for Ping operation.", "schema": { "$ref": "#/definitions/operaVersion" } }, "204": { "description": "pingHotelConfigServices not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "HotelConfig" ] } }, "/services/membershipConfig/status": { "get": { "summary": " ping", "description": "Ping Membership Configuration ServiceOperationId:pingMembershipConfigService
", "operationId": "pingMembershipConfigService", "parameters": [ { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for Ping operation.", "schema": { "$ref": "#/definitions/operaVersion" } }, "204": { "description": "pingMembershipConfigService 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": [ "MembershipConfig" ] } }, "/services/profile/status": { "get": { "summary": " ping", "description": "Ping Profile Configuration ServiceOperationId:pingProfileConfigService
", "operationId": "pingProfileConfigService", "parameters": [ { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for Ping operation.", "schema": { "$ref": "#/definitions/operaVersion" } }, "204": { "description": "pingProfileConfigService 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": [ "ProfileConfiguration" ] } }, "/sources": { "get": { "summary": "Get Sources", "description": "Use this API to get Sources.OperationId:getSources
", "operationId": "getSources", "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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Sources.", "schema": { "$ref": "#/definitions/sourcesDetails" } }, "204": { "description": "Sources 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 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/sources/{sourcesId}": { "put": { "summary": "Change Sources", "description": "Use this API to update Sources.OperationId:putSources
", "operationId": "putSources", "parameters": [ { "name": "sourcesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of Sources." }, { "name": "sourcesToBeChanged", "in": "body", "required": true, "description": "Request object for changing Sources.", "schema": { "allOf": [ { "$ref": "#/definitions/sourcesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/states/{stateCode}": { "put": { "summary": "Change States", "description": "Use this API to update States.OperationId:changeStates
", "operationId": "changeStates", "parameters": [ { "name": "stateCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of State." }, { "name": "statesToBeChanged", "in": "body", "required": true, "description": "Request object for updating states.", "schema": { "allOf": [ { "$ref": "#/definitions/statesToBeChanged" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete States", "description": "Use this API to delete States.OperationId:removeStates
", "operationId": "removeStates", "parameters": [ { "name": "stateCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique Code of State." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/tierManagementBatchProcesses": { "get": { "summary": "Get Tier Management Batch Processes", "description": "You can use this API to get Tier Management Batch Processes.OperationId:getTierManagementBatchProcesses
", "operationId": "getTierManagementBatchProcesses", "parameters": [ { "name": "reportId", "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": "reportIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "description": "Fetches the data for all the membership level rules.", "uniqueItems": true, "enum": [ "Downgrade", "Renewal", "Upgrade", "All" ] }, { "name": "evaluationDateFrom", "in": "query", "required": false, "description": "Evaluation From Date to fetch the tier processing jobs", "type": "string", "format": "date" }, { "name": "evaluationDateTo", "in": "query", "required": false, "description": "Evaluation To Date to fetch the tier processing jobs.", "type": "string", "format": "date" }, { "name": "processDateFrom", "in": "query", "required": false, "description": "Process From Date to fetch the tier processing jobs based on insert date.", "type": "string", "format": "date" }, { "name": "processDateTo", "in": "query", "required": false, "description": "Process To Date to fetch the tier processing jobs based on insert date.", "type": "string", "format": "date" }, { "name": "limit", "in": "query", "required": false, "default": 20, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "offset", "in": "query", "default": 1, "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Tier Management Batch Reports.", "schema": { "$ref": "#/definitions/tierManagementBatchProcesses" } }, "204": { "description": "TierManagementBatchProcesses 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": [ "MembershipConfig" ] } }, "/tierManagementBatchRecords": { "get": { "summary": "Get Tier Management Batch Records", "description": "You can use this API to get Tier Management Batch Records.OperationId:getTierManagementBatchRecords
", "operationId": "getTierManagementBatchRecords", "deprecated": true, "parameters": [ { "name": "name", "in": "query", "required": false, "description": "Display name of the member.", "type": "string" }, { "name": "recordStatus", "in": "query", "required": false, "type": "string", "description": "Record locked.", "uniqueItems": true, "enum": [ "New", "Complete", "Delete", "Error", "Locked" ] }, { "name": "level", "in": "query", "required": false, "description": "Old membership level before upgrade or downgrade.", "type": "string" }, { "name": "levelDifference", "in": "query", "required": false, "description": "Level Difference.", "type": "integer" }, { "name": "membershipCardNumber", "in": "query", "required": false, "description": "Member Card no.", "type": "string" }, { "name": "reportId", "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": "reportIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "limit", "in": "query", "required": false, "default": 20, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "offset", "in": "query", "default": 1, "required": false, "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Tier Management Batch Records.", "schema": { "$ref": "#/definitions/tierManagementBatchRecords" } }, "204": { "description": "TierManagementBatchRecords 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": [ "MembershipConfig" ] } }, "/tierManagementBatchRecords/searches": { "post": { "summary": "Get Tier Management Batch Records", "description": "You can use this API to get Tier Management Batch Records.OperationId:searchTierManagementBatchRecords
", "operationId": "searchTierManagementBatchRecords", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "parameters": [ { "name": "searchTierManagementBatchRecordsRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/searchTierManagementBatchRecordsRequest" } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Tier Management Batch Records.", "schema": { "$ref": "#/definitions/tierManagementBatchRecords" } }, "204": { "description": "TierManagementBatchRecords 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" } }, "tags": [ "MembershipConfig" ] } }, "/tierManagementBatchRecords/{tierManagementBatchRecordsID}": { "delete": { "summary": "Delete Tier Management Batch Record", "description": "You can use this API to delete Tier Management Batch Record.OperationId:deleteTierManagementBatchRecords
", "operationId": "deleteTierManagementBatchRecords", "parameters": [ { "name": "tierManagementBatchRecordsID", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "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": "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": "membershipIdIdExtension", "in": "query", "required": false, "description": "Additional identifying value assigned by the creating system.", "type": "integer" }, { "name": "membershipIdIdContext", "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string" }, { "name": "membershipIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/tierManagementChanges": { "post": { "summary": "Apply Tier Management Changes", "description": "Apply Tier Management changes calculated by batch process.OperationId:applyTierManagementChanges
", "operationId": "applyTierManagementChanges", "parameters": [ { "name": "tierManagementChanges", "in": "body", "required": true, "description": "Request object for applying membership changes calculated by Tier Management process.", "schema": { "allOf": [ { "$ref": "#/definitions/tierManagementChanges" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/tierManagementChanges/{tierManagementChangesID}": { "delete": { "summary": "Delete Tier Management ", "description": "Delete Tier Management changes calculated by batch process.OperationId:deleteTierManagementChanges
", "operationId": "deleteTierManagementChanges", "parameters": [ { "name": "tierManagementChangesID", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "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": "overrideWarning", "in": "query", "required": false, "description": "If true, overrides the warning \"Previous batch(es) ran but update not completed.\" and proceeds update.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/upsert/membershipOriginGroups/{membershipOriginGroupId}": { "put": { "summary": "Create/Change Membership origin group", "description": "You can use this API to create/change Membership origin group.OperationId:putUpsertMembershipOriginGroup
", "operationId": "putUpsertMembershipOriginGroup", "parameters": [ { "name": "membershipOriginGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Membership origin group code which will be changed." }, { "name": "membershipOriginGroup", "in": "body", "required": true, "description": "Request object for changing existing Membership Origin Group Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipOriginGroupDetails" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipPropertyGroups/{membershipPropertyGroupsId}": { "put": { "summary": "Create/Change Membership property groups", "description": "You can use this API to create/change Membership property groups.OperationId:putUpsertMembershipPropertyGroups
", "operationId": "putUpsertMembershipPropertyGroups", "parameters": [ { "name": "membershipPropertyGroupsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipPropertyGroups", "in": "body", "required": true, "description": "Request object for changing existing Membership Property Groups Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipPropertyGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipRateGroups/{membershipRateGroupId}": { "put": { "summary": "Create/Change Membership rate groups", "description": "You can use this API to create/change Membership rate groups.OperationId:putUpsertMembershipRateGroups
", "operationId": "putUpsertMembershipRateGroups", "parameters": [ { "name": "membershipRateGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRateGroups", "in": "body", "required": true, "description": "Request object for modifying Membership Rate Groups.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRateGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipRates/{membershipRatesId}": { "put": { "summary": "Create/Change Membership rates", "description": "You can use this API to create/change Membership rates.OperationId:putUpsertMembershipRates
", "operationId": "putUpsertMembershipRates", "parameters": [ { "name": "membershipRatesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRates", "in": "body", "required": true, "description": "Request object for changing membership rate rules.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRates" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipRevenueGroups/{membershipRevenueGroupId}": { "put": { "summary": "Create/Change Membership revenue groups", "description": "You can use this API to create/change Membership revenue groups.This API is deprecated.
OperationId:putUpsertMembershipRevenueGroups
", "operationId": "putUpsertMembershipRevenueGroups", "deprecated": true, "parameters": [ { "name": "membershipRevenueGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRevenueGroups", "in": "body", "required": true, "description": "Request object for changing new membership revenue groups.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRevenueGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipRevenueTypes/{membershipRevenueTypesId}": { "put": { "summary": "Create/Change Membership revenue types", "description": "You can use this API to create/change Membership revenue types.This API is deprecated.
OperationId:putUpsertMembershipRevenueTypes
", "operationId": "putUpsertMembershipRevenueTypes", "parameters": [ { "name": "membershipRevenueTypesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRevenueTypes", "in": "body", "required": true, "description": "Request object for changing new membership revenue types.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRevenueTypes" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipRoomGroups/{membershipRoomGroupsId}": { "put": { "summary": "Create/Change Membership room groups", "description": "You can use this API to create/change Membership room groups.This API is deprecated.
OperationId:putUpsertMembershipRoomGroups
", "operationId": "putUpsertMembershipRoomGroups", "parameters": [ { "name": "membershipRoomGroupsId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "membershipRoomGroups", "in": "body", "required": true, "description": "Request object for changing membership room groups.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipRoomGroups" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/membershipSourceGroups/{membershipSourceGroupId}": { "put": { "summary": "Create/Change Membership source group", "description": "You can use this API to create/change Membership source group.OperationId:putUpsertMembershipSourceGroup
", "operationId": "putUpsertMembershipSourceGroup", "parameters": [ { "name": "membershipSourceGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 20, "description": "Membership source group code which will be changed." }, { "name": "membershipSourceGroup", "in": "body", "required": true, "description": "Request object for changing existing Membership Source Group Configurations.", "schema": { "allOf": [ { "$ref": "#/definitions/membershipSourceGroupDetails" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/qualifyingRates/{qualifyingRatesId}": { "put": { "summary": "Upsert Qualifying Rates", "description": "You can use this API to upsert Qualifying Rates.This API is deprecated.
OperationId:putUpsertQualifyingRates
", "operationId": "putUpsertQualifyingRates", "deprecated": true, "parameters": [ { "name": "qualifyingRatesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, { "name": "qualifyingRates", "in": "body", "required": true, "description": "Request object for changing qualifying rate rules.", "schema": { "allOf": [ { "$ref": "#/definitions/qualifyingRates" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "MembershipConfig" ] } }, "/upsert/relationships": { "put": { "summary": "Create/Change profile relationships", "description": "You can use this API to create/change profile relationships.OperationId:putUpsertProfileRelationships
", "operationId": "putUpsertProfileRelationships", "parameters": [ { "name": "profileLinks", "in": "body", "required": true, "description": "Request Object for change profile links", "schema": { "allOf": [ { "$ref": "#/definitions/profileLinks" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ProfileConfiguration" ] } }, "/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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } }, "/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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] }, "delete": { "summary": "Delete 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/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ChainConfig" ] } } }, "parameters": { "externalData": { "name": "externalData", "type": "string", "description": "Pass this header as true, if payload needs DVM", "in": "header" }, "authKey": { "name": "authorization", "description": "Bearer token that needs to be passed which is generated post user authentication", "type": "string", "in": "header", "required": true }, "x-app-key": { "name": "x-app-key", "description": "Client or Partner's Application Key", "type": "string", "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", "in": "header", "required": true }, "x-request-id": { "name": "x-request-id", "type": "string", "pattern": "~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "description": "Request Id of an incoming request", "in": "header" }, "x-originating-application": { "name": "x-originating-application", "type": "string", "description": "Customer's Integration Application Id", "in": "header" }, "x-hotelid": { "name": "x-hotelid", "type": "string", "description": "Mandatory parameter to identify the hotel code where the end user is logged in", "in": "header", "required": true }, "x-externalsystem": { "name": "x-externalsystem", "type": "string", "maxLength": 40, "description": "External system code.", "in": "header", "x-example": "EXTERNALSYSTEMCODE" }, "Accept-Language": { "name": "Accept-Language", "type": "string", "description": "Language code", "in": "header" }, "x-hubid": { "name": "x-hubid", "type": "string", "description": "x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid", "in": "header" } }, "responses": { "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "405": { "description": "Method not allowed" }, "406": { "description": "Not acceptable." }, "413": { "description": "Request Entity Too Large" }, "414": { "description": "Request URI Too Large" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "System Error", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "definitions": { "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" }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 20 }, "instance": { "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", "type": "string", "minLength": 0, "maxLength": 80 }, "idContext": { "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string", "minLength": 0, "maxLength": 80 }, "id": { "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", "type": "string", "minLength": 0, "maxLength": 80 }, "idExtension": { "description": "Additional identifying value assigned by the creating system.", "type": "integer" } } }, "personNameType": { "type": "object", "description": "This provides name information for a person.", "properties": { "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 }, "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 } } }, "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": { "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", "minLength": 0, "maxLength": 80 }, "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 } } }, "links": { "type": "array", "items": { "$ref": "#/definitions/instanceLink" } }, "instanceLink": { "type": "object", "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", "properties": { "href": { "description": "URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.", "type": "string" }, "rel": { "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.", "type": "string" }, "templated": { "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.", "type": "boolean", "default": false }, "method": { "description": "HTTP method for requesting the target of the link.", "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD" ] }, "targetSchema": { "description": "Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..", "type": "string" }, "operationId": { "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.", "type": "string" }, "title": { "description": "Exact copy of the \"summary\" field on the linked operation.", "type": "string" } } }, "warningsType": { "type": "array", "description": "Used in conjunction with the Success element to define a business error.", "maxItems": 4000, "items": { "$ref": "#/definitions/warningType" } }, "warningType": { "type": "object", "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", "properties": { "value": { "type": "string", "description": "Property Value" }, "shortText": { "description": "An abbreviated version of the error in textual format.", "type": "string", "maxLength": 2000 }, "code": { "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", "type": "string", "minLength": 0, "maxLength": 20 }, "docURL": { "description": "If present, this URL refers to an online description of the error that occurred.", "type": "string", "maxLength": 2000 }, "status": { "description": "If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.", "type": "string", "maxLength": 2000 }, "tag": { "description": "If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].", "type": "string", "maxLength": 2000 }, "recordId": { "description": "If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.", "type": "string", "maxLength": 2000 }, "type": { "description": "The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".", "type": "string", "minLength": 0, "maxLength": 20 }, "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "rph": { "description": "Reference Place Holder used as an index for this warning.", "type": "string", "minLength": 1, "maxLength": 8 } } }, "exceptionDetailType": { "title": "Error Detail", "description": "Complex type that contains error details for a REST call.", "type": "object", "properties": { "type": { "type": "string", "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." }, "title": { "type": "string", "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, "detail": { "type": "string", "description": "Human-readable description specific to this occurrence of the problem." }, "instance": { "type": "string", "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, "o:errorCode": { "type": "string", "description": "Application error code, which is different from HTTP error code." }, "o:errorPath": { "type": "string", "description": "Path to the problem at the resource or property level." }, "o:errorDetails": { "description": "Details of the error message, consisting of a hierarchical tree structure.", "type": "array", "items": { "$ref": "#/definitions/errorInstance" } }, "links": { "$ref": "#/definitions/links" } }, "required": [ "type", "title" ] }, "errorInstance": { "title": "Error Instance Details", "description": "Complex type that contains error instance details for a REST call.", "type": "object", "properties": { "type": { "type": "string", "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." }, "title": { "type": "string", "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, "detail": { "type": "string", "description": "Human-readable description specific to this occurrence of the problem." }, "instance": { "type": "string", "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, "o:errorCode": { "type": "string", "description": "Application error code, which is different from HTTP error code." }, "o:errorPath": { "type": "string", "description": "Path to the problem at the resource or property level." } }, "required": [ "type", "title" ] }, "accountPrioritiesDetails": { "type": "object", "description": "Response object for fetching Account Priorities.", "properties": { "accountPriorities": { "description": "Collection of Account Priorities.", "$ref": "#/definitions/accountPrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "accountPrioritiesType": { "type": "array", "description": "List of Account Priorities.", "maxItems": 4000, "items": { "$ref": "#/definitions/accountPriorityType" } }, "accountPriorityType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "translationTextType2000": { "type": "object", "description": "Contains Multiple translated texts and language codes.", "properties": { "defaultText": { "description": "Default text with Character length from 0 to 2000.", "type": "string", "minLength": 0, "maxLength": 2000 }, "translatedTexts": { "description": "List of translated text and language codes.", "$ref": "#/definitions/translationsTextType" } } }, "translationsTextType": { "type": "array", "description": "Language code for the translation.", "maxItems": 4000, "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Used for Character Strings, length 0 to 2000.", "minLength": 0, "maxLength": 2000 }, "language": { "description": "Language identification.", "type": "string", "minLength": 0, "maxLength": 20 } }, "description": "Language code for the translation." } }, "accountPrioritiesCriteria": { "type": "object", "description": "Request object for creating Account Priorities.", "properties": { "accountPriorities": { "description": "Account Prioritiesto be created.", "$ref": "#/definitions/accountPrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "status": { "type": "object", "description": "Response Body.", "properties": { "warnings": { "$ref": "#/definitions/warningsType" }, "links": { "$ref": "#/definitions/links" } } }, "accountPrioritiesToBeChanged": { "type": "object", "description": "Request object for changing Account Priorities.", "properties": { "accountPriorities": { "description": "Account Prioritiesto be changed.", "$ref": "#/definitions/accountPrioritiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "accountTypesDetails": { "type": "object", "description": "Response object for fetching Account Types.", "properties": { "accountTypes": { "description": "Collection of Account Types.", "$ref": "#/definitions/accountTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Indicates the account type is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "accountTypesCriteria": { "type": "object", "description": "Request object for creating Account Types.", "properties": { "accountTypes": { "description": "Account Typesto be created.", "$ref": "#/definitions/accountTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "accountTypesToBeChanged": { "type": "object", "description": "Request object for changing Account Types.", "properties": { "accountTypes": { "description": "Account Typesto be changed.", "$ref": "#/definitions/accountTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "addressFormats": { "type": "object", "description": "Response object for fetching Address Formats.", "properties": { "formats": { "description": "Collection of Address formats fetched.", "$ref": "#/definitions/addressFormatsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "addressFormatsType": { "type": "array", "description": "An Address formats.", "maxItems": 4000, "items": { "$ref": "#/definitions/addressFormatType" } }, "addressFormatType": { "type": "object", "description": "A representation of the information contained by an address format.", "properties": { "formatCode": { "description": "Address format code.", "type": "string", "minLength": 0, "maxLength": 20 }, "formatDefinition": { "description": "Address format definition with the elements of the address.", "type": "string", "minLength": 0, "maxLength": 2000 }, "description": { "description": "Description of the address format.", "type": "string", "minLength": 0, "maxLength": 200 }, "displayOrder": { "description": "sequence number of the address format.", "type": "number" }, "formattedExample": { "description": "An example address formatted with the current format definition.", "type": "string", "minLength": 0, "maxLength": 2000 }, "salesFormat": { "description": "Determines if the format is a sales format or not.", "type": "boolean" }, "canDelete": { "description": "Determines whether this address format can be deleted.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "addressTypesDetails": { "type": "object", "description": "Response object for fetching Address Types.", "properties": { "addressTypes": { "description": "Collection of Address Types.", "$ref": "#/definitions/addressTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "addressTypesType": { "type": "array", "description": "Communication Role Enumeration element.", "maxItems": 4000, "items": { "$ref": "#/definitions/addressTypeType" } }, "addressTypeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "addressTypesCriteria": { "type": "object", "description": "Request object for creating a new Address Type.", "properties": { "addressTypes": { "description": "Address Type to be created.", "$ref": "#/definitions/addressTypesType" }, "links": { "$ref": "#/definitions/links" }, "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", "minLength": 0, "maxLength": 2000 }, "greeting": { "description": "Business Title for advanced title configuration.", "type": "string", "minLength": 0, "maxLength": 200 }, "displayOrder": { "description": "Guest Title record sequence number.", "type": "number" }, "newTitleType": { "description": "Description of the Guest Title.", "type": "integer" }, "newLanguageCode": { "description": "Description of the Guest Title.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Code of the Guest Title.", "type": "string", "minLength": 0, "maxLength": 40 }, "titleType": { "description": "Title Type for advanced title configuration.", "type": "integer" }, "languageCode": { "description": "Language code of the Guest Title.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "alternateLanguageGuestTitlesCriteria": { "type": "object", "description": "Request object for creating Alternate Language Guest Titles.", "properties": { "alternateLanguageGuestTitles": { "description": "Alternate Language Guest Titles to be created.", "$ref": "#/definitions/guestTitlesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "alternateLanguageGuestTitlesToBeChanged": { "type": "object", "description": "Request object for changing Alternate Language Guest Titles.", "properties": { "alternateLanguageGuestTitles": { "description": "Alternate Language Guest Titles to be changed.", "$ref": "#/definitions/guestTitlesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "availablePreferencesDetails": { "type": "object", "description": "Response object for fetching available preferences for a property.", "properties": { "preferenceCollection": { "description": "A collection of preferences", "type": "array", "items": { "$ref": "#/definitions/preferenceTypeType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "preferenceTypeType": { "type": "object", "description": "Preference details for the profile.", "properties": { "preference": { "description": "Collection of Preferences for the profile.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/preferenceType" } }, "preferenceType": { "description": "Preference group code.", "type": "string", "minLength": 0, "maxLength": 20 }, "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", "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 } } }, "preferenceType": { "type": "object", "description": "Guest Preference details for the profile.", "properties": { "preferenceValue": { "description": "Preference value for display purposes.", "type": "string", "minLength": 0, "maxLength": 200 }, "description": { "description": "Preference Description for display purposes.", "type": "string", "minLength": 0, "maxLength": 2000 }, "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" }, "copyToProfile": { "description": "Specifies whether to copy the reservation preference to the profile or not.", "type": "boolean" } } }, "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" } } }, "businessSegmentsType": { "type": "array", "description": "List of Business Segments.", "maxItems": 4000, "items": { "$ref": "#/definitions/businessSegmentType" } }, "businessSegmentType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "businessSegmentsToBeChanged": { "type": "object", "description": "Request object for changing Business Segments.", "properties": { "businessSegments": { "description": "Business Segments to be changed.", "$ref": "#/definitions/businessSegmentsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cityPostalCodesDetails": { "type": "object", "description": "Response object for fetching city and postal codes.", "properties": { "cityPostalCodes": { "description": "Collection of city and postal codes fetched based on the search criteria.", "$ref": "#/definitions/cityPostalCodesType" }, "masterInfoList": { "description": "Refer to Generic common types document.", "type": "array", "items": { "$ref": "#/definitions/masterInfoType" } }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, "offset": { "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, "limit": { "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cityPostalCodesType": { "type": "array", "description": "Lists of City and Postal Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/cityPostalCodeType" } }, "cityPostalCodeType": { "type": "object", "description": "Information about the City and Postal Code.", "properties": { "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", "minLength": 0, "maxLength": 20 }, "fiscalRegionCode": { "description": "The Fiscal Region Code which the City and Postal belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "masterInfoType": { "type": "object", "properties": { "codeInfo": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/codeInfoType" } }, "codeType": { "$ref": "#/definitions/masterType" } } }, "codeInfoType": { "type": "object", "description": "", "properties": { "description": { "type": "string", "minLength": 0, "maxLength": 80 }, "addtionalCodeInfo": { "$ref": "#/definitions/addtionalCodeInfoType" }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "addtionalCodeInfoType": { "type": "array", "description": "Holds name of additional code information", "maxItems": 4000, "items": { "type": "object", "properties": { "name": { "description": "Holds name of additional code information", "$ref": "#/definitions/masterInfoCodeDetailType" }, "value": { "description": "Holds value of additional code information", "type": "string", "minLength": 0, "maxLength": 2000 } } } }, "masterInfoCodeDetailType": { "type": "string", "enum": [ "LongDescription", "ShortDescription" ] }, "masterType": { "type": "string", "enum": [ "Country", "State", "AddressType", "PhoneType", "RateCategory", "CalculationRule", "PostingRythym", "BillingInstruction", "TransactionCode", "DisplaySet", "MailingActions", "DistanceType", "District", "Territory", "FiscalRegion", "InventoryItem", "Package", "RoomFeaturePreference", "SpecialPreference", "Promotion", "Department", "ReservationPreference", "FacilityTask", "RoomType", "RateCode", "OutOfOrderReason", "Block" ] }, "cityPostalCodesCriteria": { "type": "object", "description": "Request object for creating new city and postal codes.", "properties": { "cityPostalCodes": { "description": "Collection of city and postal codes to be created.", "$ref": "#/definitions/cityPostalCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "cityPostalCodesToBeChanged": { "type": "object", "description": "Request object for updating city and postal codes.", "properties": { "cityPostalCodes": { "description": "Collection of city and postal codes to be modified.", "$ref": "#/definitions/cityPostalCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "communicationTypesDetails": { "type": "object", "description": "Response object for fetching Communication Types.", "properties": { "communicationTypes": { "description": "Collection of Communication Types.", "$ref": "#/definitions/communicationTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "communicationTypesType": { "type": "array", "description": "Communication Type details.", "maxItems": 4000, "items": { "$ref": "#/definitions/communicationTypeType" } }, "communicationTypeType": { "type": "object", "description": "Communication Type details.", "properties": { "role": { "description": "Communication Role enumeration element.", "$ref": "#/definitions/communicationRoleType" }, "description": { "description": "Communication Type description.", "type": "string", "minLength": 0, "maxLength": 2000 }, "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 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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": { "communicationType": { "description": "Communication Type to be created.", "$ref": "#/definitions/communicationTypeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "communicationTypeToBeChanged": { "type": "object", "description": "Request object for changing an existing Communication Type.", "properties": { "communicationType": { "description": "Communication Type to be changed.", "$ref": "#/definitions/communicationTypeType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "companyTypesDetails": { "type": "object", "description": "Response object for fetching Company Types.", "properties": { "companyTypes": { "description": "Collection of Company Types.", "$ref": "#/definitions/companyTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "companyTypesType": { "type": "array", "description": "List of Company Types.", "maxItems": 4000, "items": { "$ref": "#/definitions/companyTypeType" } }, "companyTypeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "companyTypesCriteria": { "type": "object", "description": "Request object for creating Company Types.", "properties": { "companyTypes": { "description": "Company Typesto be created.", "$ref": "#/definitions/companyTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "companyTypesToBeChanged": { "type": "object", "description": "Request object for changing Company Types.", "properties": { "companyTypes": { "description": "Company Typesto be changed.", "$ref": "#/definitions/companyTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "competitionCodesDetails": { "type": "object", "description": "Response object for fetching Competition Codes.", "properties": { "competitionCodes": { "description": "Collection of Competition Codes.", "$ref": "#/definitions/competitionCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "competitionCodesType": { "type": "array", "description": "List of Competition Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/competitionCodeType" } }, "competitionCodeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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": { "type": "object", "description": "Response object for fetching credit ratings.", "properties": { "creditRatings": { "description": "Collection of Credit Ratings.", "$ref": "#/definitions/creditRatingsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "creditRatingsType": { "type": "array", "description": "List of Credit Ratings.", "maxItems": 4000, "items": { "$ref": "#/definitions/creditRatingType" } }, "creditRatingType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this credit rating is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "distanceTypesDetails": { "type": "object", "description": "Response object for fetching Distance Types.", "properties": { "distanceTypes": { "description": "Collection of Distance Types.", "$ref": "#/definitions/distanceTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "distanceTypesType": { "type": "array", "description": "List of Distance Types.", "maxItems": 4000, "items": { "$ref": "#/definitions/distanceTypeType" } }, "distanceTypeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "distanceTypesCriteria": { "type": "object", "description": "Request object for creating Distance Types.", "properties": { "distanceTypes": { "description": "Distance Typesto be created.", "$ref": "#/definitions/distanceTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "distanceTypesToBeChanged": { "type": "object", "description": "Request object for changing Distance Types.", "properties": { "distanceTypes": { "description": "Distance Typesto be changed.", "$ref": "#/definitions/distanceTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "districtsDetails": { "type": "object", "description": "Response object for fetching Districts.", "properties": { "districts": { "description": "Collection of Districts.", "$ref": "#/definitions/districtsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "districtsType": { "type": "array", "description": "List of Districts.", "maxItems": 4000, "items": { "$ref": "#/definitions/districtType" } }, "districtType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "districtsCriteria": { "type": "object", "description": "Request object for creating Districts.", "properties": { "districts": { "description": "Districtsto be created.", "$ref": "#/definitions/districtsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "districtsToBeChanged": { "type": "object", "description": "Request object for changing Districts.", "properties": { "districts": { "description": "Districtsto be changed.", "$ref": "#/definitions/districtsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "templateExclusivePreferences": { "type": "object", "description": "Response object for fetching exclusive preferences at the template level.", "properties": { "templateExclusivePreferences": { "description": "Collection of exclusive preferences specified at the template level.", "$ref": "#/definitions/configTemplateExclusivePreferencesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "configTemplateExclusivePreferencesType": { "type": "array", "description": "Base details common between both template and property level exclusive preferences.", "maxItems": 4000, "items": { "$ref": "#/definitions/configExclusivePreferenceBaseType" } }, "configExclusivePreferenceBaseType": { "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" }, "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" }, "links": { "$ref": "#/definitions/links" }, "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" } }, "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", "minLength": 0, "maxLength": 20 }, "preferenceGroup": { "description": "Specifies the preference group the Exclusive preference belongs to.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "codeListType": { "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "travelAgentTypesDetails": { "type": "object", "description": "Response object for fetching Travel Agent Types.", "properties": { "travelAgentTypes": { "description": "Collection of Travel Agent Types.", "$ref": "#/definitions/travelAgentTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "travelAgentTypesType": { "type": "array", "description": "List of Travel Agent Types.", "maxItems": 4000, "items": { "$ref": "#/definitions/travelAgentTypeType" } }, "travelAgentTypeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "travelAgentTypesCriteria": { "type": "object", "description": "Request object for creating Travel Agent Types.", "properties": { "travelAgentTypes": { "description": "Travel Agent Typesto be created.", "$ref": "#/definitions/travelAgentTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "travelAgentTypesToBeChanged": { "type": "object", "description": "Request object for changing Travel Agent Types.", "properties": { "travelAgentTypes": { "description": "Travel Agent Typesto be changed.", "$ref": "#/definitions/travelAgentTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "genderTypes": { "type": "object", "description": "Response object for fetching Gender Types.", "properties": { "genderTypes": { "description": "Collection of Gender Types.", "$ref": "#/definitions/genderTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "genderTypesType": { "type": "array", "description": "List of Gender Type.", "maxItems": 4000, "items": { "$ref": "#/definitions/genderType" } }, "genderType": { "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" }, "protected": { "description": "Determines whether this code is protected from deleting and making inactive", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "genderTypesCriteria": { "type": "object", "description": "Request object for creating Gender Types.", "properties": { "genderTypes": { "description": "Gender Types to be created.", "$ref": "#/definitions/genderTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "genderTypesToChange": { "type": "object", "description": "Request object for changing Gender Types.", "properties": { "genderTypes": { "description": "Gender Types to be changed.", "$ref": "#/definitions/genderTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestStatusesDetails": { "type": "object", "description": "Response object for fetching Guest Statuses.", "properties": { "guestStatuses": { "description": "Collection of Guest Statuses.", "$ref": "#/definitions/guestStatusesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestStatusesType": { "type": "array", "description": "List of Guest Statuses.", "maxItems": 4000, "items": { "$ref": "#/definitions/guestStatusType" } }, "guestStatusType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "guestStatusesCriteria": { "type": "object", "description": "Request object for creating Guest Statuses.", "properties": { "guestStatuses": { "description": "Guest Statuses to be created.", "$ref": "#/definitions/guestStatusesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestStatusesToBeChanged": { "type": "object", "description": "Request object for changing Guest Statuses.", "properties": { "guestStatuses": { "description": "Guest Statuses to be changed.", "$ref": "#/definitions/guestStatusesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestTitlesDetails": { "type": "object", "description": "Response object for fetching Guest Titles.", "properties": { "guestTitles": { "description": "Collection of Guest Titles.", "$ref": "#/definitions/guestTitlesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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/guestTypeType" } }, "guestTypeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "guestTypesCriteria": { "type": "object", "description": "Request object for creating Guest Types.", "properties": { "guestTypes": { "description": "Guest Types to be created.", "$ref": "#/definitions/guestTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "guestTypesToBeChanged": { "type": "object", "description": "Request object for changing Guest Types.", "properties": { "guestTypes": { "description": "Guest Types to be changed.", "$ref": "#/definitions/guestTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ecertificateLocationTypesDetails": { "type": "object", "description": "Response object for fetching Ecertificate Location Types.", "properties": { "ecertificateLocationTypes": { "description": "Collection of Ecertificate Location Types.", "$ref": "#/definitions/ecertificateLocationTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ecertificateLocationTypesType": { "type": "array", "description": "List of Ecertificate Location Types.", "maxItems": 4000, "items": { "$ref": "#/definitions/ecertificateLocationTypeType" } }, "ecertificateLocationTypeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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": { "ecertificateLocationTypes": { "description": "Ecertificate Location Types to be changed.", "$ref": "#/definitions/ecertificateLocationTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "exclusivePreferences": { "type": "object", "description": "Response object for fetching Exclusive preferences at the property level.", "properties": { "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" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" }, "hotelId": { "description": "Specifies the hotel code for which the Exclusive preference is specified.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "hotelPreferences": { "type": "object", "description": "Response object for fetching preferences at the property level.", "properties": { "hotelPreferences": { "description": "Collection of preferences specified at the property level.", "$ref": "#/definitions/configHotelPreferencesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "configHotelPreferencesType": { "type": "array", "description": "This type holds a collection of preferences at the property level.", "maxItems": 4000, "items": { "$ref": "#/definitions/configHotelPreferenceType" } }, "configHotelPreferenceType": { "type": "object", "description": "Base details common between both template and property level preferences.", "properties": { "description": { "description": "The description about the preference.", "type": "string", "minLength": 0, "maxLength": 2000 }, "code": { "description": "Specifies the preference code.", "type": "string", "minLength": 0, "maxLength": 20 }, "preferenceGroup": { "description": "Specifies the preference group the preference belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "preferenceSubGroup": { "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", "type": "string", "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": "Specifies the hotel code for which the preference is specified.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "identificationTypesDetails": { "type": "object", "description": "Response object for fetching Identification Types.", "properties": { "identificationTypes": { "description": "Collection of Identification Types.", "$ref": "#/definitions/identificationTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "identificationTypesType": { "type": "array", "description": "List of Identification Types.", "maxItems": 4000, "items": { "$ref": "#/definitions/identificationTypeType" } }, "identificationTypeType": { "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" }, "identificationRole": { "description": "Used to store the identification role associated to the identification type. Passport, Driver License, Visa, ID or Unknown are the possible values.", "$ref": "#/definitions/identificationRoleType" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "identificationRoleType": { "type": "string", "description": "Simple type for storing identification roles.", "enum": [ "Passport", "DriverLicense", "Visa", "Id", "Unknown" ] }, "identificationTypesCriteria": { "type": "object", "description": "Request object for creating Identification Types.", "properties": { "identificationTypes": { "description": "Identification Typesto be created.", "$ref": "#/definitions/identificationTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "identificationTypesToBeChanged": { "type": "object", "description": "Request object for changing Identification Types.", "properties": { "identificationTypes": { "description": "Identification Typesto be changed.", "$ref": "#/definitions/identificationTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "immigrationStatusesDetails": { "type": "object", "description": "Response object for fetching Immigration Statuses.", "properties": { "immigrationStatuses": { "description": "Collection of Immigration Statuses.", "$ref": "#/definitions/immigrationStatusesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "immigrationStatusesType": { "type": "array", "description": "List of Immigration Statuses.", "maxItems": 4000, "items": { "$ref": "#/definitions/immigrationStatusType" } }, "immigrationStatusType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "immigrationStatusesCriteria": { "type": "object", "description": "Request object for creating Immigration Statuses.", "properties": { "immigrationStatuses": { "description": "Immigration Statuses to be created.", "$ref": "#/definitions/immigrationStatusesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "immigrationStatusesToBeChanged": { "type": "object", "description": "Request object for changing Immigration Statuses.", "properties": { "immigrationStatuses": { "description": "Immigration Statuses to be changed.", "$ref": "#/definitions/immigrationStatusesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "industryCodesDetails": { "type": "object", "description": "Response object for fetching Industry Codes.", "properties": { "industryCodes": { "description": "Collection of Industry Codes.", "$ref": "#/definitions/industryCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "industryCodesType": { "type": "array", "description": "List of Industry Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/industryCodeType" } }, "industryCodeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "industryCodesCriteria": { "type": "object", "description": "Request object for creating Industry Codes.", "properties": { "industryCodes": { "description": "Industry Codesto be created.", "$ref": "#/definitions/industryCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "industryCodesToBeChanged": { "type": "object", "description": "Request object for changing Industry Codes.", "properties": { "industryCodes": { "description": "Industry Codesto be changed.", "$ref": "#/definitions/industryCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "influenceCodesDetails": { "type": "object", "description": "Response object for fetching Influence Codes.", "properties": { "influenceCodes": { "description": "Collection of Influence Codes.", "$ref": "#/definitions/influenceCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "influenceCodesType": { "type": "array", "description": "List of Influence Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/influenceCodeType" } }, "influenceCodeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "keywordTypesCriteria": { "type": "object", "description": "Request object for creating Keyword Types.", "properties": { "keywordTypes": { "description": "Keyword Typesto be created.", "$ref": "#/definitions/keywordTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "keywordTypesToBeChanged": { "type": "object", "description": "Request object for changing Keyword Types.", "properties": { "keywordTypes": { "description": "Keyword Typesto be changed.", "$ref": "#/definitions/keywordTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "mailingActionCodesDetails": { "type": "object", "description": "Response object for fetching Mailing Action Codes.", "properties": { "mailingActionCodes": { "description": "Collection of Mailing Action Codes.", "$ref": "#/definitions/mailingActionCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "mailingActionCodesType": { "type": "array", "description": "List of Mailing Action Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/mailingActionCodeType" } }, "mailingActionCodeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "mailingActionCodesCriteria": { "type": "object", "description": "Request object for creating Mailing Action Codes.", "properties": { "mailingActionCodes": { "description": "Mailing Action Codes to be created.", "$ref": "#/definitions/mailingActionCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "mailingActionCodesToBeChanged": { "type": "object", "description": "Request object for changing Mailing Action Codes.", "properties": { "mailingActionCodes": { "description": "Mailing Action Codes to be changed.", "$ref": "#/definitions/mailingActionCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipAwardsInfo": { "type": "object", "description": "Response to fetch Membership Awards.", "properties": { "membershipAwards": { "description": "Collection of Membership Awards.", "$ref": "#/definitions/membershipAwardsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipAwardsType": { "type": "array", "description": "Membership Award details.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipAwardType" } }, "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": 20 }, "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" }, "rateDiscountInfo": { "description": "Information related to discount based Award.", "$ref": "#/definitions/membershipAwardRateDiscountInfoType" }, "awardDetails": { "description": "Membership Award Rate/Product/FT/Upgrade records associated with this Award.", "$ref": "#/definitions/membershipAwardDetailsType" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "dateRangeType": { "type": "object", "description": "Date Range with Start and End dates.", "properties": { "start": { "description": "The starting value of the date range.", "type": "string", "format": "date", "maxLength": 8 }, "end": { "description": "The ending value of the date range.", "type": "string", "format": "date", "maxLength": 8 } } }, "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", "Discount" ] }, "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" }, "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" }, "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" } } }, "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": { "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" }, "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" }, "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" } } }, "membershipAwardUpgradeInfoType": { "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" }, "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" }, "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" } } }, "membershipAwardOtherInfoType": { "type": "object", "description": "Information related to Other Award.", "properties": { "pointsRequired": { "description": "Points required to avail/redeem this award.", "type": "number" }, "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 } } }, "membershipAwardFinancialTransactionInfoType": { "type": "object", "description": "Information related to Other Award.", "properties": { "pointsRequired": { "description": "Points required to avail/redeem this award.", "type": "number" }, "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" } } }, "membershipAwardDetailsType": { "type": "array", "description": "Membership Award Rate details.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipAwardDetailType" } }, "membershipAwardDetailType": { "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 }, "hotelId": { "description": "Hotel code to which the record belongs.", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Membership Award Detail Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "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" }, "inactive": { "description": "Inactive flag for Membership Award detail (Rate/Product/upgrade).", "type": "boolean" }, "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", "minLength": 0, "maxLength": 20 }, "fromRoomGroup": { "description": "Upgrade from Room Group.", "type": "string", "minLength": 0, "maxLength": 20 }, "toRoomGroup": { "description": "Upgrade to Room Group.", "type": "string", "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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/membershipBenefitProgramType" } }, "membershipBenefitProgramType": { "type": "object", "description": "Type that holds key values, that uniquely identifies a membership benefit program", "properties": { "membershipType": { "description": "Membership type", "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "description": "Benefit Code", "type": "string", "minLength": 0, "maxLength": 40 }, "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", "minLength": 0, "maxLength": 20 }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "links": { "$ref": "#/definitions/links" }, "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" }, "links": { "$ref": "#/definitions/links" }, "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", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" } } }, "membershipClaimOriginsToBeChanged": { "type": "object", "description": "Request object for changing Membership Claim Origins.", "properties": { "membershipClaimOrigins": { "description": "Membership Claim Origins to be changed.", "$ref": "#/definitions/membershipClaimOriginsType" }, "links": { "$ref": "#/definitions/links" }, "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" }, "links": { "$ref": "#/definitions/links" }, "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", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "membershipClaimTypesCriteria": { "type": "object", "description": "Request object for creating Membership Claim Types.", "properties": { "membershipClaimTypes": { "description": "Membership Claim Types to be created.", "$ref": "#/definitions/membershipClaimTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipClaimTypesToBeChanged": { "type": "object", "description": "Request object for changing Membership Claim Types.", "properties": { "membershipClaimTypes": { "description": "Membership Claim Types to be changed.", "$ref": "#/definitions/membershipClaimTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipClassesInfo": { "type": "object", "description": "Response object for fetching Membership Class.", "properties": { "membershipClasses": { "description": "Collection of Membership Classes.", "$ref": "#/definitions/membershipClassesType" }, "links": { "$ref": "#/definitions/links" }, "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", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Membership Market/Property Groups display sequence Number", "type": "number" }, "loyaltyProgram": { "description": "This flag indicates whether the membership class is eligible for loyalty program or not.", "type": "boolean" }, "frequentFlyer": { "description": "This flag indicates whether the membership class is eligible for frequent flyer or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "membershipClasses": { "type": "object", "description": "Request object for changing Membership Class.", "properties": { "membershipClasses": { "description": "Details of the Membership Classes to be edited.", "$ref": "#/definitions/membershipClassesType" }, "links": { "$ref": "#/definitions/links" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "membershipEnrollmentCodesCriteria": { "type": "object", "description": "Request object for creating Membership Enrollment Codes.", "properties": { "membershipEnrollmentCodes": { "description": "Membership Enrollment Codes to be created.", "$ref": "#/definitions/membershipEnrollmentCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipEnrollmentGroupsType": { "type": "array", "description": "Details of membership enrollment group type.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipEnrollmentGroupType" } }, "membershipEnrollmentGroupType": { "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", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipFolioTexts": { "type": "object", "description": "Collection of FolioTexts to be inserted at MembershipLevel.", "properties": { "membershipFolioTexts": { "type": "array", "items": { "$ref": "#/definitions/membershipFolioTextsType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipFolioTextsType": { "type": "object", "description": "A type which is used to insert Membership FolioTexts.", "properties": { "membershipType": { "description": "Membership Type code.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipLevel": { "description": "Membership Level code.", "type": "string", "minLength": 0, "maxLength": 20 }, "folioTexts": { "description": "Folio Texts.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelFolioTextsType" } } } }, "hotelFolioTextsType": { "type": "array", "description": "Collection of hotel folio texts", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelFolioTextType" } }, "hotelFolioTextType": { "type": "object", "description": "Folio text", "properties": { "folioText1": { "type": "string", "minLength": 0, "maxLength": 400 }, "folioText2": { "type": "string", "minLength": 0, "maxLength": 400 }, "folioText3": { "type": "string", "minLength": 0, "maxLength": 400 }, "folioText4": { "type": "string", "minLength": 0, "maxLength": 400 }, "hotelId": { "description": "Signifies folio text for a specific hotel.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "membershipLevelsInfo": { "type": "object", "description": "Response object for fetching membership levels.", "properties": { "membershipLevels": { "description": "Collection of membership levels.", "$ref": "#/definitions/membershipLevelsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipLevelsType": { "type": "array", "description": "Collection of membership levels", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipLevelType" } }, "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": "Membership level", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership level.", "type": "string", "minLength": 0, "maxLength": 2000 }, "label": { "description": "Label of the Membership level.", "type": "string", "minLength": 0, "maxLength": 40 }, "rank": { "description": "Rank of Membership level.", "type": "number" }, "vip": { "description": "VIP level associated to the Membership level.", "type": "string", "minLength": 0, "maxLength": 20 }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "colorType": { "type": "string", "description": "Color configuration type. This color configuration provides a visual category of entities.", "enum": [ "Red", "DarkRed", "Green", "DarkGreen", "LightGreen", "Orange", "White", "Yellow", "DarkYellow", "Purple", "Brown", "Gray", "Aqua", "Chocolate", "Blue", "LightBlue", "DarkBlue", "Cyan", "DarkCyan", "Magenta", "DarkMagenta", "Black", "Deepteal", "Sunsetorange", "Aquasky", "Mochabrown", "Mossgreen", "Rosewood", "Claybrown", "Softlavender", "Olivegold", "Plumpurple", "Mistblue", "Forestgreen", "Dustyviolet", "Oceanblue", "Copper" ] }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipMarketGroupsType": { "type": "array", "description": "Details for Membership Market Group along with associated Market codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipMarketGroupType" } }, "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", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Membership Market/Property Groups display sequence Number", "type": "number" }, "marketCodes": { "description": "Collection of Market codes which associated for a Membership Market Group.", "$ref": "#/definitions/membershipMarketCodesType" }, "managedBy" : { "$ref" : "#/definitions/managedByOptions" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipPropertyGroupsType": { "type": "array", "description": "Details for Membership Property Group along with associated property codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipPropertyGroupType" } }, "membershipPropertyGroupType": { "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", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "membershipPropertyCodesType": { "type": "array", "description": "Membership Property code and Description.", "maxItems": 4000, "items": { "$ref": "#/definitions/codeDescriptionType" } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipRateGroupsType": { "type": "array", "description": "Details for Membership Rate Group.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipRateGroupType" } }, "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", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Membership Market/Property Groups display sequence Number", "type": "number" }, "rateCodes": { "description": "Collection of Rate codes associated with this Rate Group.", "$ref": "#/definitions/membershipRateCodesType" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipStatusCodesDetails": { "type": "object", "description": "Response object for fetching Membership Status Codes.", "properties": { "membershipStatusCodes": { "description": "Collection of Membership Status Codes.", "$ref": "#/definitions/membershipStatusCodesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipStatusCodesType": { "type": "array", "description": "List of Membership Status Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipStatusCodeType" } }, "membershipStatusCodeType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" } } }, "membershipTypeRulesSummariesType": { "type": "array", "description": "List of Membership type rules summary information.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipTypeRuleSummaryType" } }, "membershipTypeRuleSummaryType": { "type": "object", "description": "Membership Type rule summary information.", "properties": { "membershipTypeRulePrimaryDetails": { "description": "Membership type rule primary information.", "$ref": "#/definitions/membershipTypeRulePrimaryDetailsType" }, "ruleCode": { "description": "Rule code of the membership type rule.", "type": "string", "minLength": 0, "maxLength": 20 }, "programType": { "description": "Program(Points/Tier) type of the rule.", "$ref": "#/definitions/membershipTypeRuleType" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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 rule.", "type": "string", "minLength": 0, "maxLength": 2000 }, "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" }, "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" } } }, "membershipTypeRuleIDType": { "type": "object", "description": "Membership type rule ID.", "properties": { "membershipType": { "description": "Membership type of the Rule.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipPointsSequence": { "description": "Sequence number of the membership type rule.", "type": "integer" } } }, "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", "EnrollmentReferral" ] }, "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, Points is the only valid value for non primary membership 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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipTypeRuleDetailsType": { "type": "array", "description": "Collection of Membership type rule details.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipTypeRuleDetailType" } }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "membershipTypeRuleDefinitionType": { "type": "object", "description": "Membership Type Rule definition details.", "properties": { "ruleCode": { "description": "Rule code of the membership type rule.", "type": "string", "minLength": 0, "maxLength": 20 }, "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" }, "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 } } }, "ruleAppliesOnType": { "type": "string", "description": "Applies on restricted dates.", "enum": [ "Arrival", "Departure", "Any", "Restricted" ] }, "membershipTypeRulePointsDefinitionType": { "type": "object", "description": "Membership Program Rule points details.", "properties": { "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" }, "costPerPoint": { "description": "Indicates the cost per point for this membership program.", "type": "integer" }, "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" } } }, "pointsRoundingFlagType": { "type": "string", "description": "This flag tells if the total points computed will be rounded based on the rounding option selected.", "enum": [ "Round", "Ceil", "Floor", "Roundupnd", "Rounddownnd", "Universalroundnd" ] }, "membershipTypeRuleConditionsType": { "type": "object", "description": "Membership Type Rule Conditions.", "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" }, "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" } } }, "membershipTypeRuleGeneralConditionsType": { "type": "object", "description": "Membership Type Rules general Conditions.", "properties": { "reservationChannel": { "description": "Reservation Channel for which the rule is applied. This attribute is deprecated would not be used further.", "type": "string", "minLength": 0, "maxLength": 20 }, "property": { "description": "Property for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "propertyGroup": { "description": "Property group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "enrollmentCode": { "description": "Enrollment Code for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "enrollmentGroup": { "description": "Enrollment Group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "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 }, "originCode": { "description": "Origin Code for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "originGroup": { "description": "Origin group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "excludeOriginGroup": { "description": "To specify the exclusion of origin group while applying rule.", "type": "boolean" } } }, "membershipTypeRuleRateConditionsType": { "type": "object", "description": "Membership Type Rules rate Conditions.", "properties": { "rateCode": { "description": "Rate code for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "rateGroup": { "description": "Rate group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "revenueGroup": { "description": "Revenue group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "averageRateAmount": { "description": "Average rate amount of the reservations for which rule will be applied.", "type": "number" }, "minimumRevenue": { "description": "Minimum revenue on which rule will be applied.", "type": "number" }, "transactionGroup": { "description": "Transaction group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "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" } } }, "membershipTypeRuleRoomConditionsType": { "type": "object", "description": "Membership Type Rules room conditions.", "properties": { "roomType": { "description": "Room type/label for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomGroup": { "description": "Membership room group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "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" } } }, "membershipTypeRuleSegmentationConditionsType": { "type": "object", "description": "Membership Type Rules segmentation conditions.", "properties": { "marketCode": { "description": "Market Code for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "marketGroup": { "description": "Market group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "excludeMarketGroup": { "description": "To specify the exclusion of market group while applying rule.", "type": "boolean" }, "sourceCode": { "description": "Source Code for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "sourceGroup": { "description": "Source group for which the rule is applied.", "type": "string", "minLength": 0, "maxLength": 20 }, "excludeSourceGroup": { "description": "To specify the exclusion of source group while applying rule.", "type": "boolean" } } }, "membershipTypeRuleReservationConditionsType": { "type": "object", "description": "Membership Type Rules reservation conditions.", "properties": { "reservationStartDate": { "description": "Reservations with start date for which the rule is applied.", "type": "string", "format": "date", "maxLength": 8 }, "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" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipTypeRulesIDType": { "type": "array", "description": "List of membership type rule ID's.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipTypeRuleIDType" } }, "membershipTypeRule": { "type": "object", "description": "Response object for fetching membership type rule.", "properties": { "membershipTypeRule": { "description": "Membership type rule detailed information.", "$ref": "#/definitions/membershipTypeRuleDetailType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipTypes": { "type": "object", "description": "Response object for fetching Membership Types.", "properties": { "membershipTypes": { "description": "Collection of Membership types fetched.", "$ref": "#/definitions/membershipTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipTypesType": { "type": "array", "description": "Membership Type", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipTypeType" } }, "membershipTypeType": { "type": "object", "description": "A representation of the information contained by a membership type.", "properties": { "membershipType": { "description": "Membership Type code.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipClass": { "description": "Membership Class code.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the membership type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "pointsLabel": { "description": "Label used to refer to points for this membership type", "type": "string", "minLength": 0, "maxLength": 20 }, "hasPointCalculationRule": { "description": "Indicates if this membership type has a point calculation rule.", "type": "boolean" }, "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" }, "cardNumberAutoGenerateDetailsForOWS": { "description": "Membership auto card number generation details for OWS.", "$ref": "#/definitions/autoGenerateCardNumberType" }, "currency": { "description": "The currency in which user would like to calculate the membership points.", "type": "string", "minLength": 0, "maxLength": 20 }, "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", "minLength": 0, "maxLength": 20 }, "pointCost": { "description": "The cost per point.", "type": "string", "minLength": 1, "maxLength": 5 }, "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" }, "excludeProfileFromPurge": { "description": "Indicates exclude profiles with an active membership of this type from the automatic purge utility.", "type": "boolean" }, "allowShares": { "description": "Indicates that the award points to each membership holder attached to the shared reservation.", "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.", "type": "boolean" }, "multiplier": { "description": "Allows the user to input a value by which the base number of points is multiplied.", "type": "boolean" }, "centralSetup": { "description": "Indicates how the award points for this membership type will be managed.", "type": "boolean" }, "isLoyaltyProgram": { "description": "This flag indicates whether the membership class attached to the membership type is eligible for loyalty program or not.", "type": "boolean" }, "enrollmentCodeRequiredYn": { "description": "Indicates whether enrollment code is required or not.", "type": "boolean" }, "bookerProgramYn": { "description": "Indicates the membership type is for a Booker.", "type": "boolean" }, "companyYn": { "description": "Add the booker membership to company profile type.", "type": "boolean" }, "travelAgentYn": { "description": "Add the booker membership to travel agent profile type.", "type": "boolean" }, "sourceYn": { "description": "Add the booker membership to source profile type.", "type": "boolean" }, "groupYn": { "description": "Add the booker membership to group profile type.", "type": "boolean" }, "contactYn": { "description": "Add the booker membership to contact profile type.", "type": "boolean" }, "externallyControlled": { "description": "Flag that affects how a Membership Type is added, edited or deleted from a profile.", "type": "boolean" }, "enrollmentAddressAllowed": { "description": "Flag that indicates Profile Address is editable during Enrollment.", "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" }, "enrollmentBirthdateAllowed": { "description": "Flag that indicates Birthdate field is editable during Enrollment.", "type": "boolean" }, "reIssueNewCard": { "description": "Indicates whether to re-issue the membership card or not, when it is lost / stolen.", "type": "boolean" }, "primaryMembership": { "description": "Indicates whether primary membership or not.", "type": "boolean" }, "printFolioMsgOnConfirmation": { "description": "Print Folio Message on confirmation.", "type": "boolean" }, "externalDatabase": { "description": "Indicates database for external system for Membership Type.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "cardNumberDetailsType": { "type": "object", "description": "Card Number of membership type.", "properties": { "membershipCardValidationRule": { "description": "ValidationRules for credit card.", "$ref": "#/definitions/membershipCardValidationRuleType" }, "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" }, "database": { "description": "Indicates External System from which card number will be generated.", "type": "string", "minLength": 0, "maxLength": 20 }, "allowDuplicateCardNumbers": { "description": "Indicates if the multiple membership cards may be issued with the same membership number.", "type": "boolean" }, "expirationDateRequired": { "description": "Indicates if the membership expiration date is required for validation of the profile membership information.", "type": "boolean" }, "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" }, "validationByInterface": { "description": "Indicates is the membership card is validated through the interface.", "type": "boolean" } } }, "membershipCardValidationRuleType": { "type": "object", "description": "Payment method card validation rules.", "properties": { "length": { "description": "Valid lengths of card number.", "type": "string", "minLength": 0, "maxLength": 50 }, "prefix": { "description": "Valid card number prefix.", "type": "string", "minLength": 0, "maxLength": 20 }, "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", "minLength": 0, "maxLength": 2000 }, "rule": { "description": "Defines rules to be used for membership card validation.", "$ref": "#/definitions/membershipCardValidationRuleTypeType" } } }, "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": { "from": { "description": "Starting range of the card.", "type": "string", "minLength": 0, "maxLength": 50 }, "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", "minLength": 0, "maxLength": 80 }, "cardRangeEnd": { "description": "Card number auto generation range.", "type": "string", "minLength": 0, "maxLength": 80 }, "cardNumberPrefix": { "description": "Valid card number prefix.", "type": "string", "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 } } }, "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": { "nonMemberPoints": { "description": "Indicates if points will be displayed for guests who are not members.", "type": "boolean" }, "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" }, "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. If no value is provided it will be defaulted to 1 year.", "$ref": "#/definitions/numberOfYearsType" }, "expiryMonth": { "description": "Month of Expiry for Calendar", "type": "string", "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" }, "referralPeriod": { "description": "Number of days from new member's join date when referral can be added.", "type": "integer" } } }, "calendarPeriodType": { "type": "string", "description": "12 month period based on starting month.", "enum": [ "Calendar", "Rolling" ] }, "numberOfYearsType": { "type": "string", "description": "Five Year period", "enum": [ "One", "Two", "Three", "Four", "Five" ] }, "awardPointsValidityDurationType": { "type": "string", "description": "Five Year period", "enum": [ "DoNotExpire", "SameYear", "OneYear", "TwoYears", "ThreeYears", "FourYears", "FiveYears" ] }, "calendarGracePeriodType": { "type": "string", "description": "Five Year period", "enum": [ "NoGracePeriod", "OneYear", "TwoYears", "ThreeYears", "FourYears", "FiveYears" ] }, "awardsExceptionCriteriaType": { "type": "object", "description": "Criteria for detecting exceptions in points calculation", "properties": { "multipleRooms": { "description": "Enter the number of multiple rooms that should be flagged as an exception for same stay dates.", "type": "integer" }, "bBSingleProperty": { "description": "Back to Back stay at a Single Property", "type": "boolean" }, "bBSingleGroup": { "description": "Back to back stay at a Single Group", "type": "boolean" }, "bBCrossMembership": { "description": "Cross Membership Back to Back Stays", "type": "boolean" }, "externalProcessingException": { "description": "Number of days while awaiting an external accept/reject response file.", "type": "integer" } } }, "tierPointsType": { "type": "object", "description": "Base parent type for membership points comprising common elements between award points and tier points.", "properties": { "nonMemberPoints": { "description": "Indicates if points will be displayed for guests who are not members.", "type": "boolean" }, "basedOn": { "description": "Date on which the tier management is based.", "$ref": "#/definitions/pointsCalculationDateType" }, "tierExpirationMonth": { "description": "Month for Upgrade/Downgrade in a Calendar Period.", "type": "string", "minLength": 0, "maxLength": 10 }, "requalifyOnUpgrade": { "description": "Requalify on Upgrade", "type": "boolean" }, "downgradeRenewalInAutoJob": { "description": "Downgrade/Renew the membership level automatically.", "type": "boolean" }, "upgradePeriodRolling": { "description": "Upgrade period of points for Rolling period.", "$ref": "#/definitions/numberOfYearsType" }, "downgradePeriodRolling": { "description": "Downgrade period of points for Rolling period.", "$ref": "#/definitions/numberOfYearsType" }, "upgradePeriodCalendar": { "description": "Upgrade period of points for Calendar period.", "$ref": "#/definitions/upgradeDowngradeForCalendarPeriodType" }, "downgradePeriodCalendar": { "description": "Downgrade period of points for Calendar period.", "$ref": "#/definitions/upgradeDowngradeForCalendarPeriodType" }, "enableTierManagementReset": { "description": "TMR (Tier Management Reset) Level Rules configuration enabled or not.", "type": "boolean" } } }, "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", "minLength": 0, "maxLength": 80 }, "adhocStatement": { "description": "Default membership statement to be sent ad hoc.", "type": "string", "minLength": 0, "maxLength": 80 }, "batchStatement": { "description": "Batch process statement.", "type": "string", "minLength": 0, "maxLength": 80 }, "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 (if applicable).", "type": "string", "minLength": 0, "maxLength": 20 }, "externalPointsAndRedemptionDatabase": { "description": "Indicates database for external points & redemption system (if applicable).", "type": "string", "minLength": 0, "maxLength": 20 }, "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" }, "fulfillment": { "description": "True if you wish to be able to select this membership type when creating an export file for fulfillment.", "type": "boolean" }, "allowCardNumberOverride": { "description": "Indicates whether to perform profile merge or not.", "type": "boolean" }, "enrollmentCodeRequired": { "description": "Indicates whether Enrollment Code required of not.", "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", "minLength": 0, "maxLength": 40 }, "defaultMembershipStatus": { "description": "Represents Membership status.This status will be assigned to Guest's profile with membership type.", "type": "string", "minLength": 0, "maxLength": 40 }, "nameProtected": { "description": "Prevent profile name change.", "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" }, "nameOnCardFromAltName": { "description": "Membership card name using the alternate name.", "type": "boolean" }, "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 }, "userDefinedEnrollmentFields": { "description": "User Defined Enrollment fields/Attributes for membership type.", "$ref": "#/definitions/userDefinedEnrollmentFieldsType" }, "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" } } }, "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": { "fieldName": { "description": "Name of the Field/Attribute such as comunication, birthdate etc.", "$ref": "#/definitions/userDefinedEnrollmentFieldNameType" }, "fieldType": { "description": "Type of the Field/Attribute such as phone, fax, email etc.", "type": "string", "minLength": 0, "maxLength": 2000 }, "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": { "type": "object", "description": "Response object for fetching Membership Type.", "properties": { "membershipTypes": { "description": "List of Membership types fetched.", "$ref": "#/definitions/membershipTypesType" }, "masterInfoList": { "description": "Refer to Generic common types document.", "type": "array", "items": { "$ref": "#/definitions/masterInfoType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "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": { "type": "object", "description": "Response object for fetching Nationalities.", "properties": { "nationalities": { "description": "Collection of Nationalities.", "$ref": "#/definitions/nationalitiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "nationalitiesType": { "type": "array", "description": "List of Nationalities.", "maxItems": 4000, "items": { "$ref": "#/definitions/nationalityType" } }, "nationalityType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "nationalitiesCriteria": { "type": "object", "description": "Request object for creating Nationalities.", "properties": { "nationalities": { "description": "Nationalities to be created.", "$ref": "#/definitions/nationalitiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "nationalitiesToBeChanged": { "type": "object", "description": "Request object for changing Nationalities.", "properties": { "nationalities": { "description": "Nationalities to be changed.", "$ref": "#/definitions/nationalitiesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ownerTeamsDetails": { "type": "object", "description": "Response object for fetching Owner Teams.", "properties": { "ownerTeams": { "description": "Collection of Owner Teams.", "$ref": "#/definitions/ownerTeamsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ownerTeamsType": { "type": "array", "description": "List of Owner Teams.", "maxItems": 4000, "items": { "$ref": "#/definitions/ownerTeamType" } }, "ownerTeamType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "ownerTeamsCriteria": { "type": "object", "description": "Request object for creating Owner Teams.", "properties": { "ownerTeams": { "description": "Owner Teamsto be created.", "$ref": "#/definitions/ownerTeamsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "ownerTeamsToBeChanged": { "type": "object", "description": "Request object for changing Owner Teams.", "properties": { "ownerTeams": { "description": "Owner Teamsto be changed.", "$ref": "#/definitions/ownerTeamsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "payDaysDetails": { "type": "object", "description": "Response object for fetching Pay Days.", "properties": { "payDays": { "description": "Collection of Pay Days.", "$ref": "#/definitions/payDaysType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "payDaysType": { "type": "array", "description": "List of Pay Days.", "maxItems": 4000, "items": { "$ref": "#/definitions/payDayType" } }, "payDayType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "To configure the different pay days.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "payDaysCriteria": { "type": "object", "description": "Request object for creating Pay Days.", "properties": { "payDays": { "description": "Pay Daysto be created.", "$ref": "#/definitions/payDaysType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" } } }, "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" } } }, "preferenceGroupsType": { "type": "array", "description": "Collection of preference groups.", "maxItems": 4000, "items": { "$ref": "#/definitions/preferenceGroupType" } }, "preferenceGroupType": { "type": "object", "description": "Preference group identification details.", "properties": { "code": { "description": "Code identifying the preference group.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the preference group.", "type": "string", "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" }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "configTemplatePreferencesType": { "type": "array", "description": "This type holds a collection of preferences at the template level.", "maxItems": 4000, "items": { "$ref": "#/definitions/configTemplatePreferenceType" } }, "configTemplatePreferenceType": { "type": "object", "description": "Base details common between both template and property level preferences.", "properties": { "description": { "description": "The description about the preference.", "type": "string", "minLength": 0, "maxLength": 2000 }, "code": { "description": "Specifies the preference code.", "type": "string", "minLength": 0, "maxLength": 20 }, "preferenceGroup": { "description": "Specifies the preference group the preference belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "preferenceSubGroup": { "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", "type": "string", "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "preferencesCopy": { "type": "object", "description": "Request object for copying template preferences to hotel(s).", "properties": { "copyInstructions": { "description": "List of the template preferences to be copied to hotel(s).", "$ref": "#/definitions/configCopyPreferencesType" }, "links": { "$ref": "#/definitions/links" }, "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" }, "templatePreferences": { "description": "Template preference to be copied to the hotel(s).", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/configTemplatePreferenceIDType" } } } }, "configTemplatePreferenceIDType": { "type": "object", "description": "Base details common between both template and property level preference ids.", "properties": { "code": { "description": "Specifies the preference code.", "type": "string", "minLength": 0, "maxLength": 20 }, "preferenceGroup": { "description": "Specifies the preference group the preference belongs to.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "profileInactiveReasonsDetails": { "type": "object", "description": "Response object for fetching Profile Inactive Reasons.", "properties": { "profileInactiveReasons": { "description": "Collection of Profile Inactive Reasons.", "$ref": "#/definitions/profileInactiveReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileInactiveReasonsType": { "type": "array", "description": "List of Profile Inactive Reasons.", "maxItems": 4000, "items": { "$ref": "#/definitions/profileInactiveReasonType" } }, "profileInactiveReasonType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "profileInactiveReasonsCriteria": { "type": "object", "description": "Request object for creating Profile Inactive Reasons.", "properties": { "profileInactiveReasons": { "description": "Profile Inactive Reasonsto be created.", "$ref": "#/definitions/profileInactiveReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileInactiveReasonsToBeChanged": { "type": "object", "description": "Request object for changing Profile Inactive Reasons.", "properties": { "profileInactiveReasons": { "description": "Profile Inactive Reasonsto be changed.", "$ref": "#/definitions/profileInactiveReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileNameValidations": { "type": "object", "description": "Response for fetching Profile names.", "properties": { "profileNames": { "description": "Collection of Profile names.", "$ref": "#/definitions/profileNameValidationsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileNameValidationsType": { "type": "array", "description": "List of the Profile name to be configured or fetched.", "maxItems": 4000, "items": { "$ref": "#/definitions/profileNameValidationType" } }, "profileNameValidationType": { "type": "object", "description": "Provides information about the Profile Names.", "properties": { "type": { "description": "Type of the Profile.", "$ref": "#/definitions/profileNameValidationTypeType" }, "name": { "description": "Name of the Profile.", "type": "string", "minLength": 0, "maxLength": 80 }, "managedBy" : { "$ref": "#/definitions/managedByOptions" } } }, "profileNameValidationTypeType": { "type": "string", "description": "Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source.", "enum": [ "Company", "TravelAgent", "Source" ] }, "profileNameValidationsToChange": { "type": "object", "description": "Request object to edit Profile names.", "properties": { "profileNames": { "description": "Details of the Profile names to edit.", "$ref": "#/definitions/profileNameValidationEditType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileNameValidationEditType": { "type": "object", "description": "Provides information about the Profile Names.", "properties": { "type": { "description": "Type of the Profile.", "$ref": "#/definitions/profileNameValidationTypeType" }, "name": { "description": "Name of the Profile.", "type": "string", "minLength": 0, "maxLength": 80 }, "newProfileName": { "description": "List of new values for Profile Name and Type .", "$ref": "#/definitions/profileNameValidationType" } } }, "profileRestrictionReasonsDetails": { "type": "object", "description": "Response object for fetching Profile Restriction Reasons.", "properties": { "profileRestrictionReasons": { "description": "Collection of Profile Restriction Reasons.", "$ref": "#/definitions/profileRestrictionReasonsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileRestrictionReasonsType": { "type": "array", "description": "List of Profile Restriction Reasons.", "maxItems": 4000, "items": { "$ref": "#/definitions/profileRestrictionReasonType" } }, "profileRestrictionReasonType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileLinks": { "type": "object", "description": "Response object for fetch profile links", "properties": { "profileLinks": { "$ref": "#/definitions/profileLinksType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileLinksType": { "type": "array", "description": "Holds the collection of profile link objects", "maxItems": 4000, "items": { "$ref": "#/definitions/profileLinkType" } }, "profileLinkType": { "type": "object", "description": "ProfileLinksType for create, change and delete", "properties": { "fromType": { "description": "From type to process", "type": "string", "minLength": 0, "maxLength": 20 }, "toType": { "description": "To type to process", "type": "string", "minLength": 0, "maxLength": 20 }, "fromCode": { "description": "From code to process", "type": "string", "minLength": 0, "maxLength": 20 }, "toCode": { "description": "To code to process", "type": "string", "minLength": 0, "maxLength": 20 }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "profileLinkInheritRates": { "type": "string", "description": "Simple type for inherit rates", "enum": [ "From", "To" ] }, "sourcesDetails": { "type": "object", "description": "Response object for fetching Sources.", "properties": { "sources": { "description": "Collection of Sources.", "$ref": "#/definitions/sourcesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "sourcesType": { "type": "array", "description": "List of Sources.", "maxItems": 4000, "items": { "$ref": "#/definitions/sourceType" } }, "sourceType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "sourcesCriteria": { "type": "object", "description": "Request object for creating Sources.", "properties": { "sources": { "description": "Sourcesto be created.", "$ref": "#/definitions/sourcesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "sourcesToBeChanged": { "type": "object", "description": "Request object for changing Sources.", "properties": { "sources": { "description": "Sourcesto be changed.", "$ref": "#/definitions/sourcesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "statesType": { "type": "array", "description": "Lists of states.", "maxItems": 4000, "items": { "$ref": "#/definitions/stateType" } }, "stateType": { "type": "object", "description": "Information about the country state.", "properties": { "countryCode": { "description": "The country which the state belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "stateCode": { "description": "The code of the state.", "type": "string", "minLength": 0, "maxLength": 20 }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "territoriesDetails": { "type": "object", "description": "Response object for fetching Territories.", "properties": { "territories": { "description": "Collection of Territories.", "$ref": "#/definitions/territoriesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "territoriesType": { "type": "array", "description": "List of Territories.", "maxItems": 4000, "items": { "$ref": "#/definitions/territoryType" } }, "territoryType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "territoriesCriteria": { "type": "object", "description": "Request object for creating Territories.", "properties": { "territories": { "description": "Territoriesto be created.", "$ref": "#/definitions/territoriesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "territoriesToBeChanged": { "type": "object", "description": "Request object for changing Territories.", "properties": { "territories": { "description": "Territoriesto be changed.", "$ref": "#/definitions/territoriesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "titlesDetails": { "type": "object", "description": "Response object for fetching Titles.", "properties": { "titles": { "description": "Collection of Titles.", "$ref": "#/definitions/titlesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "titlesType": { "type": "array", "description": "List of Titles.", "maxItems": 4000, "items": { "$ref": "#/definitions/titleType" } }, "titleType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "titlesCriteria": { "type": "object", "description": "Request object for creating Titles.", "properties": { "titles": { "description": "Titlesto be created.", "$ref": "#/definitions/titlesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "titlesToBeChanged": { "type": "object", "description": "Request object for changing Titles.", "properties": { "titles": { "description": "Titlesto be changed.", "$ref": "#/definitions/titlesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "vIPLevelsDetails": { "type": "object", "description": "Response object for fetching V I P Levels.", "properties": { "vIPLevels": { "description": "Collection of V I P Levels.", "$ref": "#/definitions/vIPLevelsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "vIPLevelsType": { "type": "array", "description": "List of V I P Levels.", "maxItems": 4000, "items": { "$ref": "#/definitions/vIPLevelType" } }, "vIPLevelType": { "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" }, "displayColor": { "description": "Determines the color of this code.", "$ref": "#/definitions/commonMasterColorType" }, "ranking": { "description": "AI priority order of this code.", "type": "integer" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "commonMasterColorType": { "type": "string", "description": "Simple type enumeration for Common Master Colors.", "enum": [ "None", "Blue", "Red", "Cyan", "Green", "Black", "White", "Yellow", "Gray", "Deepteal", "Sunsetorange", "Aquasky", "Mochabrown", "Mossgreen", "Rosewood", "Claybrown", "Softlavender", "Olivegold", "Plumpurple", "Mistblue", "Forestgreen", "Dustyviolet", "Oceanblue", "Copper" ] }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipRatesType": { "type": "array", "description": "Membership Rate summary information.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipRateType" } }, "membershipRateType": { "type": "object", "description": "Membership Rate summary information.", "properties": { "hotelId": { "description": "Membership Rate hotel code.", "type": "string", "minLength": 0, "maxLength": 20 }, "ruleCode": { "description": "Membership Rate rule code.", "type": "string", "minLength": 0, "maxLength": 20 }, "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" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "rateRuleMembershipsType": { "type": "array", "description": "Rate rule membership type details.", "maxItems": 4000, "items": { "$ref": "#/definitions/rateRuleMembershipType" } }, "rateRuleMembershipType": { "type": "object", "description": "Rate Rule Membership types.", "properties": { "membershipType": { "description": "Rate rule membership type.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipLevel": { "description": "Rate rule membership levels.", "$ref": "#/definitions/codeListType" } } }, "membershipRatesInfo": { "type": "object", "description": "Response object for fetching membership rates.", "properties": { "membershipRates": { "description": "Collection of membership rates summary.", "$ref": "#/definitions/membershipRatesType" }, "links": { "$ref": "#/definitions/links" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "identificationCountriesType": { "type": "array", "description": "List of Identification Countries.", "maxItems": 4000, "items": { "$ref": "#/definitions/identificationCountryType" } }, "identificationCountryType": { "type": "object", "description": "Contains Common Master configuration detail.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "identificationCountriesDetails": { "type": "object", "description": "Response object for fetching Identification Countries.", "properties": { "identificationCountries": { "description": "Collection of Identification Countries.", "$ref": "#/definitions/identificationCountriesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "identificationCountriesCriteria": { "type": "object", "description": "Request object for creating Identification Countries.", "properties": { "identificationCountries": { "description": "Identification Countriesto be created.", "$ref": "#/definitions/identificationCountriesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "identificationCountriesToBeChanged": { "type": "object", "description": "Request object for changing Identification Countries.", "properties": { "identificationCountries": { "description": "Identification Countriesto be changed.", "$ref": "#/definitions/identificationCountriesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "managedByOptions": { "description": "Describes of the Configuration is Managed by Enterprise or Property.", "type": "string", "enum": [ "EnterpriseManaged", "PropertyManaged", "EnterpriseEnforced", "PropertyOverridden" ] }, "membershipOriginGroupsDetails": { "type": "object", "description": "Response object for fetching Membership Origin Groups configurations.", "properties": { "membershipOriginGroups": { "type": "array", "maxItems": 4000, "description": "Collection of Membership Origin Groups configurations.", "items": { "$ref": "#/definitions/membershipOriginGroupType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipOriginGroupDetails": { "type": "object", "description": "Request object for adding/changing existing Membership Origin Group Configurations.", "properties": { "membershipOriginGroup": { "description": "Membership Origin Groups Configurations to be changed.", "$ref": "#/definitions/membershipOriginGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipOriginGroupType": { "type": "object", "description": "Details for Membership Origin Group along with associated Origin codes.", "properties": { "code": { "description": "Code is used to identify a Membership Origin Group.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Origin Group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Membership Origin Groups display sequence Number", "type": "number" }, "originCodes": { "type": "array", "description": "Membership Origin code and Description.", "maxItems": 4000, "items": { "$ref": "#/definitions/codeDescriptionType" } }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "membershipSourceGroupsDetails": { "type": "object", "description": "Response object for fetching Membership Source Groups configurations.", "properties": { "membershipSourceGroups": { "type": "array", "maxItems": 4000, "description": "Collection of Membership Source Groups configurations.", "items": { "$ref": "#/definitions/membershipSourceGroupType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipSourceGroupDetails": { "type": "object", "description": "Request object for adding/changing existing Membership Source Group Configurations.", "properties": { "membershipSourceGroup": { "description": "Membership Source Groups Configurations to be changed.", "$ref": "#/definitions/membershipSourceGroupType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipSourceGroupType": { "type": "object", "description": "Details for Membership Source Group along with associated Source codes.", "properties": { "code": { "description": "Code is used to identify a Membership Source Group.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Source Group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Membership Source Groups display sequence Number", "type": "number" }, "sourceCodes": { "type": "array", "description": "Membership Source code and Description.", "maxItems": 4000, "items": { "$ref": "#/definitions/codeDescriptionType" } }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "operaVersionNumberType": { "type": "string", "description": "Current Opera Version Number", "minLength": 0, "maxLength": 40 }, "operaVersion": { "type": "object", "description": "Response for Ping operation.", "properties": { "operaVersion": { "description": "Opera version number.", "$ref": "#/definitions/operaVersionNumberType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipAwardRateDiscountInfoType": { "type": "object", "description": "Membership Award Rate Discount 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" }, "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" }, "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" }, "pointsRequired": { "description": "Points required to avail/redeem this award.", "type": "number" }, "awardValue": { "description": "The actual value of the award, in the amount of currency.", "type": "number" }, "maxPercentAllowed": { "description": "Max percent of total value to be allowed to convert money to points.", "type": "number" } } }, "tierManagementBatchProcessesType": { "type": "array", "description": "Tier Management Batch Process details.", "maxItems": 4000, "items": { "$ref": "#/definitions/tierManagementBatchProcessType" } }, "tierManagementBatchProcessType": { "type": "object", "description": "Base details of Tier Management Batch Process.", "properties": { "reportId": { "description": "Unique ID of the report generated by the batch process.", "$ref": "#/definitions/uniqueID_Type" }, "recordType": { "description": "Record created for process type Upgrade(UP)/Downgrade(DN)/Renewal(RE).", "$ref": "#/definitions/membershipLevelRuleTypeType" }, "evaluationDate": { "description": "Date for which routine was run.", "type": "string", "format": "date", "maxLength": 8 }, "processDate": { "description": "Date when routine was run.", "type": "string", "format": "date", "maxLength": 8 }, "membershipType": { "description": "Membership type", "type": "string", "minLength": 0, "maxLength": 20 }, "insertUser": { "description": "User who requested the batch process.", "type": "integer" }, "insertUserName": { "description": "UserName who requested the batch process.", "type": "string" }, "tMRApplied": { "description": "Indicates if TMR (Tier Management Reset) setup was applied while running the batch process.", "type": "boolean" }, "pendingCount": { "description": "Count of records with status NEW.", "type": "integer" }, "completedCount": { "description": "Count of records with status COMPLETE.", "type": "integer" }, "deletedCount": { "description": "Count of records with status DELETE.", "type": "integer" }, "errorCount": { "description": "Count of records with status ERROR.", "type": "integer" }, "lockedCount": { "description": "Count of records with status LOCKED.", "type": "integer" } } }, "membershipLevelRuleTypeType": { "type": "string", "description": "Fetches the data for all the membership level rules.", "enum": [ "Downgrade", "Renewal", "Upgrade", "All" ] }, "tierManagementBatchRecordsType": { "type": "array", "description": "Tier Management Batch Record details.", "maxItems": 4000, "items": { "$ref": "#/definitions/tierManagementBatchRecordType" } }, "tierManagementBatchRecordType": { "type": "object", "description": "Base details of records processed by Tier Management Batch process.", "properties": { "name": { "description": "Display name of the member.", "type": "string", "minLength": 0, "maxLength": 200 }, "recordStatus": { "description": "Status of the record. like (NEW, ERROR).", "$ref": "#/definitions/tierManagementBatchRecordStatusType" }, "level": { "description": "Old membership level before upgrade or downgrade.", "type": "string", "minLength": 0, "maxLength": 100 }, "levelDifference": { "description": "Level Difference.", "type": "integer" }, "membershipCardNumber": { "description": "Member Card no.", "type": "string", "minLength": 0, "maxLength": 100 }, "id": { "description": "Key to uniquely identify a Tier Management batch record.", "$ref": "#/definitions/tierManagementBatchRecordIDType" }, "newLevel": { "description": "The level to which the membership will be upgraded or downgraded.", "type": "string", "minLength": 0, "maxLength": 100 }, "gracePeriodStatus": { "description": "Current grace period status.", "$ref": "#/definitions/membershipGracePeriodStatusType" }, "newGracePeriodStatus": { "description": "The status of the membership after the upgrade or downgrade.", "$ref": "#/definitions/membershipGracePeriodStatusType" }, "evaluationPeriod": { "description": "Period for which member transactions were evaluated.", "$ref": "#/definitions/dateRangeType" }, "joinedDate": { "description": "Date when the member joined the membership program.", "type": "string", "format": "date", "maxLength": 8 }, "expirationDate": { "description": "Membership card expiration date before and after upgrade,downgrade or renewal.", "$ref": "#/definitions/dateRangeType" }, "customRule": { "description": "Custom Rule that needs to be applied from tier rules.", "type": "string", "minLength": 0, "maxLength": 4000 }, "yearlyTransactions": { "description": "Collection of Yearly membership transactions.", "$ref": "#/definitions/membershipYearlyTransactionsSummaryType" }, "log": { "description": "Log of how and what was evaluated for the member.", "type": "string", "minLength": 0, "maxLength": 2000 }, "error": { "description": "Errors if any while processing for a member.", "type": "string", "minLength": 0, "maxLength": 2000 }, "profileId": { "description": "OPERA Profile ID that associated with the record.", "$ref": "#/definitions/profileId" } } }, "membershipGracePeriodStatusType": { "type": "string", "description": "Member is a candidate for downgrade as per level rules.", "enum": [ "Period", "NotEver", "Grace", "Blank" ] }, "tierManagementBatchRecordStatusType": { "type": "string", "description": "Record locked.", "enum": [ "New", "Complete", "Delete", "Error", "Locked" ] }, "membershipYearlyTransactionsSummaryType": { "type": "array", "description": "Yearly membership transaction summary.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipYearlyTransactionSummaryType" } }, "membershipYearlyTransactionSummaryType": { "type": "object", "description": "Yearly membership transaction summary.", "properties": { "membershipId": { "description": "Membership ID.", "$ref": "#/definitions/uniqueID_Type" }, "year": { "description": "Year of the transactions.", "type": "string", "minLength": 4, "maxLength": 4 }, "nights": { "description": "Number of nights the member has stayed.", "type": "number" }, "revenue": { "description": "Amount of revenue generated by the member.", "type": "number" }, "stays": { "description": "Number of individual stays.", "type": "number" }, "transactions": { "description": "Number of award points transactions.", "type": "number" } } }, "tierManagementBatchRecordIDType": { "type": "object", "description": "Key to uniquely identify a batch record.", "properties": { "reportId": { "description": "Unique ID of the report generated by the batch process.", "$ref": "#/definitions/uniqueID_Type" }, "membershipId": { "description": "Membership ID.", "$ref": "#/definitions/uniqueID_Type" } } }, "tierManagementBatchProcesses": { "type": "object", "description": "Response object for fetching Tier Management Batch Reports.", "properties": { "tierManagementBatchProcesses": { "description": "Tier Management Batch Reports Type.", "$ref": "#/definitions/tierManagementBatchProcessesType" }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, "offset": { "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, "limit": { "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "tierManagementBatchRecords": { "type": "object", "description": "Response object for fetching Tier Management Batch Records.", "properties": { "tierManagementBatchRecords": { "description": "Tier Management Batch Records Type.", "$ref": "#/definitions/tierManagementBatchRecordsType" }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, "offset": { "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", "type": "integer" }, "limit": { "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "tierManagementProcessType": { "type": "object", "description": "Details required to start Tier Management process.", "properties": { "membershipType": { "description": "Membership type", "type": "string", "minLength": 0, "maxLength": 20 }, "evaluationDate": { "description": "Date for which routine is run.", "type": "string", "format": "date", "maxLength": 8 }, "upgrade": { "description": "True indicates to run the batch process for membership upgrade.", "type": "boolean" }, "downgrade": { "description": "True indicates to run the batch process for membership downgrade.", "type": "boolean" }, "renewal": { "description": "True indicates to run the batch process for membership renewal.", "type": "boolean" }, "applyChangesImmediately": { "description": "True indicates to run the batch process and apply changes immediately without reviewing the proposed changes to memberships.", "type": "boolean" } } }, "tierManagement": { "type": "object", "description": "Request object for processing membership tier level changes.", "properties": { "tierManagementProcess": { "description": "Details required to start Tier Management process.", "$ref": "#/definitions/tierManagementProcessType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "tierManagementChanges": { "type": "object", "description": "Request object for applying membership changes calculated by Tier Management process.", "properties": { "reportId": { "description": "Unique ID of the report generated by the batch process.", "$ref": "#/definitions/uniqueID_Type" }, "overrideWarning": { "description": "If true, overrides the warning \"Previous batch(es) ran but update not completed.\" and proceeds update.", "type": "boolean" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "claimAdjustmentLimitsType": { "type": "array", "description": "Collection of Claim Adjustment Limits", "maxItems": 4000, "items": { "$ref": "#/definitions/claimAdjustmentLimitType" } }, "claimAdjustmentLimitType": { "type": "object", "description": "Details of Claim Adjustment Limit.", "properties": { "limitCode": { "description": "A Type that holds key value, that uniquely identifies a Claim Adjustment Limit.", "type": "string", "minLength": 0, "maxLength": 20 }, "billingGroup": { "description": "The billing group that represents a billing rule schedule for the Claim Adjustment Limit.", "type": "string", "minLength": 0, "maxLength": 20 }, "limits": { "description": "Threshold limits.", "$ref": "#/definitions/claimAdjustmentLimitsRangeType" }, "hotels": { "description": "Collection of property codes which associated for a Claim Adjustment Limit code.", "$ref": "#/definitions/codeListType" }, "managedBy" : { "$ref": "#/definitions/managedByOptions" } } }, "claimAdjustmentLimitsRangeType": { "type": "object", "description": "List of Claim Adjustment Limits.", "properties": { "awardPoints": { "description": "Threshold limit for the award.", "$ref": "#/definitions/pointsThreshold" }, "stayPoints": { "description": "Threshold limit for the Tier Stay Points.", "$ref": "#/definitions/pointsThreshold" }, "nightPoints": { "description": "Threshold limit for the Tier Nights Points.", "$ref": "#/definitions/pointsThreshold" }, "revenuePoints": { "description": "Threshold limit for the Tier Revenue Points.", "$ref": "#/definitions/pointsThreshold" } } }, "pointsThreshold": { "type": "object", "description": "Points Threshold Information.", "properties": { "lowerLimit": { "description": "Lower limit.", "type": "integer" }, "higherLimit": { "description": "Higher limit.", "type": "integer" } } }, "membershipRevenueTypesType": { "type": "array", "description": "Details of membership revenue type.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipRevenueTypeType" } }, "membershipRevenueTypeType": { "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", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Membership Market/Property Groups display sequence Number", "type": "number" }, "label": { "description": "Label of the membership revenue type.", "type": "string", "minLength": 0, "maxLength": 20 }, "exportBucketCode": { "description": "Revenue bucket code that is associated to the membership revenue type.", "type": "string", "minLength": 0, "maxLength": 20 }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "membershipRoomGroupsType": { "type": "array", "description": "Membership room group information.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipRoomGroupType" } }, "membershipRoomGroupType": { "type": "object", "description": "Membership room group details.", "properties": { "roomGroup": { "description": "Room group code.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the room group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "roomTypes": { "description": "Room types selected for the group.", "$ref": "#/definitions/codeListType" }, "sequence": { "description": "Sequence of the room group.", "type": "integer" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "claimAdjustmentLimitsInfo": { "type": "object", "description": "Response object for fetching Claim Adjustment Limits.", "properties": { "claimAdjustmentLimits": { "description": "Collection of Claim Adjustment Limits.", "$ref": "#/definitions/claimAdjustmentLimitsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "claimAdjustmentLimits": { "type": "object", "description": "Request object for modifying Claim Adjustment Limits.", "properties": { "claimAdjustmentLimits": { "description": "Collection of Claim Adjustment Limits to be changed.", "$ref": "#/definitions/claimAdjustmentLimitsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipRevenueTypesInfo": { "type": "object", "description": "Response object for fetching membership revenue types.", "properties": { "membershipRevenueTypes": { "description": "Collection of membership revenue types.", "$ref": "#/definitions/membershipRevenueTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipRevenueTypes": { "type": "object", "description": "Request object for changing new membership revenue types.", "properties": { "membershipRevenueTypes": { "description": "Collection of membership revenue types.", "$ref": "#/definitions/membershipRevenueTypesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipRoomGroupsInfo": { "type": "object", "description": "Response object for fetching membership room groups.", "properties": { "membershipRoomGroups": { "description": "Collection of membership room groups summary.", "$ref": "#/definitions/membershipRoomGroupsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipRoomGroups": { "type": "object", "description": "Request object for changing membership room groups.", "properties": { "membershipRoomGroups": { "description": "Collection of membership room groups to be changed.", "$ref": "#/definitions/membershipRoomGroupsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "statesToBeChanged": { "type": "object", "description": "Request object for updating states.", "properties": { "states": { "description": "Collection of states to be modified.", "$ref": "#/definitions/statesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "suspendedMatchRulesInfo": { "type": "object", "description": "Object for Suspended Profile Match Rules Configuration.", "properties": { "suspendedMatchRules": { "description": "Collection of Suspended Match Rules.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/suspendedMatchRuleType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "suspendedMatchRuleType": { "type": "object", "description": "Provides information about the Suspended Profile Match Rule Configuration.", "properties": { "region": { "description": "Region to filter by based on the profile region setup", "type": "string" }, "nameType": { "description": "Name type to filter match rules", "type": "string" }, "validationItem": { "description": "Validation item for the rule", "type": "string" }, "validationType": { "description": "Validation type for the rule", "type": "string" }, "validationValue": { "description": "Validation value for the rule", "type": "string" }, "applyRuleYn": { "description": "The activation flag for the match rule", "type": "boolean" }, "userMaintainable": { "description": "Whether the rule is maintainable by users", "type": "boolean" } } }, "copySuspendedMatchRuleType": { "type": "object", "description": "Copy object for Suspended Profile Match Rules Configuration.", "properties": { "region": { "description": "New Region to copy the match rules", "type": "string" }, "nameType": { "description": "Region of the match rule to copy from", "type": "string" }, "copyToRegion": { "description": "Name type of the match rule to copy from", "type": "string" }, "copyToNameType": { "description": "Validation item of the match rule to copy from", "type": "string" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "updateSuspendedMatchRuleType": { "type": "object", "description": "Provides information for updating the Suspended Profile Match Rule Configuration.", "properties": { "region": { "description": "Region to filter by based on the profile region setup", "type": "string" }, "nameType": { "description": "Name type to filter match rules", "type": "string" }, "validationItem": { "description": "Validation item for the existing rule", "type": "string" }, "newValidationItem": { "description": "Validation item for the existing rule", "type": "string" }, "validationType": { "description": "Validation type for the rule", "type": "string" }, "validationValue": { "description": "Validation value for the rule", "type": "string" }, "applyRuleYn": { "description": "The activation flag for the match rule", "type": "boolean" }, "userMaintainable": { "description": "Whether the rule is maintainable by users", "type": "boolean" } } }, "membershipLevelRulesType": { "type": "array", "description": "Membership Level Rule details.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipLevelRuleType" } }, "membershipLevelRuleType": { "type": "object", "description": "Membership Level Rule ID type.", "properties": { "membershipType": { "description": "Membership Type.", "type": "string", "minLength": 0, "maxLength": 20 }, "membershipLevel": { "description": "Membership Level.", "type": "string", "minLength": 0, "maxLength": 20 }, "ruleNo": { "description": "Membership Level Rule Number.", "type": "number" }, "ruleType": { "description": "Specifies whether Downgrade/Upgrade type rule.", "$ref": "#/definitions/membershipLevelRuleTypeType" }, "recordType": { "description": "RESIDENT/RFM.", "$ref": "#/definitions/membershipLevelRuleRecordType" }, "ruleBasedOn": { "description": "Factor on which the upgrade or downgrade rule is based ( Revenue, Stays, Nights ).", "$ref": "#/definitions/membershipTypeRuleBasedOnType" }, "requiredUnits": { "description": "Minimum number of tier points required for an upgrade or tier points below which downgrade will be effected.", "type": "number" }, "overrideUnits": { "description": "An \"interim\" tier point value used to override the Required Points value for an upgrade/downgrade batch run. This value remains in-effect until it is manually changed or deleted.", "type": "number" }, "brandCount": { "description": "Specifies the minimum number of brands (for membership stay) required for the level upgrade or downgrade rule.", "type": "integer" } } }, "membershipLevelRuleRecordType": { "type": "string", "description": "Used when Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score.", "enum": [ "Resident", "All" ] }, "membershipLevelRulesInfo": { "type": "object", "description": "Response object for fetching Membership Level Rules.", "properties": { "membershipLevelRules": { "description": "Collection of Membership Level Rules.", "$ref": "#/definitions/membershipLevelRulesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipLevelRules": { "type": "object", "description": "Request object for modifying Membership Level Rules.", "properties": { "membershipLevelRules": { "description": "Collection of Membership Level Rules to be changed.", "$ref": "#/definitions/membershipLevelRulesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileRegionInfo": { "type": "object", "description": "Object for Profile Region Configuration.", "properties": { "profileRegion": { "description": "Profile Region Info for a singular Region.", "$ref": "#/definitions/profileRegionType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "profileRegionType": { "type": "object", "description": "Provides information about the Profile Regions Configuration.", "properties": { "region": { "description": "Region to filter by based on the profile region setup", "type": "string" }, "type": { "description": "Type to filter profile regions", "type": "string" }, "description": { "description": "Description for the profile region", "type": "string" }, "hotelIds": { "description": "Resorts to be created for the corresponding Profile Region.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } } } }, "profileRegionsInfo": { "type": "object", "description": "Object for Profile Regions Configuration.", "properties": { "profileRegions": { "description": "Collection of Profile Regions.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/profileRegionType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "qualifyingRatesType": { "type": "array", "description": "Qualifying Rate information.", "maxItems": 4000, "items": { "$ref": "#/definitions/qualifyingRateType" } }, "qualifyingRateType": { "type": "object", "description": "Qualifying Rate information. Only Qualifying field is considered while updating record.", "properties": { "hotelId": { "description": "Qualifying Rate hotel code.", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanCode": { "description": "Qualifying rate code.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Qualifying rate.", "type": "string", "minLength": 0, "maxLength": 2000 }, "marketCode": { "description": "Qualifying rate market code.", "type": "string", "minLength": 0, "maxLength": 20 }, "qualifying": { "description": "Indicates whether the Rate code is Qualifying or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "qualifyingRates": { "type": "object", "description": "Request object for changing qualifying rate rules.", "properties": { "qualifyingRates": { "description": "Collection of qualifying rates to be changed.", "$ref": "#/definitions/qualifyingRatesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "membershipRevenueGroupsType": { "type": "array", "description": "Details of membership revenue group type.", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipRevenueGroupType" } }, "membershipRevenueGroupType": { "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", "minLength": 0, "maxLength": 20 }, "description": { "description": "Description of the Membership Market/Propety Group.", "type": "string", "minLength": 0, "maxLength": 2000 }, "displaySequence": { "description": "Membership Market/Property Groups display sequence Number", "type": "number" }, "revenueTypes": { "description": "Collection of code and description of revenue types that are associated to the membership revenue group.", "$ref": "#/definitions/membershipRevenueTypesInfoType" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "membershipRevenueTypesInfoType": { "type": "array", "description": "Membership revenue type code and description.", "maxItems": 4000, "items": { "$ref": "#/definitions/codeDescriptionType" } }, "membershipRevenueGroups": { "type": "object", "description": "Request object for changing new membership revenue groups.", "properties": { "membershipRevenueGroups": { "description": "Collection of membership revenue groups.", "$ref": "#/definitions/membershipRevenueGroupsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "correspondencesDetails": { "type": "object", "description": "Response object containing a collection of correspondences and related metadata.", "properties": { "correspondences": { "description": "Collection of correspondences.", "$ref": "#/definitions/correspondencesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "correspondencesType": { "type": "object", "description": "A collection of correspondences.", "properties": { "correspondenceType": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/correspondenceType" } } } }, "correspondencesCriteriaType": { "type": "object", "description": "Request object for creating a new correspondence.", "properties": { "correspondenceDetails": { "description": "Correspondence details to be created.", "$ref": "#/definitions/correspondenceType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "correspondencesToBeChanged": { "type": "object", "description": "Request object for changing an existing correspondence.", "properties": { "correspondenceDetails": { "description": "Correspondence to be changed.", "$ref": "#/definitions/correspondenceType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "correspondenceType": { "type": "object", "description": "This represents the Correspondence attributes.", "properties": { "code": { "description": "Common Master unique code.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "Description of the Master code.", "$ref": "#/definitions/translationTextType2000" }, "activeYn": { "description": "Indicates if the Correspondence is inactive or not.", "type": "boolean" }, "defaultYn": { "description": "Indicates if the Correspondence is default or not.", "type": "boolean" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" } } }, "searchAccountOwnersRequest": { "type": "object", "required": [ "chainCode" ], "properties": { "chainCode": { "type": "string", "description": "Chain level code to which owners have access. This is a mandatory element." }, "findExactOwnerCodeMatch": { "type": "boolean", "description": "Indicates if there is an exact match for the given owner code or not." }, "maxFetchRecords": { "type": "integer", "description": "Maximum number of records to be fetched." }, "hotelId": { "type": "string", "description": "Hotel code to which owners have access." }, "ownerCode": { "type": "string", "description": "Wildcard search on owner codes." }, "name": { "type": "string", "description": "Family name, last name or Company Name." }, "givenName": { "type": "string", "description": "Given name, first name or names." } } }, "recordStatusEnum": { "type": "string", "enum": [ "New", "Complete", "Delete", "Error", "Locked" ] }, "searchTierManagementBatchRecordsRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the member." }, "recordStatus": { "$ref": "#/definitions/recordStatusEnum", "description": "Record locked." }, "level": { "type": "string", "description": "Old membership level before upgrade or downgrade." }, "levelDifference": { "type": "integer", "description": "Level Difference." }, "membershipCardNumber": { "type": "string", "description": "Member Card no." }, "reportId": { "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." }, "reportIdType": { "type": "string", "description": "A reference to the type of object defined by the UniqueID element." }, "limit": { "type": "integer", "description": "Indicates maximum number of records a Web Service should return.", "default": 20 }, "offset": { "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.", "default": 1 } } } }, "tags": [ { "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." }, { "name": "ChainConfig", "description": "These APIs will allow you to configure profile related configuration related to Administration." }, { "name": "HotelConfig", "description": "These APIs will allow you to configure profile related configuration related to Administration." } ], "externalDocs": { "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } }